#include <coherence/io/OctetArrayReadBuffer.hpp>
Inherits AbstractReadBuffer.
Inherited by Binary.
Public Types | |||||||||||||||||||
typedef spec::Handle | Handle | ||||||||||||||||||
OctetArrayReadBuffer Handle definition. | |||||||||||||||||||
typedef spec::View | View | ||||||||||||||||||
OctetArrayReadBuffer View definition. | |||||||||||||||||||
typedef spec::Holder | Holder | ||||||||||||||||||
OctetArrayReadBuffer Holder definition. | |||||||||||||||||||
typedef this_spec::Handle | Handle | ||||||||||||||||||
AbstractReadBuffer Handle definition. | |||||||||||||||||||
typedef this_spec::View | View | ||||||||||||||||||
AbstractReadBuffer View definition. | |||||||||||||||||||
typedef this_spec::Holder | Holder | ||||||||||||||||||
AbstractReadBuffer Holder definition. | |||||||||||||||||||
Public Member Functions | |||||||||||||||||||
virtual size32_t | length () const | ||||||||||||||||||
Determine the length of the buffer.
| |||||||||||||||||||
virtual octet_t | read (size32_t of) const | ||||||||||||||||||
Returns the octet at the specified offset.
An offset ranges from
| |||||||||||||||||||
virtual void | read (size32_t ofBegin, size32_t ofEnd, Array< octet_t >::Handle habDest, size32_t ofDest) const | ||||||||||||||||||
Copies octets from this ReadBuffer into the destination octet array.
The first octet to be copied is at offset ofDest + (ofEnd - ofBegin) - 1This method allows the caller to extract a chunk of octets into the caller's own array.
| |||||||||||||||||||
virtual Array < octet_t >::View | toOctetArray (size32_t of, size32_t cb) const | ||||||||||||||||||
Get a portion of the contents of the ReadBuffer as an octet array.
| |||||||||||||||||||
virtual void | toStream (std::ostream &out) const | ||||||||||||||||||
Output a human-readable description of this Object to the given stream. coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toStream method, to output Objects. If a managed String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents.
Object::View vKey = ... Object::View vValue = ... std::cout << vKey << " = " << vValue << std::endl; String::Handle hs = COH_TO_STRING(vKey << " = " << vValue);
| |||||||||||||||||||
Protected Member Functions | |||||||||||||||||||
OctetArrayReadBuffer (Array< octet_t >::View vab, size32_t of, size32_t cb, bool fCopy=false) | |||||||||||||||||||
Construct an OctetArrayReadBuffer object from a portion of an octet array. | |||||||||||||||||||
OctetArrayReadBuffer (const OctetArrayReadBuffer &that) | |||||||||||||||||||
Copy constructor. | |||||||||||||||||||
virtual void | updateLength (size32_t cb) | ||||||||||||||||||
Allow the length to be modified. | |||||||||||||||||||
virtual ReadBuffer::View | instantiateReadBuffer (size32_t of, size32_t cb) const | ||||||||||||||||||
Factory method: Instantiate a ReadBuffer for a portion of this ReadBuffer.
| |||||||||||||||||||
virtual BufferInput::Handle | instantiateBufferInput () const | ||||||||||||||||||
Factory method: Instantiate a BufferInput object to read data from the ReadBuffer.
| |||||||||||||||||||
Protected Attributes | |||||||||||||||||||
FinalView< Array < octet_t > > | m_vab | ||||||||||||||||||
The octet array that holds the binary data. | |||||||||||||||||||
size32_t | m_of | ||||||||||||||||||
Offset into the octet array at which the binary data is located. | |||||||||||||||||||
size32_t | m_cb | ||||||||||||||||||
Number of octets in the octet array that belong to this ReadBuffer object. | |||||||||||||||||||
Classes | |||||||||||||||||||
class | OctetArrayBufferInput | ||||||||||||||||||
This is an implementation of the BufferInput interface on top of a octet array. More... |
OctetArrayReadBuffer | ( | Array< octet_t >::View | vab, | |
size32_t | of, | |||
size32_t | cb, | |||
bool | fCopy = false | |||
) | [protected] |
Construct an OctetArrayReadBuffer object from a portion of an octet array.
vab | an array of octets | |
of | the offset into the octet array | |
cb | the number of octets to extract | |
fCopy | true to make a copy of the passed array |
virtual void updateLength | ( | size32_t | cb | ) | [protected, virtual] |
Allow the length to be modified.
This method is provided for use by OctetArrayWriteBuffer only, and only for read buffers that it owns.
cb | the new length |
Reimplemented in Binary.