cCommBufferBase Class Reference
#include <ccommbufferbase.h>
Detailed Description
Adds buffer (re)allocation functions to cCommBuffer.This functionality is not always needed, e.g. PVM manages its pack/unpack buffers internally.
Public Member Functions | |
| cCommBufferBase () | |
| virtual | ~cCommBufferBase () |
Buffer management | |
| char * | getBuffer () const |
| int | getBufferLength () const |
| void | allocateAtLeast (int size) |
| void | setMessageSize (int size) |
| int | getMessageSize () const |
| void | reset () |
| virtual bool | isBufferEmpty () const |
| virtual void | assertBufferEmpty () |
Constructor & Destructor Documentation
| cCommBufferBase::cCommBufferBase | ( | ) |
Constructor.
| virtual cCommBufferBase::~cCommBufferBase | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| char* cCommBufferBase::getBuffer | ( | ) | const |
Returns the buffer after packing.
| int cCommBufferBase::getBufferLength | ( | ) | const |
Returns the size of the buffer.
| void cCommBufferBase::allocateAtLeast | ( | int | size | ) |
Extend buffer to the given size is needed.
Existing buffer contents may be lost.
| void cCommBufferBase::setMessageSize | ( | int | size | ) |
Set message length in the buffer.
Used after receiving a message and copying it to the buffer.
Reimplemented in cFileCommBuffer.
| int cCommBufferBase::getMessageSize | ( | ) | const |
Returns message length in the buffer.
| void cCommBufferBase::reset | ( | ) |
Reset buffer to an empty state.
| virtual bool cCommBufferBase::isBufferEmpty | ( | ) | const [virtual] |
Returns true if all data in buffer was used up during unpacking.
Returns false if there was underflow (too much data unpacked) or still there are unpacked data in the buffer.
Implements cCommBuffer.
| virtual void cCommBufferBase::assertBufferEmpty | ( | ) | [virtual] |
Utility function.
To be called after unpacking a communication buffer, it checks whether the buffer is empty. If it is not (i.e. an underflow or overflow occurred), an exception is thrown.
Implements cCommBuffer.
The documentation for this class was generated from the following file:
