VR-Forces 5.0.2 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Attributes | Protected Attributes
makVrv::DtMessageStream Class Reference

Class for serializing objects as a byte stream for transmitting to othe rdisplay engines.

Public Types

typedef std::vector< DtMessage * > MessageList
 
typedef unsigned char Byte
 
typedef std::vector< ByteByteBuffer
 

Public Member Functions

 DtMessageStream (size_t initialReserve=0xFFF)
 
 ~DtMessageStream ()
 
void clearStream ()
 
void writeMessageToStream (DtMessage *message)
 
void writeMessagesToStream (MessageList &messages)
 
BytestreamData () const
 
size_t streamDataSize () const
 
void addDataToStream (char *data, size_t size)
 
ByteaddSpaceToStream (size_t size)
 
void trimEnd (size_t n)
 
int readMessagesFromStream (MessageList &messages)
 

Static Public Attributes

static const size_t theMaxPersistentStreamSize = 0x500000
 

Protected Attributes

ByteBuffer myMessageBuffer
 

Member Typedef Documentation

Constructor & Destructor Documentation

makVrv::DtMessageStream::DtMessageStream ( size_t  initialReserve = 0xFFF)

Create a stream with an initial reserve.

makVrv::DtMessageStream::~DtMessageStream ( )

DTOR.

Member Function Documentation

void makVrv::DtMessageStream::clearStream ( )

Clears all the data in the stream.

void makVrv::DtMessageStream::writeMessageToStream ( DtMessage message)

Methods used to encode messages onto a stream.

Add a message to the stream.

void makVrv::DtMessageStream::writeMessagesToStream ( MessageList messages)

Add messages to stream.

Byte* makVrv::DtMessageStream::streamData ( ) const

Methods for getting the binary data.

Get a pointer to the stream data (binary).

size_t makVrv::DtMessageStream::streamDataSize ( ) const

Get the size of the stream data (binary).

void makVrv::DtMessageStream::addDataToStream ( char data,
size_t  size 
)

Methods for added raw data to a stream.

Add Raw data.

Byte* makVrv::DtMessageStream::addSpaceToStream ( size_t  size)

Add Empty space to stream and return pointer to data (for writing directly into.

void makVrv::DtMessageStream::trimEnd ( size_t  n)

Removes the last 'n' bytes from the end of the stream.

int makVrv::DtMessageStream::readMessagesFromStream ( MessageList messages)

Read messages from a stream. The stream data will shrink after each call. Returns the number of messages read. If a corrupted message is detected, this will return -1.

Member Data Documentation

const size_t makVrv::DtMessageStream::theMaxPersistentStreamSize = 0x500000
static
ByteBuffer makVrv::DtMessageStream::myMessageBuffer
protected

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

Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)