qchannel.h

Go to the documentation of this file.

/*
 * qchannel.h
 *
 * Class for implementing a serial queue channel in memory.
 *
 * Portable Windows Library
 *
 * Copyright (c) 2001 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 28729 $
 * $Author: csoutheren $
 * $Date: 2013-01-02 10:20:47 +1100 (Wed, 02 Jan 2013) $
 */

#ifndef PTLIB_QCHANNEL_H
#define PTLIB_QCHANNEL_H


#ifdef P_USE_PRAGMA
#pragma interface
#endif

P_PUSH_MSVC_WARNINGS(4250)


class PQueueChannel : public PChannel
{
    PCLASSINFO(PQueueChannel, PChannel);
  public:
    PQueueChannel(
      PINDEX queueSize = 0   
    );

    ~PQueueChannel();


    virtual PBoolean Read(
      void * buf,   
      PINDEX len    
    );

    virtual PBoolean Write(
      const void * buf, 
      PINDEX len        
    );

    virtual PBoolean Close();


    virtual PBoolean Open(
      PINDEX queueSize   
    );

    PINDEX GetSize() const { return queueSize; }

    PINDEX GetLength() const { return queueLength; }

  protected:
    PMutex     mutex;
    BYTE     * queueBuffer;
    PINDEX     queueSize, queueLength, enqueuePos, dequeuePos;
    PSyncPoint unempty;
    PSyncPoint unfull;
};


#endif // PTLIB_QCHANNEL_H


// End Of File ///////////////////////////////////////////////////////////////