blocxx
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
BLOCXX_NAMESPACE::BaseStreamBuffer Class Reference

#include <BaseStreamBuffer.hpp>

Inheritance diagram for BLOCXX_NAMESPACE::BaseStreamBuffer:
BLOCXX_NAMESPACE::FileBuf BLOCXX_NAMESPACE::IOIFCStreamBuffer BLOCXX_NAMESPACE::OStringStreamBuf BLOCXX_NAMESPACE::IFileStream BLOCXX_NAMESPACE::SocketStreamBuffer

Public Types

enum  EDirectionFlag { E_IN, E_OUT, E_IN_OUT }
 

Public Member Functions

 BaseStreamBuffer (EDirectionFlag direction, size_t bufSize=BASE_BUF_SIZE)
 Create a base stream buffer. More...
 
 ~BaseStreamBuffer ()
 

Protected Member Functions

int underflow ()
 
std::streamsize xsputn (const char *s, std::streamsize n)
 
virtual int overflow (int c)
 
virtual int sync ()
 
virtual void initBuffers ()
 
virtual void initGetBuffer ()
 
virtual void initPutBuffer ()
 
virtual int buffer_to_device (const char *c, int n)
 Writes the buffer to the "device". More...
 
virtual int buffer_from_device (char *c, int n)
 Fill the buffer from the "device". More...
 

Private Member Functions

int buffer_in ()
 
int buffer_out ()
 
 BaseStreamBuffer (const BaseStreamBuffer &arg)
 
BaseStreamBuffer & operator= (const BaseStreamBuffer &arg)
 

Private Attributes

std::streamsize m_bufSize
 
char * m_inputBuffer
 
char * m_outputBuffer
 

Detailed Description

Definition at line 87 of file BaseStreamBuffer.hpp.

Member Enumeration Documentation

◆ EDirectionFlag

enum BLOCXX_NAMESPACE::BaseStreamBuffer::EDirectionFlag
Enumerator
E_IN 
E_OUT 
E_IN_OUT 

Definition at line 90 of file BaseStreamBuffer.hpp.

Constructor & Destructor Documentation

◆ BaseStreamBuffer() [1/2]

BLOCXX_NAMESPACE::BaseStreamBuffer::BaseStreamBuffer ( EDirectionFlag  direction,
size_t  bufSize = BASE_BUF_SIZE 
)

Create a base stream buffer.

Parameters
directionE_IN, E_OUT, E_IN_OUT
bufSizesize of buffer

Definition at line 81 of file BaseStreamBuffer.cpp.

References m_inputBuffer.

◆ ~BaseStreamBuffer()

BLOCXX_NAMESPACE::BaseStreamBuffer::~BaseStreamBuffer ( )

Definition at line 115 of file BaseStreamBuffer.cpp.

◆ BaseStreamBuffer() [2/2]

BLOCXX_NAMESPACE::BaseStreamBuffer::BaseStreamBuffer ( const BaseStreamBuffer &  arg)
private

Member Function Documentation

◆ buffer_from_device()

int BLOCXX_NAMESPACE::BaseStreamBuffer::buffer_from_device ( char *  c,
int  n 
)
protectedvirtual

Fill the buffer from the "device".

Parameters
cA pointer to the beginning of the buffer
nThe number of bytes to be read into the buffer.
Returns
-1 if no bytes are able to be read from the "device" (for instance, end of input stream). Otherwise, return the number of bytes read into the buffer.
Exceptions
IOExceptionon failure.

Reimplemented in BLOCXX_NAMESPACE::FileBuf, and BLOCXX_NAMESPACE::IOIFCStreamBuffer.

Definition at line 220 of file BaseStreamBuffer.cpp.

◆ buffer_in()

int BLOCXX_NAMESPACE::BaseStreamBuffer::buffer_in ( )
private

Definition at line 196 of file BaseStreamBuffer.cpp.

◆ buffer_out()

int BLOCXX_NAMESPACE::BaseStreamBuffer::buffer_out ( )
private

Definition at line 128 of file BaseStreamBuffer.cpp.

◆ buffer_to_device()

int BLOCXX_NAMESPACE::BaseStreamBuffer::buffer_to_device ( const char *  c,
int  n 
)
protectedvirtual

Writes the buffer to the "device".

Parameters
cA pointer to the start of the buffer
nthe number of bytes to write
Returns
-1 if error, 0 if the entire buffer was written.

Reimplemented in BLOCXX_NAMESPACE::FileBuf, BLOCXX_NAMESPACE::OStringStreamBuf, and BLOCXX_NAMESPACE::IOIFCStreamBuffer.

Definition at line 213 of file BaseStreamBuffer.cpp.

Referenced by initBuffers().

◆ initBuffers()

void BLOCXX_NAMESPACE::BaseStreamBuffer::initBuffers ( )
protectedvirtual

Definition at line 97 of file BaseStreamBuffer.cpp.

References buffer_to_device(), and m_outputBuffer.

◆ initGetBuffer()

void BLOCXX_NAMESPACE::BaseStreamBuffer::initGetBuffer ( )
protectedvirtual

Definition at line 110 of file BaseStreamBuffer.cpp.

◆ initPutBuffer()

void BLOCXX_NAMESPACE::BaseStreamBuffer::initPutBuffer ( )
protectedvirtual

Definition at line 104 of file BaseStreamBuffer.cpp.

◆ operator=()

BaseStreamBuffer& BLOCXX_NAMESPACE::BaseStreamBuffer::operator= ( const BaseStreamBuffer &  arg)
private

◆ overflow()

int BLOCXX_NAMESPACE::BaseStreamBuffer::overflow ( int  c)
protectedvirtual

Definition at line 137 of file BaseStreamBuffer.cpp.

References i.

◆ sync()

int BLOCXX_NAMESPACE::BaseStreamBuffer::sync ( )
protectedvirtual

Definition at line 122 of file BaseStreamBuffer.cpp.

Referenced by BLOCXX_NAMESPACE::OStringStream::operator=(), and BLOCXX_NAMESPACE::OStringStream::OStringStream().

◆ underflow()

int BLOCXX_NAMESPACE::BaseStreamBuffer::underflow ( )
protected

Definition at line 179 of file BaseStreamBuffer.cpp.

◆ xsputn()

std::streamsize BLOCXX_NAMESPACE::BaseStreamBuffer::xsputn ( const char *  s,
std::streamsize  n 
)
protected

Definition at line 157 of file BaseStreamBuffer.cpp.

Member Data Documentation

◆ m_bufSize

std::streamsize BLOCXX_NAMESPACE::BaseStreamBuffer::m_bufSize
private

Definition at line 137 of file BaseStreamBuffer.hpp.

◆ m_inputBuffer

char* BLOCXX_NAMESPACE::BaseStreamBuffer::m_inputBuffer
private

Definition at line 138 of file BaseStreamBuffer.hpp.

Referenced by BaseStreamBuffer().

◆ m_outputBuffer

char* BLOCXX_NAMESPACE::BaseStreamBuffer::m_outputBuffer
private

Definition at line 139 of file BaseStreamBuffer.hpp.

Referenced by initBuffers().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.18