MDSTk Libraries
1.1.0
Medical Data Segmentation Toolkit
|
Null channel that doesn't write or read any data. More...
#include <mdsChannel.h>
Public Types | |
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... | |
typedef mds::base::CLibraryLockableObject < CChannel >::CLock | tLock |
Lock that have to be used to provide mutual access to write(), read() and etc. | |
Public Member Functions | |
bool | checkMedium (int Medium) const |
Checks if channel medium is equal to a given value. | |
bool | checkType (int Type) const |
Checks if channel type corresponds to a given value. | |
void | clearNumOfBytes () |
Clears the number of read an written bytes. | |
CNullChannel (int Type) | |
Constructor. | |
virtual bool | connect (unsigned uTimeout=CH_CONNECTION_TIMEOUT) |
Connects to the opposite channel side. | |
virtual void | disconnect () |
Disconnects from the opossite channel side. | |
virtual bool | flush () |
Finalizes all writing/reading operations (flushes internal buffers, etc.). | |
int | getMedium () const |
Returns the channel medium. | |
int | getNumOfReadBytes () |
Returns the number of bytes read from the channel. | |
int | getNumOfWrittenBytes () |
Returns the number of bytes written to the channel. | |
int | getReferencesCount () const |
Returns the number of references. | |
int | getType () const |
Method returns the channel type. | |
virtual bool | isConnected () |
Method for testing channel errors such as: disconnected or broken channel, reading after end of input, etc. | |
bool | isOnHeap () const |
Returns true if the object is allocated on the heap. | |
virtual bool | listen (unsigned uTimeout=CH_CONNECTION_TIMEOUT) |
Listens for and accepts an incoming connection. | |
void | lock () |
Locks the object. | |
MDS_SHAREDPTR (CChannel) | |
Smart pointer type. | |
MDS_SHAREDPTR (CNullChannel) | |
Smart pointer type. | |
virtual int | read (char *pcData, int iLength) |
Increases an internal counter of read bytes. | |
virtual bool | skip (int iLength) |
Skips a given number of bytes. | |
void | unlock () |
Locks the object. | |
virtual bool | wait (unsigned uTimeout=CH_WAIT_TIMEOUT) |
Waits for data. | |
virtual bool | write (const char *pcData, int iLength) |
Increases an internal counter of written bytes. | |
virtual | ~CNullChannel () |
Destructor. | |
Static Public Member Functions | |
static CChannel * | create (EChannelType eType, const std::string &sDesc) |
Creation of a channel which is described by a textual string. | |
static void * | operator new (std::size_t Size) |
Allocates a new object on the heap. | |
static void | separate (const std::string &sDescs, std::vector< std::string > &Descs) |
Parses a given string and separates descriptions of several channels. | |
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_iReadCount |
The number of read/written bytes. | |
int | m_iReferences |
The number of references to the object. | |
int | m_iWrittenCount |
int | m_Medium |
Channel medium. | |
int | m_Type |
Channel type. |
Null channel that doesn't write or read any data.
It just counts the number of written and read bytes of data.
typedef mds::base::CLibraryLockableObject<CChannel>::CLock mds::mod::CChannel::tLock [inherited] |
anonymous enum [inherited] |
Templates that require members of the CObject class can use this enum to check the existence.
Constructor.
virtual mds::mod::CNullChannel::~CNullChannel | ( | ) | [virtual] |
Destructor.
void mds::base::CObject::addReference | ( | ) | const [protected, inherited] |
Increase the reference counter.
bool mds::mod::CChannel::checkMedium | ( | int | Medium | ) | const [inherited] |
Checks if channel medium is equal to a given value.
bool mds::mod::CChannel::checkType | ( | int | Type | ) | const [inherited] |
Checks if channel type corresponds to a given value.
Clears the number of read an written bytes.
virtual bool mds::mod::CNullChannel::connect | ( | unsigned | uTimeout = CH_CONNECTION_TIMEOUT | ) | [virtual] |
Connects to the opposite channel side.
Implements mds::mod::CChannel.
CChannel * mds::mod::CChannel::create | ( | EChannelType | eType, |
const std::string & | sDesc | ||
) | [static, inherited] |
Creation of a channel which is described by a textual string.
bool mds::base::CObject::delReference | ( | ) | const [protected, inherited] |
Decrease the reference counter.
virtual void mds::mod::CNullChannel::disconnect | ( | ) | [virtual] |
Disconnects from the opossite channel side.
Implements mds::mod::CChannel.
virtual bool mds::mod::CNullChannel::flush | ( | ) | [virtual] |
Finalizes all writing/reading operations (flushes internal buffers, etc.).
Implements mds::mod::CChannel.
int mds::mod::CChannel::getMedium | ( | ) | const [inherited] |
Returns the channel medium.
Returns the number of bytes read from the channel.
Returns the number of bytes written to the channel.
int mds::base::CObject::getReferencesCount | ( | ) | const [inherited] |
Returns the number of references.
int mds::mod::CChannel::getType | ( | ) | const [inherited] |
Method returns the channel type.
virtual bool mds::mod::CNullChannel::isConnected | ( | ) | [virtual] |
Method for testing channel errors such as: disconnected or broken channel, reading after end of input, etc.
Implements mds::mod::CChannel.
bool mds::base::CObject::isOnHeap | ( | ) | const [inherited] |
Returns true if the object is allocated on the heap.
virtual bool mds::mod::CNullChannel::listen | ( | unsigned | uTimeout = CH_CONNECTION_TIMEOUT | ) | [virtual] |
Listens for and accepts an incoming connection.
Implements mds::mod::CChannel.
void mds::base::CLockableObject< CChannel >::lock | ( | ) | [inherited] |
Locks the object.
mds::mod::CChannel::MDS_SHAREDPTR | ( | CChannel | ) | [inherited] |
Smart pointer type.
Smart pointer type.
static void* mds::base::CObject::operator new | ( | std::size_t | Size | ) | [static, inherited] |
Allocates a new object on the heap.
virtual int mds::mod::CNullChannel::read | ( | char * | pcData, |
int | iLength | ||
) | [virtual] |
Increases an internal counter of read bytes.
Implements mds::mod::CChannel.
void mds::mod::CChannel::separate | ( | const std::string & | sDescs, |
std::vector< std::string > & | Descs | ||
) | [static, inherited] |
Parses a given string and separates descriptions of several channels.
bool mds::mod::CChannel::skip | ( | int | iLength | ) | [virtual, inherited] |
Skips a given number of bytes.
Reimplemented in mds::mod::CSharedMemChannel, and mds::mod::CMemoryChannel.
void mds::base::CLockableObject< CChannel >::unlock | ( | ) | [inherited] |
Locks the object.
virtual bool mds::mod::CNullChannel::wait | ( | unsigned | uTimeout = CH_WAIT_TIMEOUT | ) | [virtual] |
Waits for data.
Implements mds::mod::CChannel.
virtual bool mds::mod::CNullChannel::write | ( | const char * | pcData, |
int | iLength | ||
) | [virtual] |
Increases an internal counter of written bytes.
Implements mds::mod::CChannel.
int mds::base::CObject::m_iHeapObject [mutable, protected, inherited] |
Flag initialized if the object is on the heap.
int mds::mod::CNullChannel::m_iReadCount [protected] |
The number of read/written bytes.
int mds::base::CObject::m_iReferences [mutable, protected, inherited] |
The number of references to the object.
int mds::mod::CNullChannel::m_iWrittenCount [protected] |
int mds::mod::CChannel::m_Medium [protected, inherited] |
Channel medium.
int mds::mod::CChannel::m_Type [protected, inherited] |
Channel type.