class Poco::FIFOBufferStreamBuf

Overview

This is the streambuf class used for reading from and writing to a FIFOBuffer. More…

#include <FIFOBufferStream.h>

class FIFOBufferStreamBuf: public Poco::BasicBufferedBidirectionalStreamBuf
{
public:
    // construction

    FIFOBufferStreamBuf();
    FIFOBufferStreamBuf(FIFOBuffer& fifoBuffer);

    FIFOBufferStreamBuf(
        char* pBuffer,
        std::size_t length
        );

    FIFOBufferStreamBuf(
        const char* pBuffer,
        std::size_t length
        );

    FIFOBufferStreamBuf(std::size_t length);

    // methods

    FIFOBuffer&
    fifoBuffer();

protected:
    // methods

    int
    readFromDevice(
        char* buffer,
        std::streamsize length
        );

    int
    writeToDevice(
        const char* buffer,
        std::streamsize length
        );
};

Inherited Members

public:
    // methods

    virtual
    int_type
    overflow(int_type c);

    virtual
    int_type
    underflow();

    virtual
    int
    sync();

protected:
    // typedefs

    typedef std::basic_streambuf<ch, tr> Base;
    typedef std::basic_ios<ch, tr> IOS;
    typedef ch char_type;
    typedef tr char_traits;
    typedef ba Allocator;
    typedef Base::int_type int_type;
    typedef Base::pos_type pos_type;
    typedef Base::off_type off_type;
    typedef IOS::openmode openmode;

    // methods

    void
    setMode(openmode mode);

    openmode
    getMode() const;

    void
    resetBuffers();

Detailed Documentation

This is the streambuf class used for reading from and writing to a FIFOBuffer.

FIFOBuffer is enabled for emtpy/non-empty/full state transitions notifications.

Construction

FIFOBufferStreamBuf()

Creates a FIFOBufferStreamBuf.

FIFOBufferStreamBuf(FIFOBuffer& fifoBuffer)

Creates a FIFOBufferStreamBuf and assigns the given buffer to it.

FIFOBufferStreamBuf(
    char* pBuffer,
    std::size_t length
    )

Creates a FIFOBufferStreamBuf and assigns the given buffer to it.

FIFOBufferStreamBuf(
    const char* pBuffer,
    std::size_t length
    )

Creates a FIFOBufferStreamBuf and assigns the given buffer to it.

FIFOBufferStreamBuf(std::size_t length)

Creates a FIFOBufferStreamBuf of the given length.

Methods

FIFOBuffer&
fifoBuffer()

Returns the underlying FIFO buffer reference.