mds::mod::CIStreamChannel Class Reference

Buffered channel providing STL-like stream functionality. More...

#include <mdsStreamChannel.h>

Inheritance diagram for mds::mod::CIStreamChannel:

List of all members.

Public Types
enum	{ SIZE = 512 }
	Size of the internal buffer. More...
enum	{ CLASS_OBJECT }
	Templates that require members of the CObject class can use this enum to check the existence. More...
enum	{ HEAP_OBJECT = 0x70616568 }
	Signature used to recognize objects on the heap. More...
Public Member Functions
	CIStreamChannel (CChannel *pChannel)
	Default constructor.
CChannel *	getChannel ()
	Returns pointer to the input channel.
int	getReferencesCount () const
	Returns the number of references.
std::istream &	getStream ()
	Returns the output stream.
bool	isOnHeap () const
	Returns true if the object is allocated on the heap.
	MDS_SHAREDPTR (CIStreamChannel)
	Smart pointer type.
virtual int	overflow (int c=EOF)
	Implementation of virtual functions (std::streambuf).
void	setChannel (CChannel *pChannel)
	Sets the input channel.
virtual int	sync ()
virtual int	underflow ()
virtual	~CIStreamChannel ()
	Virtual destructor.
Static Public Member Functions
static void *	operator new (std::size_t Size)
	Allocates a new object on the heap.
Protected Member Functions
void	addReference () const
	Increase the reference counter.
bool	delReference () const
	Decrease the reference counter.
Protected Attributes
int	m_iHeapObject
	Flag initialized if the object is on the heap.
int	m_iReferences
	The number of references to the object.
char	m_pcBuffer [SIZE+1]
	Internal buffer.
char *	m_pcBufferEnd
	Pointer to the buffer end.
mds::base::CScopedPtr < std::istream >	m_pStream
	Input stream.
CChannelPtr	m_spChannel
	Input channel.

---

Detailed Description

Buffered channel providing STL-like stream functionality.

---

Member Enumeration Documentation

anonymous enum

Size of the internal buffer.

Enumerator:

SIZE

anonymous enum [inherited]

Templates that require members of the CObject class can use this enum to check the existence.

Enumerator:

CLASS_OBJECT

anonymous enum [inherited]

Signature used to recognize objects on the heap.

Enumerator:

HEAP_OBJECT

---

Constructor & Destructor Documentation

mds::mod::CIStreamChannel::CIStreamChannel

(

CChannel *

pChannel

)

Default constructor.

• Pointer to an input channel.

mds::mod::CIStreamChannel::~CIStreamChannel

(

)

[virtual]

Virtual destructor.

---

Member Function Documentation

void mds::base::CObject::addReference

(

)

const [protected, inherited]

Increase the reference counter.

bool mds::base::CObject::delReference

(

)

const [protected, inherited]

Decrease the reference counter.

• Returns true if the decremented number of references is lower or equal to zero and object must be deleted.

CChannel* mds::mod::CIStreamChannel::getChannel

(

)

Returns pointer to the input channel.

int mds::base::CObject::getReferencesCount

(

)

const [inherited]

Returns the number of references.

std::istream& mds::mod::CIStreamChannel::getStream

(

)

Returns the output stream.

bool mds::base::CObject::isOnHeap

(

)

const [inherited]

Returns true if the object is allocated on the heap.

mds::mod::CIStreamChannel::MDS_SHAREDPTR

(

CIStreamChannel

)

Smart pointer type.

static void* mds::base::CObject::operator new

(

std::size_t

Size

)

[static, inherited]

Allocates a new object on the heap.

int mds::mod::CIStreamChannel::overflow

(

int

c = EOF

)

[virtual]

Implementation of virtual functions (std::streambuf).

void mds::mod::CIStreamChannel::setChannel

(

CChannel *

pChannel

)

Sets the input channel.

int mds::mod::CIStreamChannel::sync

(

)

[virtual]

int mds::mod::CIStreamChannel::underflow

(

)

[virtual]

---

Member Data Documentation

int mds::base::CObject::m_iHeapObject [mutable, protected, inherited]

Flag initialized if the object is on the heap.

int mds::base::CObject::m_iReferences [mutable, protected, inherited]

The number of references to the object.

• Zero if there is no reference.

char mds::mod::CIStreamChannel::m_pcBuffer[SIZE+1] [protected]

Internal buffer.

char* mds::mod::CIStreamChannel::m_pcBufferEnd [protected]

Pointer to the buffer end.

mds::base::CScopedPtr<std::istream> mds::mod::CIStreamChannel::m_pStream [protected]

Input stream.

CChannelPtr mds::mod::CIStreamChannel::m_spChannel [protected]

Input channel.

---

The documentation for this class was generated from the following files:

• mdsStreamChannel.h
• mdsStreamChannel.cpp