Logo Search packages:      
Sourcecode: pwlib version File versions  Download package

BlockFIFO.h

//
// (c) Yuri Kiryanov, openh323@kiryanov.com
// for www.Openh323.org by Equivalence
//
// Portions: 1998-1999, Be Incorporated
// Be Sample Code License

/*----------------------
Be Sample Code License
----------------------

Copyright 1991-1999, Be Incorporated.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions, and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions, and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

3. The name of the author may not be used to endorse or promote products
   derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.    
*/

#if !defined(_BLOCK_FIFO_H)
#define _BLOCK_FIFO_H

#include <OS.h>

namespace BPrivate {

class BBlockFIFO {
public:
                              BBlockFIFO(
                                          size_t blockSize,             //    BeginGet will never ask for bigger chunks than this
                                          int32 blockCountPerBuffer,    //    BeginPut will never ask for bigger chunks than blockSize*blockCount
                                          int32 bufferCount,                  //    double- or triple-buffering?
                                          uint32 placementFlags = B_ANY_ADDRESS,
                                          uint32 lockFlags = 0,
                                          const char * name = 0);
                              ~BBlockFIFO();

            status_t    Reset();                //    for re-use
            status_t    InitCheck();

            int32       SizeAvailableToGet();
            int32       SizeAvailableToPut();

            int32       BeginGet(         //    returns actual size
                                          const void ** outData,
                                          size_t requestSize,
                                          bigtime_t timeout);
            int32       EndGet();

            int32       BeginPut(   //    returns actual size
                                          void ** inData,
                                          size_t requestSize,
                                          bigtime_t timeout);
            int32       EndPut(
                                          bool atEndOfData = false);

            //    these are wrappers for the above functions
            int32       CopyNextBlockOut( //    returns actual size
                                          void * destination,
                                          size_t requestSize,
                                          bigtime_t timeout);
            int32       CopyNextBufferIn( //    returns actual size
                                          const void * source,
                                          size_t requestSize,
                                          bigtime_t timeout,
                                          bool atEndOfData = false);

private:

            char *            _mBuffer;
            area_id           _mArea;
      enum {
            flagEndOfData = 1,
            flagPendingGet = 2,
            flagPendingPut = 4
      };
            int32       _mFlags;
            size_t            _mBlockSize;
            size_t            _mBufferSize;
            size_t            _mAreaSize;             //    minus padding
            status_t    _mInitErr;
            sem_id            _mGetSem;
            sem_id            _mPutSem;
            size_t            _mGetOff;
            int32       _mPendingGet;
            size_t            _mPutOff;
            int32       _mPendingPut;
            char        _mName[32];
};

};
using namespace BPrivate;

#endif      //    _BLOCK_FIFO_H


Generated by  Doxygen 1.6.0   Back to index