NLNET::CMessage Class Reference

#include <message.h>

Inheritance diagram for NLNET::CMessage:

---

Detailed Description

Message memory stream for network. Can be serialized to/from (see SerialBuffer()). Can be sent or received over a network, using the NeL network engine. If MESSAGES_PLAIN_TEXT is defined, the messages will be serialized to/from plain text (human-readable), instead of binary. Warning: if you don't give a "sida", the message type will not be associated with id so, it'll not be optimized Warning: THE ASSOCIATION Id<->String SYSTEM FOR THE MESSAGE TYPE IS DISABLED BECAUSE 2 DIFFERENT CLIENTS COULD HAVE SAME STRING ASSOC AND DIFFERENT ID SO WE HAVE TO PUT ONE SIDA TABLE PER CONNECTION AND NOT PER NET_BASE

Author:

Vianney Lecroart

Nevrax France

Date:

2001

Definition at line 58 of file message.h.

Seek fonctionnality
enum	TSeekOrigin { begin, current, end }
virtual std::string	getStreamName () const
Public Types
enum	TStreamFormat { UseDefault, Binary, String }
Public Member Functions
void	assignFromSubMessage (const CMessage &msgin)
const uint8 *	buffer () const
uint8 *	bufferToFill (uint32 msgsize)
void	changeType (const std::string &name)
void	clear ()
	Clears the message.
	CMessage (const CMessage &other)
	Copy constructor.
	CMessage (NLMISC::CMemStream &memstr)
	CMessage (const std::string &name="", bool inputStream=false, TStreamFormat streamformat=UseDefault, uint32 defaultCapacity=1000)
	CMessage (NLMISC::CStringIdArray &sida, const std::string &name="", bool inputStream=false, TStreamFormat streamformat=UseDefault, uint32 defaultCapacity=1000)
NLMISC::CMemStream	extractStreamFromPos (sint32 pos)
	Return an input stream containing the stream beginning in the message at the specified pos.
template<class T> void	fastRead (T &value)
template<class T> void	fastSerial (T &val)
template<class T> void	fastWrite (const T &value)
void	fill (const uint8 *srcbuf, uint32 len)
uint32	getHeaderSize ()
	Returns the size, in byte of the header that contains the type name of the message or the type number.
NLMISC::CStringIdArray::TStringId	getId () const
	Returns the type id of this message is available.
std::string	getName () const
sint32	getPos () const
	Const and not-virtual getPos(), for direct use. Caution: should not be overloaded in a child class.
virtual sint32	getPos () throw (EStream)
bool	hasLockedSubMessage () const
	Return true if a sub message has been locked.
void	increaseBufferIfNecessary (uint32 len)
	Increase the buffer size if 'len' can't enter, otherwise, do nothing.
void	invert ()
bool	isReading () const
	Is this stream a Read/Input stream?
bool	isXML () const
virtual uint32	length () const
uint32	lengthR () const
	Returns the "read" message size (number of bytes to read) (note: see comment about _LengthR).
std::string	lockSubMessage (uint32 subMsgSize)
CMessage &	operator= (const CMessage &other)
	Assignment operator.
template<class T> void	poke (T value, sint32 pos)
void	readType ()
std::string	readTypeAtCurrentPos ()
	Get the message name (input message only) and advance the current pos.
sint32	reserve (uint len)
void	resetBufPos ()
void	resetPtrTable ()
	Force to reset the ptr table.
void	resize (uint32 size)
	Resize the buffer.
virtual bool	seek (sint32 offset, TSeekOrigin origin) throw (EStream)
template<class T0, class T1, class T2, class T3, class T4, class T5> void	serial (T0 &a, T1 &b, T2 &c, T3 &d, T4 &e, T5 &f)
template<class T0, class T1, class T2, class T3, class T4> void	serial (T0 &a, T1 &b, T2 &c, T3 &d, T4 &e)
template<class T0, class T1, class T2, class T3> void	serial (T0 &a, T1 &b, T2 &c, T3 &d)
template<class T0, class T1, class T2> void	serial (T0 &a, T1 &b, T2 &c)
template<class T0, class T1> void	serial (T0 &a, T1 &b)
template<class T> void	serial (T &obj)
	Template serialisation (should take the one from IStream).
virtual void	serialBit (bool &bit)
	Method inherited from IStream.
virtual void	serialBuffer (uint8 *buf, uint len)
	Method inherited from IStream.
virtual void	serialBufferWithSize (uint8 *buf, uint32 len)
virtual void	serialCont (std::vector< bool > &cont)
	Specialisation of serialCont() for vector<bool>.
virtual void	serialCont (std::vector< sint8 > &cont)
	Specialisation of serialCont() for vector<sint8>.
virtual void	serialCont (std::vector< uint8 > &cont)
	Specialisation of serialCont() for vector<uint8>.
template<class K, class T> void	serialCont (std::multimap< K, T > &cont)
	Specialisation of serialCont() for vector<bool>.
template<class K, class T> void	serialCont (std::map< K, T > &cont)
	Specialisation of serialCont() for vector<bool>.
template<class T> void	serialCont (std::multiset< T > &cont)
	Specialisation of serialCont() for vector<bool>.
template<class T> void	serialCont (std::set< T > &cont)
	Specialisation of serialCont() for vector<bool>.
template<class T> void	serialCont (std::deque< T > &cont)
	Specialisation of serialCont() for vector<bool>.
template<class T> void	serialCont (std::list< T > &cont)
	Specialisation of serialCont() for vector<bool>.
template<class T> void	serialCont (std::vector< T > &cont)
template<class T> void	serialEnum (T &em)
	Template enum serialisation. Serialized as a sint32.
virtual void	serialMemStream (CMemStream &b)
	Serial memstream, bitmemstream...
void	serialMessage (CMessage &msg)
	Encapsulate/decapsulate another message inside the current message.
void	setStringMode (bool stringmode)
	Set string mode.
void	setType (const std::string &name)
	Sets the message type as a string and put it in the buffer if we are in writing mode.
void	setType (NLMISC::CStringIdArray::TStringId id)
	Sets the message type as a number (in range 0..32767) and put it in the buffer if we are in writing mode.
uint32	size () const
	Returns the size of the buffer (can be greater than the length, especially in output mode).
bool	stringMode () const
	Return string mode.
std::string	toString () const
bool	typeIsSet () const
void	unlockSubMessage ()
String-specific methods
virtual void	serialHex (uint32 &b)
	Serialisation in hexadecimal.
uint	serialSeparatedBufferIn (uint8 *buf, uint len)
	Input: read len bytes at most from the stream until the next separator, and return the number of bytes read. The separator is then skipped.
void	serialSeparatedBufferOut (uint8 *buf, uint len)
	Output: writes len bytes from buf into the stream.
Base types serialisation, redefined for string mode
Those method are a specialisation of template method "void serial(T&)".
virtual void	serial (ucstring &b)
virtual void	serial (std::string &b)
virtual void	serial (char &b)
virtual void	serial (bool &b)
virtual void	serial (double &b)
virtual void	serial (float &b)
virtual void	serial (sint64 &b)
virtual void	serial (uint64 &b)
virtual void	serial (sint32 &b)
virtual void	serial (uint32 &b)
virtual void	serial (sint16 &b)
virtual void	serial (uint16 &b)
virtual void	serial (sint8 &b)
virtual void	serial (uint8 &b)
String-specific methods
virtual void	serialHex (uint32 &b)
	Serialisation in hexadecimal.
uint	serialSeparatedBufferIn (uint8 *buf, uint len)
	Input: read len bytes at most from the stream until the next separator, and return the number of bytes read. The separator is then skipped.
void	serialSeparatedBufferOut (uint8 *buf, uint len)
	Output: writes len bytes from buf into the stream.
Base types serialisation, redefined for string mode
Those method are a specialisation of template method "void serial(T&)".
virtual void	serial (ucstring &b)
virtual void	serial (std::string &b)
virtual void	serial (char &b)
virtual void	serial (bool &b)
virtual void	serial (double &b)
virtual void	serial (float &b)
virtual void	serial (sint64 &b)
virtual void	serial (uint64 &b)
virtual void	serial (sint32 &b)
virtual void	serial (uint32 &b)
virtual void	serial (sint16 &b)
virtual void	serial (uint16 &b)
virtual void	serial (sint8 &b)
virtual void	serial (uint8 &b)
String-specific methods
virtual void	serialHex (uint32 &b)
	Serialisation in hexadecimal.
uint	serialSeparatedBufferIn (uint8 *buf, uint len)
	Input: read len bytes at most from the stream until the next separator, and return the number of bytes read. The separator is then skipped.
void	serialSeparatedBufferOut (uint8 *buf, uint len)
	Output: writes len bytes from buf into the stream.
Static Public Member Functions
void	getVersionException (bool &throwOnOlder, bool &throwOnNewer)
void	setDefaultStringMode (bool stringmode)
	Set default stream mode.
void	setVersionException (bool throwOnOlder, bool throwOnNewer)
Data Fields
bool	TypeHasAName
bool	TypeHasAnId
Protected Member Functions
void	init (const std::string &name, TStreamFormat streamformat)
	Utility method.
uint32	lengthS () const
	Returns the serialized length (number of bytes written or read).
void	resetSubMessageInternals ()
	Utility method.
template<class T> void	serialVector (T &cont)
Protected Attributes
CObjectVector< uint8, false >	_Buffer
uint8 *	_BufPos
uint32	_DefaultCapacity
bool	_StringMode
Private Attributes
uint32	_HeaderSize
NLMISC::CStringIdArray::TStringId	_Id
uint32	_LengthR
std::string	_Name
NLMISC::CStringIdArray *	_SIDA
uint32	_SubMessagePosR
bool	_TypeSet
Static Private Attributes
bool	_DefaultStringMode = false

---

Member Enumeration Documentation

enum NLMISC::IStream::TSeekOrigin [inherited]

Parameters for seek(). begin seek from the begining of the stream. current seek from the current location of the stream pointer. end seek from the end of the stream. Enumeration values: begin  current  end  Definition at line 549 of file stream.h. { begin, current, end };

enum NLNET::CMessage::TStreamFormat

Enumeration values: UseDefault  Binary  String  Definition at line 62 of file message.h. { UseDefault, Binary, String };

---

Constructor & Destructor Documentation

NLNET::CMessage::CMessage (  NLMISC::CStringIdArray &  sida, const std::string &  name = "", bool  inputStream = false, TStreamFormat  streamformat = UseDefault, uint32  defaultCapacity = 1000 )

Definition at line 50 of file message.cpp. References init(), and uint32. : NLMISC::CMemStream (inputStream, false, defaultCapacity), TypeHasAnId(false), TypeHasAName(false), _SIDA (&sida), _SubMessagePosR(0), _LengthR(0), _HeaderSize(0xFFFFFFFF), _TypeSet (false) { init( name, streamformat ); }

NLNET::CMessage::CMessage (  const std::string &  name = "", bool  inputStream = false, TStreamFormat  streamformat = UseDefault, uint32  defaultCapacity = 1000 )

Definition at line 61 of file message.cpp. References init(), and uint32. : NLMISC::CMemStream (inputStream, false, defaultCapacity), TypeHasAnId(false), TypeHasAName(false), _SIDA (NULL), _SubMessagePosR(0), _LengthR(0), _HeaderSize(0xFFFFFFFF), _TypeSet (false) { init( name, streamformat ); }

NLNET::CMessage::CMessage (  NLMISC::CMemStream &  memstr  )

Definition at line 91 of file message.cpp. References NLMISC::CMemStream::getPos(), invert(), NLMISC::IStream::isReading(), readType(), NLMISC::CMemStream::seek(), and sint32. : NLMISC::CMemStream( memstr ), TypeHasAnId(false), TypeHasAName(false), _SIDA (NULL), _SubMessagePosR(0), _LengthR(0), _HeaderSize(0xFFFFFFFF), _TypeSet (false) { sint32 pos = getPos(); bool reading = isReading(); if ( reading ) // force input mode to read the type readType(); // sets _TypeSet, _HeaderSize and _LengthR else invert(); // calls readType() if ( ! reading ) invert(); // set ouput mode back if necessary seek( pos, begin ); // sets the same position as the one in the memstream }

NLNET::CMessage::CMessage (  const CMessage &  other  )

Copy constructor. Definition at line 110 of file message.cpp. References operator=(). { operator= (other); }

---

Member Function Documentation

void NLNET::CMessage::assignFromSubMessage (  const CMessage &  msgin  )

Similar to operator=, but makes the current message contain *only* the locked sub message in msgin or the whole msgin if it is not locked Preconditions: msgin is an input message (isReading()) The current message is blank (new or reset with clear()) Postconditions: If msgin has been locked using lockSubMessage(), the current message contains only the locked sub message in msgin, otherwise the current message is exactly msgin The current message is an input message, it is not locked Definition at line 151 of file message.cpp. References _LengthR, _SubMessagePosR, _TypeSet, NLMISC::CMemStream::buffer(), NLMISC::CMemStream::fill(), hasLockedSubMessage(), invert(), NLMISC::IStream::isReading(), nlassert, operator=(), and readType(). { nlassert( msgin.isReading() ); nlassert( ! _TypeSet ); if ( ! isReading() ) invert(); if ( msgin.hasLockedSubMessage() ) { fill( msgin.buffer() + msgin._SubMessagePosR, msgin._LengthR-msgin._SubMessagePosR ); readType(); } else { operator=( msgin ); } }

const uint8* NLMISC::CMemStream::buffer (   )  const [inline, inherited]

Returns a pointer to the message buffer (read only) Returns NULL if the buffer is empty Definition at line 238 of file mem_stream.h. References NLMISC::CObjectVector< uint8, false >::getPtr(), and uint8. Referenced by assignFromSubMessage(), NLMISC::displayBitStream(), extractStreamFromPos(), NLNET::TMessageRecord::serial(), NLMISC::IStream::serialMemStream(), NLMISC::CBitMemStream::serialMemStream(), and serialMessage(). { return _Buffer.getPtr(); /* if ( _Buffer.empty() ) { return NULL; } else { return &(*_Buffer.begin()); }*/ }

uint8* NLMISC::CMemStream::bufferToFill (  uint32  msgsize  )  [inline, inherited]

Resize the stream with the specified size, set the current position at the beginning of the stream and return a pointer to the stream buffer. Precondition: the stream is an input stream. Suggested usage: construct an input stream, resize and get the buffer using bufferToFillAndRead(), fill it with raw data using any filling function (warning: don't fill more than 'msgsize' bytes!), then you are ready to read, using serial(), the data you've just filled. Reimplemented in NLMISC::CBitMemStream. Definition at line 306 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, NLMISC::CObjectVector< uint8, false >::getPtr(), NLMISC::IStream::isReading(), nlassert, NLMISC::CObjectVector< uint8, false >::resize(), uint32, and uint8. Referenced by extractStreamFromPos(), NLPACS::CGlobalRetriever::CLrLoader::run(), NLNET::TMessageRecord::serial(), NLMISC::IStream::serialMemStream(), and serialMessage(). { #ifdef NL_DEBUG nlassert( isReading() ); #endif if ( msgsize == 0 ) return NULL; _Buffer.resize( msgsize ); _BufPos = _Buffer.getPtr(); /*if ( ! isReading() ) _BufPos += msgsize;*/ return _Buffer.getPtr(); }

void NLNET::CMessage::changeType (  const std::string &  name  )

Definition at line 297 of file message.cpp. References NLMISC::CMemStream::getPos(), NLMISC::CMemStream::seek(), NLMISC::CMemStream::serial(), sint32, uint32, and uint8. { sint32 prevPos = getPos(); seek( sizeof(uint32)+sizeof(uint8), begin ); serial ((std::string&)name); seek( prevPos, begin ); }

void NLNET::CMessage::clear (  void   )  [virtual]

Clears the message. Reimplemented from NLMISC::CMemStream. Definition at line 398 of file message.cpp. References _LengthR, _SubMessagePosR, _TypeSet, hasLockedSubMessage(), NLMISC::IStream::isReading(), NLNET::LockedSubMessageError, and nlassertex. Referenced by NLNET::CPacsClient::initMessage(). { nlassertex( (!isReading()) || (!hasLockedSubMessage()), ("Clearing %s", LockedSubMessageError) ); CMemStream::clear (); _TypeSet = false; _SubMessagePosR = 0; _LengthR = 0; }

NLMISC::CMemStream NLNET::CMessage::extractStreamFromPos (  sint32  pos  )

Return an input stream containing the stream beginning in the message at the specified pos. Definition at line 460 of file message.cpp. References NLMISC::CMemStream::buffer(), NLMISC::CMemStream::bufferToFill(), len, length(), and sint32. { NLMISC::CMemStream msg( true ); sint32 len = length() - pos; memcpy( msg.bufferToFill( len ), buffer() + pos, len ); return msg; }

template<class T> void NLMISC::CMemStream::fastRead (  T &  value  )  [inline, inherited]

Definition at line 404 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, NLMISC::CMemStream::length(), NLMISC::CMemStream::lengthS(), and value. { //nldebug( "MEMSTREAM: Reading %u-byte value in %p at pos %u", sizeof(value), this, _BufPos - _Buffer.getPtr() ); // Check that we don't read more than there is to read if ( lengthS()+sizeof(value) > length() ) // calls virtual length (cf. sub messages) { throw EStreamOverflow(); } // Serialize in value = *(T*)_BufPos; _BufPos += sizeof(value); }

template<class T> void NLMISC::CMemStream::fastSerial (  T &  val  )  [inline, inherited]

Definition at line 371 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, NLMISC::CMemStream::increaseBufferIfNecessary(), NLMISC::IStream::isReading(), NLMISC::CMemStream::length(), and NLMISC::CMemStream::lengthS(). Referenced by NLMISC::CMemStream::serial(). { #ifdef NL_LITTLE_ENDIAN if(isReading()) { // Check that we don't read more than there is to read // TODO OPTIM we can remove the check if we want to be faster (50ms->43ms for 1 million serial) if ( lengthS()+sizeof(T) > length() ) // calls virtual length (cf. sub messages) throw EStreamOverflow(); // Serialize in val = *(T*)_BufPos; } else { increaseBufferIfNecessary (sizeof(T)); *(T*)_BufPos = val; } _BufPos += sizeof (T); #else // NL_LITTLE_ENDIAN IStream::serial( val ); #endif // NL_LITTLE_ENDIAN }

template<class T> void NLMISC::CMemStream::fastWrite (  const T &  value  )  [inline, inherited]

Definition at line 395 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, NLMISC::CMemStream::increaseBufferIfNecessary(), and value. { //nldebug( "MEMSTREAM: Writing %u-byte value in %p at pos %u", sizeof(value), this, _BufPos - _Buffer.getPtr() ); increaseBufferIfNecessary (sizeof(T)); *(T*)_BufPos = value; _BufPos += sizeof (T); }

void NLMISC::CMemStream::fill (  const uint8 *  srcbuf, uint32  len )  [inline, inherited]

Resize the message buffer and fill data at position 0. Input stream: the current position is set at the beginning; Output stream: the current position is set after the filled data. Reimplemented in NLMISC::CBitMemStream. Definition at line 277 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, NLMISC::CObjectVector< uint8, false >::getPtr(), NLMISC::IStream::isReading(), len, NLMISC::CObjectVector< uint8, false >::resize(), NLMISC::CObjectVector< uint8, false >::size(), uint32, and uint8. Referenced by assignFromSubMessage(), and NL3D::CTextureMem::doGenerate(). { if (len == 0) return; _Buffer.resize( len ); CFastMem::memcpy( _Buffer.getPtr(), srcbuf, len ); if (isReading()) { _BufPos = _Buffer.getPtr(); } else { _BufPos = _Buffer.getPtr() + _Buffer.size(); } }

uint32 NLNET::CMessage::getHeaderSize (   )

Returns the size, in byte of the header that contains the type name of the message or the type number. Definition at line 309 of file message.cpp. References _HeaderSize, nlassert, and uint32. Referenced by NLNET::getNameOfMessageOrTransportClass(). { nlassert (_HeaderSize != 0xFFFFFFFF); return _HeaderSize; }

NLMISC::CStringIdArray::TStringId NLNET::CMessage::getId (   )  const

Returns the type id of this message is available. Definition at line 432 of file message.cpp. References _TypeSet, nlassert, NLMISC::CStringIdArray::TStringId, and TypeHasAnId. Referenced by NLNET::CCallbackNetBase::processOneMessage(). { nlassert (_TypeSet && TypeHasAnId); return _Id; }

std::string NLNET::CMessage::getName (   )  const

Returns the type name in string if available. Be sure that the message have the name of the message type In a callback driven by message name, getName() does not necessarily return the right name. Definition at line 411 of file message.cpp. References _SubMessagePosR, _TypeSet, NLMISC::CMemStream::getPos(), hasLockedSubMessage(), nlassert, readTypeAtCurrentPos(), NLMISC::CMemStream::seek(), sint32, and TypeHasAName. Referenced by NLNET::getNameOfMessageOrTransportClass(), NLNET::CCallbackNetBase::processOneMessage(), NLNET::CUnifiedNetwork::send(), NLNET::uncbMsgProcessing(), and unlockSubMessage(). { if ( hasLockedSubMessage() ) { CMessage& notconstMsg = const_cast<CMessage&>(*this); sint32 savedPos = notconstMsg.getPos(); notconstMsg.seek( _SubMessagePosR, begin ); // not really const... but removing the const from getName() would need too many const changes elsewhere std::string name = notconstMsg.readTypeAtCurrentPos(); notconstMsg.seek( savedPos, begin ); return name; } else { nlassert (_TypeSet && TypeHasAName); return _Name; } }

sint32 NLMISC::CMemStream::getPos (  void   )  const [inline, inherited]

Const and not-virtual getPos(), for direct use. Caution: should not be overloaded in a child class. Definition at line 159 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, NLMISC::CObjectVector< uint8, false >::getPtr(), and sint32. { return _BufPos - _Buffer.getPtr(); }

virtual sint32 NLMISC::CMemStream::getPos (  void   )  throw (EStream) [inline, virtual, inherited]

Get the location of the stream pointer. NB: If the stream doesn't support the seek fonctionnality, it throws ESeekNotSupported. Default implementation: { throw ESeekNotSupported; } Parameters: offset  is the wanted offset from the origin. origin  is the origin of the seek Returns: the new offset regarding from the origin. See also: ESeekNotSupported SeekOrigin seek Reimplemented from NLMISC::IStream. Definition at line 153 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, NLMISC::CObjectVector< uint8, false >::getPtr(), and sint32. Referenced by changeType(), CMessage(), getName(), lockSubMessage(), readType(), readTypeAtCurrentPos(), NLMISC::CBitMemStream::serial(), NLMISC::CBitMemStream::serialCont(), NLMISC::CBitMemStream::serialMemStream(), setType(), and unlockSubMessage(). { return _BufPos - _Buffer.getPtr(); }

string NLMISC::IStream::getStreamName (   )  const [virtual, inherited]

Get a name for this stream. maybe a fileName if FileStream. Default is to return "". Reimplemented in NLMISC::CIFile, and NLMISC::COFile. Definition at line 420 of file stream.cpp. Referenced by NLMISC::EStream::EStream(). { return ""; }

void NLMISC::IStream::getVersionException (  bool &  throwOnOlder, bool &  throwOnNewer )  [static, inherited]

Get the behavior of IStream regarding input stream that are older/newer than the class. See also: serialVersion() setVersionException() Definition at line 78 of file stream.cpp. References NLMISC::IStream::_ThrowOnNewer, and NLMISC::IStream::_ThrowOnOlder. { throwOnOlder=_ThrowOnOlder; throwOnNewer=_ThrowOnNewer; }

bool NLNET::CMessage::hasLockedSubMessage (   )  const [inline]

Return true if a sub message has been locked. Definition at line 175 of file message.h. References _SubMessagePosR. Referenced by assignFromSubMessage(), clear(), getName(), invert(), operator=(), and unlockSubMessage(). { return (_SubMessagePosR != 0); }

void NLMISC::CMemStream::increaseBufferIfNecessary (  uint32  len  )  [inline, inherited]

Increase the buffer size if 'len' can't enter, otherwise, do nothing. Definition at line 358 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, NLMISC::CObjectVector< uint8, false >::getPtr(), len, NLMISC::CObjectVector< uint8, false >::resize(), NLMISC::CObjectVector< uint8, false >::size(), and uint32. Referenced by NLMISC::CMemStream::fastSerial(), NLMISC::CMemStream::fastWrite(), NLMISC::CMemStream::reserve(), and NLMISC::CMemStream::serialBuffer(). { uint32 oldBufferSize = _Buffer.size(); if (_BufPos - _Buffer.getPtr() + len > oldBufferSize) { // need to increase the buffer size uint32 pos = _BufPos - _Buffer.getPtr(); _Buffer.resize(oldBufferSize*2 + len); _BufPos = _Buffer.getPtr() + pos; } }

void NLNET::CMessage::init (  const std::string &  name, TStreamFormat  streamformat )  [protected]

Utility method. Definition at line 72 of file message.cpp. References _DefaultStringMode, NLMISC::CMemStream::setStringMode(), setType(), and UseDefault. Referenced by CMessage(). { if ( streamformat == UseDefault ) { setStringMode( _DefaultStringMode ); } else { setStringMode( streamformat == String ); } if (!name.empty()) setType (name); }

void NLNET::CMessage::invert (   )  [inline, virtual]

Transforms the message from input to output or from output to input Reimplemented from NLMISC::CMemStream. Definition at line 198 of file message.h. References _TypeSet, hasLockedSubMessage(), NLMISC::IStream::isReading(), NLNET::LockedSubMessageError, nlassertex, and readType(). Referenced by assignFromSubMessage(), CMessage(), NLNET::NLMISC_COMMAND(), and serialMessage(). { nlassertex( (!isReading()) || (!hasLockedSubMessage()), ("Inverting %s", LockedSubMessageError) ); CMemStream::invert(); if ( isReading() ) { // Write -> Read: skip the header _TypeSet = false; if ( _Buffer.size() != 0 ) readType(); } // For Read -> Write, please use clear() }

bool NLMISC::IStream::isReading (   )  const [inline, inherited]

Is this stream a Read/Input stream? Definition at line 64 of file stream_inline.h. References NLMISC::IStream::_InputStream. Referenced by assignFromSubMessage(), NLMISC::CMemStream::bufferToFill(), NL3D::CParticleSystemShape::buildFromPS(), clear(), NLMISC::CMemStream::clear(), CMessage(), NLMISC::CBitMemStream::displayStream(), NLMISC::CMemStream::fastSerial(), NLMISC::CMemStream::fill(), NL3D::CParticleSystemShape::flushTextures(), NLMISC::CBitMemStream::getSerialItem(), NLMISC::CBitMemStream::increaseBufferIfNecessary(), NLMISC::COXml::init(), NL3D::CParticleSystemShape::instanciatePS(), NLMISC::CBitMemStream::internalSerial(), invert(), NLMISC::CMemStream::invert(), NLMISC::CBitMemStream::invert(), length(), NLMISC::CMemStream::length(), NLMISC::CBitMemStream::length(), NLMISC::CBitmap::load(), NLMISC::CBitmap::loadSize(), lockSubMessage(), operator=(), NLMISC::CBitMemStream::pointNextByte(), NLMISC::CMemStream::poke(), NLMISC::CBitMemStream::poke(), NLMISC::CBitMemStream::pokeBits(), NLMISC::CBitMemStream::readBits(), NLMISC::CBitmap::readTGA(), readTypeAtCurrentPos(), NLMISC::CMemStream::reserve(), NLMISC::CBitMemStream::reserveBits(), NLMISC::CBitMemStream::resetBufPos(), NLPACS::CGlobalRetriever::CLrLoader::run(), NL3D::CZone::serial(), NL3D::CVegetableShape::serial(), NLPACS::CSurfaceQuadTree::serial(), NLPACS::CQuadBranch::serial(), NL3D::CSurfaceLightGrid::CCellCorner::serial(), NLMISC::CStringStream::serial(), NLMISC::IStream::serial(), NL3D::CInstanceGroup::serial(), NL3D::CInstanceGroup::CInstance::serial(), NLPACS::CRetrieverInstance::serial(), NLPACS::CRetrieverBank::serial(), NL3D::CPSAttrib< T >::serial(), NL3D::CPortal::serial(), NL3D::CPointLightNamed::serial(), NL3D::CPointLight::serial(), NL3D::CPatch::serial(), NLMISC::CObjectVector< sint8, false >::serial(), NLMISC::COXml::serial(), NLNET::TMessageRecord::serial(), NL3D::CMeshMRMSkinnedGeom::serial(), NLMISC::CMemStream::serial(), NLMISC::CMatrix::serial(), NL3D::CMaterial::CLightMap::serial(), NL3D::CMaterial::serial(), NLNET::CInetAddress::serial(), NL3D::CHLSTextureBank::serial(), NLPACS::CGlobalRetriever::serial(), NLPACS::CEdgeQuad::serial(), NL3D::CCluster::serial(), NLPACS::CChainQuad::serial(), NLPACS::COrderedChain::serial(), NLMISC::CBitSet::serial(), NLMISC::CBitMemStream::serial(), NL3D::CMaterialBase::CAnimatedTexture::serial(), NLMISC::CAABBoxExt::serial(), NL3D::CMaterial::CLightMap::serial2(), NLMISC::CStringStream::serialBit(), NLMISC::CMemStream::serialBit(), NLMISC::CBitMemStream::serialBit(), NLMISC::CMemStream::serialBuffer(), NLMISC::CBitMemStream::serialBuffer(), NLMISC::IStream::serialCheck(), NLMISC::CStringStream::serialCont(), NLMISC::IStream::serialCont(), NLMISC::CBitMemStream::serialCont(), NLMISC::IStream::serialEnum(), NL3D::CVertexBuffer::serialHeader(), NLMISC::CStringStream::serialHex(), NLMISC::CMemStream::serialHex(), NLMISC::IStream::serialIStreamable(), NL3D::CMeshMRMGeom::serialLodVertexData(), NLMISC::IStream::serialMap(), NLMISC::IStream::serialMemStream(), NLMISC::CBitMemStream::serialMemStream(), serialMessage(), NLMISC::IStream::serialMultimap(), NL3D::CVertexBuffer::serialOldV1Minus(), NLMISC::IStream::serialPtr(), NLMISC::CStringStream::serialSeparatedBufferIn(), NLMISC::CMemStream::serialSeparatedBufferIn(), NLMISC::CStringStream::serialSeparatedBufferOut(), NLMISC::COXml::serialSeparatedBufferOut(), NLMISC::CMemStream::serialSeparatedBufferOut(), NLMISC::IStream::serialSTLCont(), NLMISC::IStream::serialSTLContLen(), NLMISC::IStream::serialSTLContLenPolyPtr(), NLMISC::IStream::serialSTLContLenPtr(), NLMISC::IStream::serialSTLContPolyPtr(), NLMISC::IStream::serialSTLContPtr(), NL3D::CVertexBuffer::serialSubset(), NLMISC::IStream::serialVector(), NLMISC::IStream::serialVectorPolyPtr(), NLMISC::IStream::serialVectorPtr(), NLMISC::IStream::serialVersion(), setType(), unlockSubMessage(), NLMISC::CBitmap::writeTGA(), NLMISC::COXml::xmlBreakLineInternal(), NLMISC::COXml::xmlCommentInternal(), NLMISC::COXml::xmlPopInternal(), NLMISC::COXml::xmlPushBeginInternal(), NLMISC::COXml::xmlPushEndInternal(), and NLMISC::COXml::xmlSetAttribInternal(). { return _InputStream; }

bool NLMISC::IStream::isXML (   )  const [inline, inherited]

Definition at line 221 of file stream.h. References NLMISC::IStream::_XML. Referenced by NLMISC::CMemStream::serial(). { return _XML; }

virtual uint32 NLNET::CMessage::length (   )  const [inline, virtual]

Returns the length (size) of the message, in bytes. If isReading(), it is the number of bytes that can be read, otherwise it is the number of bytes that have been written. Overloaded because uses a specific version of lengthR(). Reimplemented from NLMISC::CMemStream. Definition at line 104 of file message.h. References NLMISC::IStream::isReading(), lengthR(), NLMISC::CMemStream::lengthS(), and uint32. Referenced by extractStreamFromPos(), NLNET::CCallbackNetBase::processOneMessage(), NLNET::TMessageRecord::serial(), and serialMessage(). { if ( isReading() ) { return lengthR(); } else { return lengthS(); } }

uint32 NLNET::CMessage::lengthR (   )  const [inline]

Returns the "read" message size (number of bytes to read) (note: see comment about _LengthR). Reimplemented from NLMISC::CMemStream. Definition at line 117 of file message.h. References _LengthR, and uint32. Referenced by length(), and lockSubMessage(). { return _LengthR; }

uint32 NLMISC::CMemStream::lengthS (   )  const [inline, protected, inherited]

Returns the serialized length (number of bytes written or read). Definition at line 502 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, NLMISC::CObjectVector< uint8, false >::getPtr(), and uint32. Referenced by NLMISC::CMemStream::fastRead(), NLMISC::CMemStream::fastSerial(), length(), NLMISC::CMemStream::length(), NLMISC::CBitMemStream::length(), NLMISC::CMemStream::operator=(), NLMISC::CMemStream::serialBuffer(), NLMISC::CStringStream::serialSeparatedBufferIn(), and NLMISC::CMemStream::serialSeparatedBufferIn(). { return _BufPos - _Buffer.getPtr(); // not calling getPos() because virtual and not const! }

std::string NLNET::CMessage::lockSubMessage (  uint32  subMsgSize  )  [inline]

Set an input message to look like, from a message callback's scope, as if it began at the current pos and ended at the current pos + msgSize, and read the header and return the name of the sub message. This method provides a way to pass a big message containing a set of sub messages to their message callback, without copying each sub message to a new message. If you need to perform some actions that are not allowed with a locked message (see postconditions), use assignFromSubMessage(): the locked sub message in M1 can be copied to a new message M2 with 'M2.assignFromSubMessage( M1 )'. Preconditions: The message is an input message (isReading()) msgEndPos <= length() getPos() >= getHeaderSize() Postconditions: The sub message is ready to be read from length() returns the size of the sub message getName() return the name of the sub message Unless you call unlockSubMessage(), the following actions will assert or raise an exception: Serializing more than the sub message size, clear(), operator=() (from/to), invert(). Definition at line 143 of file message.h. References _LengthR, _SubMessagePosR, NLMISC::CMemStream::getPos(), NLMISC::IStream::isReading(), lengthR(), nlassertex, readTypeAtCurrentPos(), and uint32. { uint32 subMsgBeginPos = getPos(); uint32 subMsgEndPos = subMsgBeginPos + subMsgSize; nlassertex( isReading() && (subMsgEndPos <= lengthR()), ("%s %u %u", isReading()?"R":"W", subMsgEndPos, lengthR()) ); std::string name = readTypeAtCurrentPos(); _SubMessagePosR = subMsgBeginPos; _LengthR = subMsgEndPos; return name; }

CMessage & NLNET::CMessage::operator= (  const CMessage &  other  )

Assignment operator. Definition at line 118 of file message.cpp. References _HeaderSize, _Id, _LengthR, _Name, _SIDA, _SubMessagePosR, _TypeSet, hasLockedSubMessage(), NLMISC::IStream::isReading(), NLNET::LockedSubMessageError, nlassertex, TypeHasAName, and TypeHasAnId. Referenced by assignFromSubMessage(), and CMessage(). { nlassertex( (!other.isReading()) || (!other.hasLockedSubMessage()), ("Storing %s", LockedSubMessageError) ); nlassertex( (!isReading()) || (!hasLockedSubMessage()), ("Assigning %s", LockedSubMessageError) ); CMemStream::operator= (other); _TypeSet = other._TypeSet; _SIDA = other._SIDA; TypeHasAnId = other.TypeHasAnId; TypeHasAName = other.TypeHasAName; _Name = other._Name; _Id = other._Id; _HeaderSize = other._HeaderSize; _SubMessagePosR = other._SubMessagePosR; _LengthR = other._LengthR; return *this; }

template<class T> void NLMISC::CMemStream::poke (  T  value, sint32  pos )  [inline, inherited]

When writing, fill a value previously reserved by reserve() (warning: you MUST have called reserve() with sizeof(T) before poking). Usually it's an alternative to use serialCont with a vector. Example: uint8 counter=0; sint32 counterPos = msgout.reserve( sizeof(counter) ); counter = serialSelectedItems( msgout ); msgout.poke( counter, counterPos ); Definition at line 190 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, NLMISC::CObjectVector< uint8, false >::getPtr(), NLMISC::IStream::isReading(), nlassert, sint32, uint8, and value. { if ( ! isReading() ) { uint8 *pokeBufPos = _Buffer.getPtr() + pos; nlassert( pokeBufPos + sizeof(T) <= _BufPos ); *(T*)pokeBufPos = value; } }

void NLNET::CMessage::readType (   )

The message was filled with an CMemStream, Now, we'll get the message type on this buffer. This method updates _LengthR with the actual size of the buffer (it calls resetLengthR()). Definition at line 319 of file message.cpp. References _HeaderSize, format, NLMISC::CMemStream::getPos(), nlassert, resetSubMessageInternals(), NLMISC::CMemStream::seek(), NLMISC::CMemStream::serial(), setType(), NLMISC::CStringIdArray::TStringId, uint, and uint8. Referenced by assignFromSubMessage(), CMessage(), invert(), and serialMessage(). { nlassert (isReading ()); // debug features, we number all packet to be sure that they are all sent and received // \todo remove this debug feature when ok // we remove the message from the message resetSubMessageInternals(); const uint HeaderSize = 4; seek (HeaderSize, begin); // uint32 zeroValue; // serial (zeroValue); // Force binary mode for header _StringMode = false; uint8 format; serial (format); //nldebug( "IN format = %hu", (uint16)format ); bool LongFormat = (format & 1); // Set mode for the following of the buffer _StringMode = (format >> 1) & 1; if (LongFormat) { std::string name; serial (name); setType (name); } else { NLMISC::CStringIdArray::TStringId id; serial (id); setType (id); } _HeaderSize = getPos(); }

std::string NLNET::CMessage::readTypeAtCurrentPos (   )

Get the message name (input message only) and advance the current pos. Definition at line 362 of file message.cpp. References format, NLMISC::CMemStream::getPos(), NLMISC::IStream::isReading(), nlassert, nlerror, NLMISC::CMemStream::seek(), NLMISC::CMemStream::serial(), uint, and uint8. Referenced by getName(), and lockSubMessage(). { nlassert( isReading() ); const uint HeaderSize = 4; seek( getPos() + HeaderSize, begin ); bool sm = _StringMode; _StringMode = false; uint8 format; serial( format ); bool LongFormat = (format & 1); _StringMode = (format >> 1) & 1; if ( LongFormat ) { std::string name; serial( name ); _StringMode = sm; return name; } else nlerror( "Id not supported" ); _StringMode = sm; return ""; }

sint32 NLMISC::CMemStream::reserve (  uint  len  )  [inline, inherited]

When writing, skip 'len' bytes and return the position of the blank space for a future poke(). Warning: this has nothing to do with the semantics of reserve() in std::vector! Definition at line 168 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, NLMISC::CObjectVector< uint8, false >::getPtr(), NLMISC::CMemStream::increaseBufferIfNecessary(), NLMISC::IStream::isReading(), len, sint32, and uint. { sint32 pos = _BufPos - _Buffer.getPtr(); if ( ! isReading() ) { increaseBufferIfNecessary( len ); _BufPos += len; } return pos; }

void NLMISC::CMemStream::resetBufPos (   )  [inline, inherited]

When you fill the buffer externaly (using bufferAsVector) you have to reset the BufPos calling this method If you are using the stream only in output mode, you can use this method as a faster version of clear() *if you don't serialize pointers*. Reimplemented in NLMISC::CBitMemStream. Definition at line 270 of file mem_stream.h. References NLMISC::CMemStream::_BufPos, and NLMISC::CObjectVector< uint8, false >::getPtr(). Referenced by NLMISC::IStream::serialMemStream(). { _BufPos = _Buffer.getPtr(); }

void NLMISC::CMemStream::resetPtrTable (   )  [inline, inherited]

Force to reset the ptr table. Reimplemented from NLMISC::IStream. Definition at line 352 of file mem_stream.h. Referenced by NLMISC::CMemStream::clear(), NL3D::CParticleSystemShape::flushTextures(), NL3D::CParticleSystemShape::instanciatePS(), and NLMISC::CMemStream::invert(). { IStream::resetPtrTable() ; }

void NLNET::CMessage::resetSubMessageInternals (   )  [inline, protected]

Utility method. Definition at line 248 of file message.h. References _LengthR, and _SubMessagePosR. Referenced by readType(), and unlockSubMessage(). { _SubMessagePosR = 0; _LengthR = _Buffer.size(); }

void NLMISC::CMemStream::resize (  uint32  size  )  [inherited]

Resize the buffer. Definition at line 235 of file mem_stream.cpp. References NLMISC::CMemStream::_BufPos, NLMISC::CObjectVector< uint8, false >::getPtr(), NLMISC::CMemStream::length(), NLMISC::CObjectVector< uint8, false >::resize(), size, and uint32. { if (size == length()) return; // need to increase the buffer size uint32 pos = _BufPos - _Buffer.getPtr(); _Buffer.resize(size); _BufPos = _Buffer.getPtr() + pos; }

bool NLMISC::CMemStream::seek (  sint32  offset, TSeekOrigin  origin )  throw (EStream) [virtual, inherited]

Moves the stream pointer to a specified location. Warning: in output mode, seek(end) does not point to the end of the serialized data, but on the end of the whole allocated buffer (see size()). If you seek back and want to return to the end of the serialized data, you have to store the position (a better way is to use reserve()/poke()). NB: If the stream doesn't support the seek fonctionnality, it throws ESeekNotSupported. Default implementation: { throw ESeekNotSupported; } Parameters: offset  is the wanted offset from the origin. origin  is the origin of the seek Returns: true if seek sucessfull. See also: ESeekNotSupported SeekOrigin getPos Reimplemented from NLMISC::IStream. Definition at line 177 of file mem_stream.cpp. References offset, sint, and sint32. Referenced by changeType(), CMessage(), NL3D::CParticleSystemShape::flushTextures(), getName(), NLNET::getNameOfMessageOrTransportClass(), NL3D::CParticleSystemShape::instanciatePS(), readType(), readTypeAtCurrentPos(), serialMessage(), and unlockSubMessage(). { switch (origin) { case begin: if (offset > (sint)length()) return false; if (offset < 0) return false; _BufPos=_Buffer.getPtr()+offset; break; case current: if (getPos ()+offset > (sint)length()) return false; if (getPos ()+offset < 0) return false; _BufPos+=offset; break; case end: if (offset < -(sint)length()) return false; if (offset > 0) return false; _BufPos=_Buffer.getPtr()+_Buffer.size()+offset; break; } return true; }

void NLMISC::CMemStream::serial (  ucstring &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 863 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::IStream::isReading(), len, NLMISC::SEPARATOR, NLMISC::CMemStream::serial(), NLMISC::CMemStream::serialBuffer(), sint, sint32, and uint8. { if ( _StringMode ) { sint32 len=0; // Read/Write the length. if(isReading()) { serial(len); b.resize(len); } else { len= b.size(); serial(len); } // Read/Write the string. for(sint i=0;i<len;i++) serialBuffer( (uint8*)&b[i], sizeof( sizeof(b[i]) ) ); char sep = SEPARATOR; serialBuffer( (uint8*)&sep, 1 ); } else { IStream::serial( b ); } }

void NLMISC::CMemStream::serial (  std::string &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 803 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), NLMISC::IStream::isXML(), len, nlassert, nlwarning, NLMISC::SEPARATOR, NLMISC::CMemStream::serial(), NLMISC::CMemStream::serialBuffer(), sint, sint32, and uint8. { if ( _StringMode ) { sint32 len=0; // Read/Write the length. if(isReading()) { serial(len); nlassert( len<1000000 ); // limiting string size b.resize(len); } else { len= b.size(); serial(len); } // Read/Write the string. for(sint i=0;i<len;i++) serialBuffer( (uint8*)&(b[i]), sizeof(b[i]) ); char sep = SEPARATOR; serialBuffer( (uint8*)&sep, 1 ); } else { if (isReading()) { if (sizeof(char) == 1 && !isXML()) { sint32 len=0; fastSerial(len); // nlassert( len<1000000 ); // limiting string size if (len>1000000) { nlwarning("Trying to serialize a string of %u character !", len); throw NLMISC::EStreamOverflow(); } b.resize(len); if (len > 0) { // can serial all in a single call to serialBuffer, since sizeof(char) == 1 serialBuffer((uint8 *) &b[0], len); } } else { IStream::serial( b ); } } else { IStream::serial( b ); } } }

void NLMISC::CMemStream::serial (  char &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 778 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), NLMISC::SEPARATOR, NLMISC::CMemStream::serialBuffer(), and uint8. { if ( _StringMode ) { char buff [2]; if ( isReading() ) { serialBuffer( (uint8*)buff, 2 ); b = buff[0]; } else { buff[0] = b; buff[1] = SEPARATOR; serialBuffer( (uint8*)buff, 2 ); } } else { fastSerial (b); } }

void NLMISC::CMemStream::serial (  bool &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 763 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), and NLMISC::CMemStream::serialBit(). { if ( _StringMode ) { serialBit(b); } else { fastSerial (b); } }

void NLMISC::CMemStream::serial (  double &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 743 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), readnumber, and writenumber. { if ( _StringMode ) { if ( isReading() ) { readnumber( b, double, 128, atof ); // } else { writenumber( b, "%f", 128 ); } } else { fastSerial (b); } }

void NLMISC::CMemStream::serial (  float &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 723 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), readnumber, and writenumber. { if ( _StringMode ) { if ( isReading() ) { readnumber( b, float, 128, atof ); // ? } else { writenumber( (double)b, "%f", 128 ); } } else { fastSerial (b); } }

void NLMISC::CMemStream::serial (  sint64 &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 703 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), NL_I64, readnumber, sint64, and writenumber. { if ( _StringMode ) { if ( isReading() ) { readnumber( b, sint64, 20, atoiInt64 ); // -9223372036854775808 } else { writenumber( b, "%"NL_I64"d", 20 ); } } else { fastSerial (b); } }

void NLMISC::CMemStream::serial (  uint64 &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 683 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), NL_I64, readnumber, uint64, and writenumber. { if ( _StringMode ) { if ( isReading() ) { readnumber( b, uint64, 20, atoiInt64 ); // 18446744073709551615 } else { writenumber( b, "%"NL_I64"u", 20 ); } } else { fastSerial (b); } }

void NLMISC::CMemStream::serial (  sint32 &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 663 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), readnumber, sint32, and writenumber. { if ( _StringMode ) { if ( isReading() ) { readnumber( b, sint32, 11, atoi ); // -2147483648 } else { writenumber( b, "%d", 11 ); } } else { fastSerial (b); } }

void NLMISC::CMemStream::serial (  uint32 &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 642 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::atoui(), NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), readnumber, uint32, and writenumber. { if ( _StringMode ) { if ( isReading() ) { readnumber( b, uint32, 10, atoui ); // 4294967295 } else { writenumber( b, "%u", 10 ); } } else { fastSerial (b); } }

void NLMISC::CMemStream::serial (  sint16 &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 622 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), readnumber, sint16, and writenumber. { if ( _StringMode ) { if ( isReading() ) { readnumber( b, sint16, 6, atoi ); // -32768 } else { writenumber( b, "%hd", 6 ); } } else { fastSerial (b); } }

void NLMISC::CMemStream::serial (  uint16 &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 601 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), readnumber, uint16, and writenumber. { if ( _StringMode ) { // No byte swapping in text mode if ( isReading() ) { readnumber( b, uint16, 5, atoi ); // 65535 } else { writenumber( b, "%hu", 5 ); } } else { fastSerial (b); } }

void NLMISC::CMemStream::serial (  sint8 &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 581 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), readnumber, sint16, sint8, and writenumber. { if ( _StringMode ) { if ( isReading() ) { readnumber( b, sint8, 4, atoi ); // -128 } else { writenumber( (sint16)b, "%hd", 4 ); } } else { fastSerial (b); } }

void NLMISC::CMemStream::serial (  uint8 &  b  )  [inline, virtual, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 561 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::CMemStream::fastSerial(), NLMISC::IStream::isReading(), readnumber, uint16, uint8, and writenumber. { if ( _StringMode ) { if ( isReading() ) { readnumber( b, uint8, 3, atoi ); // 255 } else { writenumber( (uint16)b,"%hu", 3 ); } } else { fastSerial (b); } }

template<class T0, class T1, class T2, class T3, class T4, class T5> void NLMISC::CMemStream::serial (  T0 &  a, T1 &  b, T2 &  c, T3 &  d, T4 &  e, T5 &  f )  [inline, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CStringStream. Definition at line 459 of file mem_stream.h. References NLMISC::CMemStream::serial(). { serial(a); serial(b); serial(c); serial(d); serial(e); serial(f);}

template<class T0, class T1, class T2, class T3, class T4> void NLMISC::CMemStream::serial (  T0 &  a, T1 &  b, T2 &  c, T3 &  d, T4 &  e )  [inline, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CStringStream. Definition at line 456 of file mem_stream.h. References NLMISC::CMemStream::serial(). { serial(a); serial(b); serial(c); serial(d); serial(e);}

template<class T0, class T1, class T2, class T3> void NLMISC::CMemStream::serial (  T0 &  a, T1 &  b, T2 &  c, T3 &  d )  [inline, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CStringStream. Definition at line 453 of file mem_stream.h. References NLMISC::CMemStream::serial(). { serial(a); serial(b); serial(c); serial(d);}

template<class T0, class T1, class T2> void NLMISC::CMemStream::serial (  T0 &  a, T1 &  b, T2 &  c )  [inline, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CStringStream. Definition at line 450 of file mem_stream.h. References NLMISC::CMemStream::serial(). { serial(a); serial(b); serial(c);}

template<class T0, class T1> void NLMISC::CMemStream::serial (  T0 &  a, T1 &  b )  [inline, inherited]

Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CStringStream. Definition at line 447 of file mem_stream.h. References NLMISC::CMemStream::serial(). { serial(a); serial(b);}

template<class T> void NLMISC::CMemStream::serial (  T &  obj  )  [inline, inherited]

Template serialisation (should take the one from IStream). Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 420 of file mem_stream.h. Referenced by NLNET::CPacsClient::addPrimitive(), NLNET::CUnifiedNetwork::addService(), NLNET::CCallbackNetBase::baseUpdate(), NLNET::cbAESConnection(), NLNET::cbClientGetUniversalTime(), NLNET::cbExecCommand(), NLNET::cbGetUniversalTime(), NLNET::cbnbMessageAskAssociations(), NLNET::cbnbMessageRecvAssociations(), NLNET::cbPacsAnswer(), NLNET::cbQueryPort(), NLNET::cbReceiveShardId(), NLNET::cbRegister(), NLNET::cbRegisterBroadcast(), NLNET::cbServerAskUniversalTime(), NLNET::cbServGetView(), NLNET::cbShardValidate(), NLNET::cbShardValidation(), NLNET::cbTCReceiveOtherSideClass(), NLNET::cbUnregisterBroadcast(), NLNET::cbWSChooseShard(), NLNET::cbWSDisconnectClient(), changeType(), NLNET::cleanRequest(), NLNET::CLoginServer::clientDisconnected(), NLNET::CCallbackClient::connect(), NLNET::CLoginClient::connectToShard(), NLNET::createMessage(), NLNET::CNetDisplayer::doDisplay(), NLNET::CPacsClient::evalCollision(), NLLOGIC::CLogicState::exitState(), NLNET::getNameOfMessageOrTransportClass(), NLNET::CPacsClient::getPositionSpeed(), NLNET::CPacsClient::globalMove(), NLNET::CPacsClient::rayTest(), readType(), readTypeAtCurrentPos(), NLNET::CNamingClient::registerService(), NLNET::CNamingClient::registerServiceWithSId(), NLNET::CPacsClient::relativeMove(), NLNET::CPacsClient::removePrimitive(), NLNET::CMessageRecorder::replayConnectionAttempt(), NLNET::CNamingClient::resendRegisteration(), NLNET::sendAdminEmail(), NLNET::CCallbackServer::sendAllMyAssociations(), NLNET::CPacsClient::sendMessage(), NLNET::TMessageRecord::serial(), NLMISC::CMemStream::serial(), NLNET::CInetAddress::serial(), NLMISC::CMemStream::serialBit(), serialMessage(), NLNET::CPacsClient::setAbsorption(), NLNET::CPacsClient::setCollisionMask(), NLNET::CPacsClient::setCurrentPrimitive(), NLNET::CPacsClient::setHeight(), NLNET::CPacsClient::setObstacle(), NLNET::CPacsClient::setOcclusionMask(), NLNET::CPacsClient::setOrientation(), NLNET::CPacsClient::setPrimitiveType(), NLNET::CPacsClient::setRadius(), NLNET::CPacsClient::setReactionType(), NLNET::CPacsClient::setSize(), NLNET::CPacsClient::setTriggerType(), setType(), NLNET::CPacsClient::testMove(), NLLOGIC::CLogicState::trySendEntryMessages(), NLLOGIC::CLogicState::trySendEventMessages(), NLNET::uncbServiceIdentification(), NLNET::CNamingClient::unregisterService(), NLNET::CUnifiedNetwork::update(), and NLNET::updateAdmin(). { obj.serial(*this); }

void NLMISC::CMemStream::serialBit (  bool &  bit  )  [virtual, inherited]

Method inherited from IStream. Implements NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 117 of file mem_stream.cpp. References NLMISC::IStream::isReading(), NLMISC::CMemStream::serial(), and uint8. Referenced by NLMISC::CMemStream::serial(). { /* if ( _StringMode ) { */ uint8 u; if ( isReading() ) { serial( u ); bit = (u!=0); } else { u = (uint8)bit; serial( u ); } /* } else { uint len = sizeof(uint8); uint8 thebuf; if ( isReading() ) { // Check that we don't read more than there is to read if ( lengthS()+len > length() ) // calls virtual length (cf. sub messages) { throw EStreamOverflow(); } // Serialize in memcpy( &thebuf, &(*_BufPos), len ); _BufPos += len; bit = (thebuf!=0); } else { thebuf = (uint8)bit; // Serialize out _Buffer.resize( _Buffer.size() + len ); _BufPos = _Buffer.end() - len; memcpy( &(*_BufPos), &thebuf, len ); _BufPos = _Buffer.end(); } }*/ }

uint16 NLMISC::IStream::serialBitField16 (  uint16  bf  )  [inline, inherited]

Serialisation of bitfield <=16 bits. Definition at line 332 of file stream_inline.h. References NLMISC::IStream::serial(), and uint16. { serial(bf); return bf; }

uint32 NLMISC::IStream::serialBitField32 (  uint32  bf  )  [inline, inherited]

Serialisation of bitfield <=32 bits. Definition at line 338 of file stream_inline.h. References NLMISC::IStream::serial(), and uint32. { serial(bf); return bf; }

uint8 NLMISC::IStream::serialBitField8 (  uint8  bf  )  [inline, inherited]

Serialisation of bitfield <=8 bits. Definition at line 326 of file stream_inline.h. References NLMISC::IStream::serial(), and uint8. Referenced by NL3D::CMaterial::CTexEnv::serial(). { serial(bf); return bf; }

void NLMISC::CMemStream::serialBuffer (  uint8 *  buf, uint  len )  [virtual, inherited]

Method inherited from IStream. Implements NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream. Definition at line 73 of file mem_stream.cpp. References NLMISC::CMemStream::_BufPos, NLMISC::CMemStream::increaseBufferIfNecessary(), NLMISC::IStream::isReading(), len, NLMISC::CMemStream::length(), NLMISC::CMemStream::lengthS(), nlassert, uint, and uint8. Referenced by NLMISC::CStringStream::serial(), NLNET::TMessageRecord::serial(), NLMISC::CMemStream::serial(), and serialMessage(). { // commented for optimum performance nlassert (len > 0); nlassert (buf != NULL); if ( isReading() ) { // Check that we don't read more than there is to read if ( lengthS()+len > length() ) // calls virtual length (cf. sub messages) { throw EStreamOverflow(); } // Serialize in CFastMem::memcpy( buf, _BufPos, len ); _BufPos += len; } else { // Serialize out increaseBufferIfNecessary (len); /* uint32 oldBufferSize = _Buffer.size(); if (_BufPos - _Buffer.getPtr() + len > oldBufferSize) { // need to increase the buffer size uint32 pos = _BufPos - _Buffer.getPtr(); _Buffer.resize(oldBufferSize*2 + len); _BufPos = _Buffer.getPtr() + pos; } */ CFastMem::memcpy( _BufPos, buf, len ); _BufPos += len; /* _Buffer.resize( size ); _BufPos = _Buffer.end() - len; CFastMem::memcpy( &(*_BufPos), buf, len ); _BufPos = _Buffer.end();*/ } }

virtual void NLMISC::IStream::serialBufferWithSize (  uint8 *  buf, uint32  len )  [inline, virtual, inherited]

This method first serializes the size of the buffer and after the buffer itself, it enables the possibility to serial with a serialCont() on the other side. Definition at line 877 of file stream.h. References len, NLMISC::IStream::serial(), NLMISC::IStream::serialBuffer(), uint32, and uint8. { serial (len); serialBuffer (buf, len); }

template<class T> void NLMISC::IStream::serialCheck (  const T &  value  )  [inline, inherited]

Serialize a check value. An object can stream a check value to check integrity or format of filed or streamed data. Just call serial check with a const value. Write will serial the value. Read will check the value is the same. If it is not, it will throw EInvalidDataStream exception. NB: The type of the value must implement an operator == and must be serializable. Parameters: value  the value used to the check. See also: EInvalidDataStream Definition at line 520 of file stream.h. References NLMISC::IStream::isReading(), NLMISC::IStream::serial(), value, NLMISC::IStream::xmlPop(), and NLMISC::IStream::xmlPush(). Referenced by NLNET::cbPacsAnswer(), NLNET::CPacsClient::initMessage(), loadForm(), NLLIGO::CZoneRegion::serial(), NLLIGO::CZoneBankElement::serial(), NL3D::CZone::serial(), NL3D::CVegetableShape::serial(), NL3D::CSkeletonWeight::serial(), NL3D::CInstanceGroup::serial(), NL3D::CLodCharacterShape::serial(), NL3D::CLodCharacterShapeBuild::serial(), NL3D::CAnimationSet::serial(), and NL3D::CAnimation::serial(). { // Open a node xmlPush ("CHECK"); if (isReading()) { T read; serial (read); if (read!=value) throw EInvalidDataStream(*this); } else { serial (const_cast<T&>(value)); } // Close the node xmlPop (); }

template<class T, class Allocator> void NLMISC::IStream::serialCont (  std::vector< T, Allocator > &  cont  )  [inline, inherited]

Specialisation of serialCont() for vector<bool>. Definition at line 324 of file stream.h. References NLMISC::IStream::serialVector(). Referenced by NL3D::H_AUTO_DECL(), NLAISCRIPT::CLdbHeapMemberiOpCode::load(), NLAISCRIPT::CLdbStackMemberiOpCode::load(), NLAISCRIPT::CLdbMemberiOpCode::load(), NLAISCRIPT::CCallMethodi::load(), NLAISCRIPT::CCallStackMethodi::load(), NLAISCRIPT::CCallHeapMethodi::load(), NLAISCRIPT::CLibStackMemberMethod::load(), NLAISCRIPT::CLibCallMethodi::load(), NLAISCRIPT::CLibMemberMethodi::load(), NLAISCRIPT::CAffMemberiOpCode::load(), NLAISCRIPT::CAffHeapMemberiOpCode::load(), NLAISCRIPT::CLoadHeapObject::load(), NLAISCRIPT::CLoadStackObject::load(), NLAISCRIPT::CLoadSelfObject::load(), NLMISC::CEntityIdTranslator::load(), NLSOUND::CBackgroundSoundManager::load(), loadForm(), NLAISCRIPT::CLdbHeapMemberiOpCode::save(), NLAISCRIPT::CLdbStackMemberiOpCode::save(), NLAISCRIPT::CLdbMemberiOpCode::save(), NLAISCRIPT::CCallMethodi::save(), NLAISCRIPT::CCallStackMethodi::save(), NLAISCRIPT::CCallHeapMethodi::save(), NLAISCRIPT::CLibStackMemberMethod::save(), NLAISCRIPT::CLibCallMethodi::save(), NLAISCRIPT::CLibMemberMethodi::save(), NLAISCRIPT::CAffMemberiOpCode::save(), NLAISCRIPT::CAffHeapMemberiOpCode::save(), NLAISCRIPT::CLoadHeapObject::save(), NLAISCRIPT::CLoadStackObject::save(), NLAISCRIPT::CLoadSelfObject::save(), NLMISC::CEntityIdTranslator::save(), NLLIGO::CZoneRegion::serial(), NLLIGO::CZoneBankElement::serial(), NL3D::CZone::serial(), NL3D::CVegetableShape::serial(), NL3D::CTileVegetableDesc::serial(), NL3D::CSkeletonWeight::serial(), NL3D::CInstanceGroup::serial(), NL3D::CInstanceGroup::CInstance::serial(), NLPACS::CRetrieverInstance::serial(), NLPACS::CRetrieverBank::serial(), NLPACS::CRetrievableSurface::TLoop::serial(), NLPACS::CRetrievableSurface::serial(), NL3D::CPrimitiveBlock::serial(), NL3D::CPortal::serial(), NL3D::CPointLightNamedArray::serial(), NL3D::CPatch::serial(), NLMISC::CNoiseColorGradient::serial(), NL3D::CMeshMRMSkinnedGeom::CRdrPass::serial(), NL3D::CMeshMRMSkinnedGeom::CPackedVertexBuffer::serial(), NL3D::CMeshMRMSkinnedGeom::serial(), NL3D::CMeshBase::CLightMapInfoList::serial(), NL3D::CMeshBase::CLightInfoMapListV7::serial(), NL3D::CMeshGeom::CMatrixBlock::serial(), NL3D::CMaterial::serial(), NL3D::CLodCharacterTexture::serial(), NL3D::CLodCharacterShapeBank::serial(), NL3D::CLodCharacterShape::serial(), NL3D::CLodCharacterShape::CBoneInfluence::serial(), NL3D::CLodCharacterShape::CAnim::serial(), NL3D::CLodCharacterShapeBuild::serial(), NLPACS::CLocalRetriever::CTopology::serial(), NLPACS::CLocalRetriever::CTip::serial(), NLPACS::CLocalRetriever::serial(), NL3D::CIGSurfaceLight::serial(), NL3D::CHLSTextureBank::serial(), NL3D::CHLSColorTexture::serial(), NL3D::CHLSColorTexture::CMask::serial(), NLPACS::CGlobalRetriever::serial(), NLPACS::CFaceGrid::serial(), NLPACS::CExteriorMesh::serial(), NLPACS::CEdgeQuad::serial(), NLPACS::CCollisionMeshBuild::serial(), NL3D::CCluster::serial(), NLPACS::CChain::serial(), NLPACS::COrderedChain::serial(), NLPACS::COrderedChain3f::serial(), NLMISC::CBitSet::serial(), CAutomataDesc::CState::serial(), NL3D::CAnimationSet::serial(), NL3D::CAnimation::serial(), NL3D::CMaterialBase::serial(), and NLMISC::ICommand::serialCommands(). {serialVector(cont);}

virtual void NLMISC::CMemStream::serialCont (  std::vector< bool > &  cont  )  [inline, virtual, inherited]

Specialisation of serialCont() for vector<bool>. Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 442 of file mem_stream.h. {IStream::serialCont(cont);}

virtual void NLMISC::CMemStream::serialCont (  std::vector< sint8 > &  cont  )  [inline, virtual, inherited]

Specialisation of serialCont() for vector<sint8>. Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 440 of file mem_stream.h. {IStream::serialCont(cont);}

virtual void NLMISC::CMemStream::serialCont (  std::vector< uint8 > &  cont  )  [inline, virtual, inherited]

Specialisation of serialCont() for vector<uint8>. Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 438 of file mem_stream.h. {IStream::serialCont(cont);}

template<class K, class T> void NLMISC::CMemStream::serialCont (  std::multimap< K, T > &  cont  )  [inline, inherited]

Specialisation of serialCont() for vector<bool>. Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 435 of file mem_stream.h. {IStream::serialCont(cont);}

template<class K, class T> void NLMISC::CMemStream::serialCont (  std::map< K, T > &  cont  )  [inline, inherited]

Specialisation of serialCont() for vector<bool>. Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 433 of file mem_stream.h. {IStream::serialCont(cont);}

template<class T> void NLMISC::CMemStream::serialCont (  std::multiset< T > &  cont  )  [inline, inherited]

Specialisation of serialCont() for vector<bool>. Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 431 of file mem_stream.h. {IStream::serialCont(cont);}

template<class T> void NLMISC::CMemStream::serialCont (  std::set< T > &  cont  )  [inline, inherited]

Specialisation of serialCont() for vector<bool>. Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 429 of file mem_stream.h. {IStream::serialCont(cont);}

template<class T> void NLMISC::CMemStream::serialCont (  std::deque< T > &  cont  )  [inline, inherited]

Specialisation of serialCont() for vector<bool>. Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 427 of file mem_stream.h. {IStream::serialCont(cont);}

template<class T> void NLMISC::CMemStream::serialCont (  std::list< T > &  cont  )  [inline, inherited]

Specialisation of serialCont() for vector<bool>. Reimplemented from NLMISC::IStream. Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 425 of file mem_stream.h. {IStream::serialCont(cont);}

template<class T> void NLMISC::CMemStream::serialCont (  std::vector< T > &  cont  )  [inline, inherited]

Reimplemented in NLMISC::CBitMemStream, and NLMISC::CStringStream. Definition at line 423 of file mem_stream.h. Referenced by NLNET::cbInfo(), NLNET::cbPacsAnswer(), NLNET::cbRegisterBroadcast(), NLNET::cleanRequest(), NLNET::CNamingClient::registerService(), NLNET::CNamingClient::registerServiceWithSId(), and NLNET::CNamingClient::resendRegisteration(). {IStream::serialCont(cont);}

template<class T> void NLMISC::IStream::serialContPolyPtr (  std::multiset< T > &  cont  )  [inline, inherited]

Serialize a check value. An object can stream a check value to check integrity or format of filed or streamed data. Just call serial check with a const value. Write will serial the value. Read will check the value is the same. If it is not, it will throw EInvalidDataStream exception. NB: The type of the value must implement an operator == and must be serializable. Parameters: value  the value used to the check. See also: EInvalidDataStream Definition at line 379 of file stream.h. References NLMISC::IStream::serialSTLContPolyPtr(). {serialSTLContPolyPtr(cont);}

template<class T> void NLMISC::IStream::serialContPolyPtr (  std::set< T > &  cont  )  [inline, inherited]

Serialize a check value. An object can stream a check value to check integrity or format of filed or streamed data. Just call serial check with a const value. Write will serial the value. Read will check the value is the same. If it is not, it will throw EInvalidDataStream exception. NB: The type of the value must implement an operator == and must be serializable. Parameters: value  the value used to the check. See also: EInvalidDataStream Definition at line 377 of file stream.h. References NLMISC::IStream::serialSTLContPolyPtr(). {serialSTLContPolyPtr(cont);}

template<class T> void NLMISC::IStream::serialContPolyPtr (  std::deque< T > &  cont  )  [inline, inherited]

Serialize a check value. An object can stream a check value to check integrity or format of filed or streamed data. Just call serial check with a const value. Write will serial the value. Read will check the value is the same. If it is not, it will throw EInvalidDataStream exception. NB: The type of the value must implement an operator == and must be serializable. Parameters: value  the value used to the check. See also: EInvalidDataStream Definition at line 375 of file stream.h. References NLMISC::IStream::serialSTLContPolyPtr(). {serialSTLContPolyPtr(cont);}

template<class T> void NLMISC::IStream::serialContPolyPtr (  std::list< T > &  cont  )  [inline, inherited]

Serialize a check value. An object can stream a check value to check integrity or format of filed or streamed data. Just call serial check with a const value. Write will serial the value. Read will check the value is the same. If it is not, it will throw EInvalidDataStream exception. NB: The type of the value must implement an operator == and must be serializable. Parameters: value  the value used to the check. See also: EInvalidDataStream Definition at line 373 of file stream.h. References NLMISC::IStream::serialSTLContPolyPtr(). {serialSTLContPolyPtr(cont);}

template<class T, class Allocator> void NLMISC::IStream::serialContPolyPtr (  std::vector< T, Allocator > &  cont  )  [inline, inherited]

Serialize a check value. An object can stream a check value to check integrity or format of filed or streamed data. Just call serial check with a const value. Write will serial the value. Read will check the value is the same. If it is not, it will throw EInvalidDataStream exception. NB: The type of the value must implement an operator == and must be serializable. Parameters: value  the value used to the check. See also: EInvalidDataStream Definition at line 371 of file stream.h. References NLMISC::IStream::serialVectorPolyPtr(). Referenced by NL3D::CAnimation::serial(). {serialVectorPolyPtr(cont);}

template<class T> void NLMISC::IStream::serialContPtr (  std::multiset< T > &  cont  )  [inline, inherited]

Definition at line 362 of file stream.h. References NLMISC::IStream::serialSTLContPtr(). {serialSTLContPtr(cont);}

template<class T> void NLMISC::IStream::serialContPtr (  std::set< T > &  cont  )  [inline, inherited]

Definition at line 360 of file stream.h. References NLMISC::IStream::serialSTLContPtr(). {serialSTLContPtr(cont);}

template<class T> void NLMISC::IStream::serialContPtr (  std::deque< T > &  cont  )  [inline, inherited]

Definition at line 358 of file stream.h. References NLMISC::IStream::serialSTLContPtr(). {serialSTLContPtr(cont);}

template<class T> void NLMISC::IStream::serialContPtr (  std::list< T > &  cont  )  [inline, inherited]

Definition at line 356 of file stream.h. References NLMISC::IStream::serialSTLContPtr(). {serialSTLContPtr(cont);}

template<class T, class Allocator> void NLMISC::IStream::serialContPtr (  std::vector< T, Allocator > &  cont  )  [inline, inherited]

Definition at line 354 of file stream.h. References NLMISC::IStream::serialVectorPtr(). Referenced by NL3D::CAnimationSet::serial(). {serialVectorPtr(cont);}

template<class T> void NLMISC::IStream::serialEnum (  T &  em  )  [inline, inherited]

Template enum serialisation. Serialized as a sint32. Definition at line 261 of file stream.h. References NLMISC::IStream::isReading(), NLMISC::IStream::serial(), and sint32. Referenced by NLNET::cbTCReceiveOtherSideClass(), NL3D::CVegetableShape::serial(), NL3D::CVegetable::serial(), NLPACS::CRetrieverInstance::serial(), NL3D::CPointLight::serial(), NL3D::CMaterial::serial(), NLPACS::CLocalRetriever::serial(), NLMISC::CSerialCommand::serial(), and NL3D::CAnimationPlaylist::serial(). { sint32 i; if(isReading()) { serial(i); em = (T)i; } else { i = em; serial(i); } }

void NLMISC::CMemStream::serialHex (  uint32 &  b  )  [inline, virtual, inherited]

Serialisation in hexadecimal. Reimplemented in NLMISC::CStringStream. Definition at line 929 of file mem_stream.h. References NLMISC::CMemStream::_StringMode, NLMISC::atoihex(), NLMISC::IStream::isReading(), readnumber, uint32, and writenumber. Referenced by NLNET::TMessageRecord::serial(). { if ( _StringMode ) { if ( isReading() ) { readnumber( b, uint32, 10, atoihex ); // 4294967295 } else { writenumber( b, "%x", 10 ); } } else { IStream::serial( b ); } }

void NLMISC::IStream::serialMemStream (  CMemStream &  b  )  [virtual, inherited]

Serial memstream, bitmemstream... Definition at line 436 of file stream.cpp. References NLMISC::CMemStream::buffer(), NLMISC::CMemStream::bufferToFill(), NLMISC::IStream::isReading(), len, NLMISC::CMemStream::length(), NLMISC::CMemStream::resetBufPos(), NLMISC::IStream::serial(), NLMISC::IStream::serialBuffer(), uint32, and uint8. { uint32 len=0; // Serialize length if ( isReading() ) { // fill b with data from this serial (len); serialBuffer (b.bufferToFill (len), len); b.resetBufPos (); } else { // fill this with data from b len = b.length(); serial( len ); serialBuffer( (uint8*) b.buffer (), len ); } }

void NLNET::CMessage::serialMessage (  CMessage &  msg  )

Encapsulate/decapsulate another message inside the current message. Definition at line 472 of file message.cpp. References NLMISC::CMemStream::buffer(), NLMISC::CMemStream::bufferToFill(), invert(), NLMISC::IStream::isReading(), len, length(), readType(), NLMISC::CMemStream::seek(), NLMISC::CMemStream::serial(), NLMISC::CMemStream::serialBuffer(), and uint32. { if ( isReading() ) { // Init 'msg' with the contents serialised from 'this' uint32 len; serial( len ); if ( ! msg.isReading() ) msg.invert(); serialBuffer( msg.bufferToFill( len ), len ); msg.readType(); msg.invert(); msg.seek( 0, CMemStream::end ); } else { // Store into 'this' the contents of 'msg' uint32 len = msg.length(); serial( len ); serialBuffer( const_cast<uint8*>(msg.buffer()), msg.length() ); } }

template<class T> void NLMISC::IStream::serialPolyPtr (  T *&  ptr  )  [inline, inherited]

Serialize Polymorphic Objet Ptr. Works with NULL pointers. If the same object is found mutliple time in the stream, ONLY ONE instance is written! NB: The ptr is serialised as a uint64 (64 bit compliant). Parameters: ptr  a pointer on a IStreamable object. See also: resetPtrTable() Definition at line 492 of file stream.h. References NLMISC::IStream::serialIStreamable(). Referenced by NL3D::CAnimationOptimizer::cloneTrack(), NL3D::CMaterial::CLightMap::serial(), NL3D::CMaterial::serial(), NL3D::CMaterialBase::CAnimatedTexture::serial(), NL3D::CMaterial::CLightMap::serial2(), and NLMISC::IStream::serialSTLContLenPolyPtr(). { IStreamable *p=ptr; serialIStreamable(p); ptr= static_cast<T*>(p);}

template<class T> void NLMISC::IStream::serialPtr (  T *&  ptr  )  [inline, inherited]

Serialize Non Polymorphic Objet Ptr. Works with NULL pointers. If the same object is found mutliple time in the stream, ONLY ONE instance is written! NB: The ptr is serialised as a uint64 (64 bit compliant). Parameters: ptr  a pointer on a base type or an object. See also: resetPtrTable() Definition at line 390 of file stream.h. References NLMISC::IStream::_IdMap, NLMISC::IStream::_NextSerialPtrId, NLMISC::IStream::isReading(), NLMISC::IStream::ItIdMap, NLMISC::IStream::serial(), uint, uint64, NLMISC::IStream::ValueIdMap, NLMISC::IStream::xmlPop(), NLMISC::IStream::xmlPushBegin(), NLMISC::IStream::xmlPushEnd(), and NLMISC::IStream::xmlSetAttrib(). Referenced by NL3D::CParticleSystemShape::buildFromPS(), NL3D::CParticleSystemShape::flushTextures(), NL3D::CParticleSystemShape::instanciatePS(), and NLMISC::IStream::serialSTLContLenPtr(). { uint64 node; // Open the node header xmlPushBegin ("PTR"); xmlSetAttrib ("id"); if(isReading()) { serial(node); // Close the header xmlPushEnd (); if(node==0) ptr=NULL; else { ItIdMap it; it= _IdMap.find(node); // Test if object already created/read. if( it==_IdMap.end() ) { // Construct object. ptr= new T; if(ptr==NULL) throw EStream(); // Insert the node. _IdMap.insert( ValueIdMap(node, ptr) ); // Read the object! serial(*ptr); } else ptr= static_cast<T*>(it->second); } } else { if(ptr==NULL) { node= 0; serial(node); // Close the header xmlPushEnd (); } else { ItIdMap it; it = _IdMap.find((uint64)(uint)ptr); // Test if object has been already written if( it==_IdMap.end() ) { // Not yet written // Get the next available ID node = _NextSerialPtrId++; // Serial the id serial(node); // Insert the pointer in the map with the id _IdMap.insert( ValueIdMap((uint64)(uint)ptr, (void*)(uint)node) ); // Close the header xmlPushEnd (); // Write the object serial(*ptr); } else { // Write only the object id node = (uint64)(uint)(it->second); serial(node); // Close the header xmlPushEnd (); } } } // Close the node xmlPop (); }

uint NLMISC::CMemStream::serialSeparatedBufferIn (  uint8 *  buf, uint  len )  [inherited]

Input: read len bytes at most from the stream until the next separator, and return the number of bytes read. The separator is then skipped. Reimplemented in NLMISC::CStringStream. Definition at line 307 of file mem_stream.cpp. References NLMISC::CMemStream::_BufPos, NLMISC::CMemStream::_StringMode, NLMISC::CObjectVector< uint8, false >::getPtr(), NLMISC::IStream::isReading(), len, NLMISC::CMemStream::length(), NLMISC::CMemStream::lengthS(), nlassert, NLMISC::SEP_SIZE, NLMISC::SEPARATOR, NLMISC::CObjectVector< uint8, false >::size(), uint, uint32, and uint8. { nlassert( _StringMode && isReading() ); // Check that we don't read more than there is to read if ( ( _BufPos == _Buffer.getPtr()+_Buffer.size() ) || // we are at the end ( lengthS()+len+SEP_SIZE > length() ) && (_Buffer[_Buffer.size()-1] != SEPARATOR ) ) // we are before the end // calls virtual length (cf. sub messages) { throw EStreamOverflow(); } // Serialize in uint32 i = 0; while ( (i<len) && (*_BufPos) != SEPARATOR ) { *(buf+i) = *_BufPos; i++; _BufPos++; } // Exceeds len if ( (*_BufPos) != SEPARATOR ) { throw EStreamOverflow(); } _BufPos += SEP_SIZE; return i; }

void NLMISC::CMemStream::serialSeparatedBufferOut (  uint8 *  buf, uint  len )  [inherited]

Output: writes len bytes from buf into the stream. Reimplemented in NLMISC::CStringStream. Definition at line 338 of file mem_stream.cpp. References NLMISC::CMemStream::_BufPos, NLMISC::CMemStream::_StringMode, NLMISC::CObjectVector< uint8, false >::getPtr(), NLMISC::IStream::isReading(), len, nlassert, NLMISC::CObjectVector< uint8, false >::resize(), NLMISC::SEP_SIZE, NLMISC::SEPARATOR, NLMISC::CObjectVector< uint8, false >::size(), uint, uint32, and uint8. { nlassert( _StringMode && (!isReading()) ); // Serialize out uint32 oldBufferSize = _Buffer.size(); if (_BufPos - _Buffer.getPtr() + (len + SEP_SIZE) > oldBufferSize) { // need to increase the buffer size _Buffer.resize(oldBufferSize*2 + len + SEP_SIZE); _BufPos = _Buffer.getPtr() + oldBufferSize; } CFastMem::memcpy( _BufPos, buf, len ); _BufPos += len; *(_BufPos++) = SEPARATOR; // Serialize out /* _Buffer.resize( _Buffer.size() + len + SEP_SIZE ); _BufPos = _Buffer.end() - len - SEP_SIZE; CFastMem::memcpy( &(*_BufPos), buf, len ); _Buffer[_Buffer.size()-1] = SEPARATOR; _BufPos = _Buffer.end(); */}

template<class T> void NLMISC::IStream::serialVector (  T &  cont  )  [inline, protected, inherited]

special version for serializing a vector. Support up to sint32 length containers. Definition at line 992 of file stream.h. References NLMISC::contReset(), NLMISC::IStream::isReading(), len, NLMISC::IStream::serial(), sint, sint32, NLMISC::IStream::xmlPop(), NLMISC::IStream::xmlPush(), NLMISC::IStream::xmlPushBegin(), NLMISC::IStream::xmlPushEnd(), and NLMISC::IStream::xmlSetAttrib(). Referenced by NLMISC::CStringStream::serialCont(), NLMISC::IStream::serialCont(), and NLMISC::CBitMemStream::serialCont(). { typedef typename T::value_type __value_type; typedef typename T::iterator __iterator; // Open a node header xmlPushBegin ("VECTOR"); // Attrib size xmlSetAttrib ("size"); sint32 len=0; if(isReading()) { serial(len); // Open a node header xmlPushEnd (); // special version for vector: adjut good size. contReset(cont); cont.resize (len); // Read the vector for(sint i=0;i<len;i++) { xmlPush ("ELM"); serial(cont[i]); xmlPop (); } } else { len= cont.size(); serial(len); // Close the node header xmlPushEnd (); // Write the vector __iterator it= cont.begin(); for(sint i=0;i<len;i++, it++) { xmlPush ("ELM"); serial(const_cast<__value_type&>(*it)); xmlPop (); } } // Close the node xmlPop (); }

uint NLMISC::IStream::serialVersion (  uint  currentVersion  )  [inherited]

Serialize a version number. Each object should store/read first a version number, using this method. Then he can use the streamVersion returned to see how he should serialise himself. NB: Version Number is read/store as a uint8, or uint32 if too bigger.. Parameters: currentVersion  the current version of the class, provided by user. Returns: the version of the stream. If the stream is an Output stream, currentVersion is returned. See also: setVersionException() getVersionException() Definition at line 266 of file stream.cpp. References NLMISC::IStream::_ThrowOnNewer, NLMISC::IStream::_ThrowOnOlder, NLMISC::IStream::isReading(), NLMISC::IStream::serial(), uint, uint32, uint8, v, NLMISC::IStream::xmlPop(), and NLMISC::IStream::xmlPush(). Referenced by NL3D::H_AUTO_DECL(), NLMISC::CEntityIdTranslator::load(), loadForm(), NLMISC::CEntityIdTranslator::save(), NLLIGO::CZoneRegion::serial(), NLLIGO::CZoneRegion::SZoneUnit2::serial(), NLLIGO::CZoneBankElement::serial(), NL3D::CZone::serial(), NL3D::CPatchInfo::CBindInfo::serial(), NL3D::CZone::CPatchConnect::serial(), NL3D::CBorderVertex::serial(), NL3D::CVertexBuffer::serial(), NL3D::CVegetableShape::serial(), NL3D::CVegetable::serial(), NL3D::CTrackSampledVector::serial(), NL3D::CTrackSampledQuat::serial(), NL3D::CTrackSampledCommon::CTimeBlock::serial(), NL3D::CTileVegetableDesc::serial(), NL3D::CTileNoiseMap::serial(), NL3D::CTileNoise::serial(), NLPACS::CSurfaceQuadTree::serial(), NL3D::CSurfaceLightGrid::CCellCorner::serial(), NL3D::CSurfaceLightGrid::serial(), NL3D::CSkeletonWeight::CNode::serial(), NL3D::CSkeletonWeight::serial(), NL3D::CInstanceGroup::serial(), NL3D::CInstanceGroup::CInstance::serial(), NLPACS::CRetrieverInstance::serial(), NLPACS::CRetrieverBank::serial(), NLPACS::CRetrievableSurface::serial(), NL3D::CPSAttrib< T >::serial(), NL3D::CPrimitiveBlock::serial(), NL3D::CPortal::serial(), NL3D::CPointLightNamedArray::CPointLightGroup::serial(), NL3D::CPointLightNamedArray::serial(), NL3D::CPointLightNamed::serial(), NL3D::CPointLight::serial(), NL3D::CPatch::serial(), NLMISC::CNoiseColorGradient::serial(), NLMISC::CNoiseValue::serial(), NL3D::CMeshMRMSkinnedGeom::CRdrPass::serial(), NL3D::CMeshMRMSkinnedGeom::CShadowVertex::serial(), NL3D::CMeshMRMSkinnedGeom::CPackedVertexBuffer::CPackedVertex::serial(), NL3D::CMeshMRMSkinnedGeom::CPackedVertexBuffer::serial(), NL3D::CMeshMRMSkinned::serial(), NL3D::CMeshMRMSkinnedGeom::serial(), NL3D::CMeshMRMGeom::CLodInfo::serial(), NL3D::CMeshMRMGeom::CRdrPass::serial(), NL3D::CMeshMRMGeom::CShadowVertex::serial(), NL3D::CMeshBase::CLightMapInfoList::serial(), NL3D::CMeshBase::CLightMapInfoList::CMatStage::serial(), NL3D::CMeshGeom::CMatrixBlock::serial(), NL3D::CMeshGeom::CRdrPass::serial(), NLMISC::CMatrix::serial(), NL3D::CMaterial::serial(), NL3D::CLodCharacterTexture::serial(), NL3D::CLodCharacterShapeBank::serial(), NL3D::CLodCharacterShape::serial(), NL3D::CLodCharacterShape::CBoneInfluence::serial(), NL3D::CLodCharacterShape::CAnim::serial(), NL3D::CLodCharacterShapeBuild::serial(), NLPACS::CLocalRetriever::serial(), NL3D::CIGSurfaceLight::CRetrieverLightGrid::serial(), NL3D::CIGSurfaceLight::serial(), NL3D::CHLSTextureBank::CTextureInstance::serial(), NL3D::CHLSTextureBank::serial(), NL3D::CHLSColorTexture::serial(), NL3D::CHLSColorTexture::CMask::serial(), NL3D::CHLSColorDelta::serial(), NLPACS::CGlobalRetriever::serial(), NLPACS::CFaceGrid::serial(), NLPACS::CExteriorMesh::serial(), NLPACS::CEdgeQuad::serial(), NL3D::CCluster::serial(), NLPACS::CChainQuad::serial(), NLPACS::CChain::serial(), NLPACS::COrderedChain::serial(), NLPACS::COrderedChain3f::serial(), NL3D::CBoneBase::serial(), NLMISC::CBitSet::serial(), NL3D::CAnimationSet::serial(), NL3D::CAnimationPlaylist::serial(), NL3D::CAnimation::serial(), NL3D::CMaterialBase::CTexAnimTracks::serial(), NL3D::CMaterialBase::serial(), NLMISC::CAABBox::serial(), NL3D::CMaterial::CLightMap::serial2(), NL3D::CTrackSampledCommon::serialCommon(), NL3D::CVertexBuffer::serialHeader(), NL3D::CMeshMRMGeom::serialLodVertexData(), and NL3D::CVertexBuffer::serialSubset(). { uint8 b=0; uint32 v=0; uint streamVersion; // Open the node xmlPush ("VERSION"); if(isReading()) { serial(b); if(b==0xFF) serial(v); else v=b; streamVersion=v; // Exception test. if(_ThrowOnOlder && streamVersion < currentVersion) throw EOlderStream(*this); if(_ThrowOnNewer && streamVersion > currentVersion) throw ENewerStream(*this); } else { v= streamVersion=currentVersion; if(v>=0xFF) { b=0xFF; serial(b); serial(v); } else { b= (uint8)v; serial(b); } } // Close the node xmlPop (); return streamVersion; }

void NLNET::CMessage::setDefaultStringMode (  bool  stringmode  )  [inline, static]

Set default stream mode. Definition at line 231 of file message.h. References _DefaultStringMode. { _DefaultStringMode = stringmode; }

void NLMISC::IStream::setInOut (  bool  inputStream  )  [protected, inherited]

Change, in live, the state of the inputStream. This could be usefull in certain case. The deriver which would want to do such a thing must call this method, and implement his own behavior. In certain case, it should call resetPtrTable() if he want to reset the stream ptr info (maybe always)... Definition at line 413 of file stream.cpp. References NLMISC::IStream::_InputStream. Referenced by NLMISC::CBitMemStream::getSerialItem(), and NLMISC::CMemStream::invert(). { _InputStream= inputStream; }

void NLMISC::CMemStream::setStringMode (  bool  stringmode  )  [inline, inherited]

Set string mode. Definition at line 113 of file mem_stream.h. References NLMISC::CMemStream::_StringMode. Referenced by init(). { _StringMode = stringmode; }

void NLNET::CMessage::setType (  const std::string &  name  )

Sets the message type as a string and put it in the buffer if we are in writing mode. Definition at line 229 of file message.cpp. References _HeaderSize, _TypeSet, format, FormatLong, FormatShort, NLMISC::CMemStream::getPos(), NLMISC::IStream::isReading(), nlassert, NLMISC::CMemStream::serial(), NLMISC::CStringIdArray::TStringId, TypeHasAName, TypeHasAnId, uint32, and uint8. { // check if we already do a setType () nlassert (!_TypeSet); // don't accept empty string nlassert (!name.empty ()); _Name = name; TypeHasAnId = false; TypeHasAName = true; if (!isReading ()) { // check if they don't already serial some stuffs nlassert (length () == 0); // if we can send the id instead of the string, "just do it" (c)nike! //NLMISC::CStringIdArray::TStringId id = _SIDA->getId (name); // PATCH: always send in full text NLMISC::CStringIdArray::TStringId id = -1; // Force binary mode for header bool msgmode = _StringMode; _StringMode = false; // debug features, we number all packet to be sure that they are all sent and received // \todo remove this debug feature when ok // this value will be fill after in the callback function uint32 zeroValue = 123; serial (zeroValue); if (id == -1) { uint8 format = FormatLong | (msgmode << 1); //nldebug( "OUT format = %hu", (uint16)format ); serial (format); // End of binary header _StringMode = msgmode; serial ((std::string&)name); } else { uint8 format = FormatShort | (msgmode << 1); //nldebug( "MSG: OUT format = %hu", (uint16)format ); serial (format); // End of binary header _StringMode = msgmode; serial (id); _Id = id; TypeHasAnId = true; } _HeaderSize = getPos (); } _TypeSet = true; }

void NLNET::CMessage::setType (  NLMISC::CStringIdArray::TStringId  id  )

Sets the message type as a number (in range 0..32767) and put it in the buffer if we are in writing mode. Definition at line 173 of file message.cpp. References _HeaderSize, _SIDA, _TypeSet, format, FormatLong, NLMISC::CMemStream::getPos(), NLMISC::CStringIdArray::getString(), NLMISC::IStream::isReading(), nlassert, nlstop, NLMISC::CMemStream::serial(), NLMISC::CStringIdArray::TStringId, TypeHasAName, TypeHasAnId, uint32, and uint8. Referenced by init(), NLNET::CPacsClient::initMessage(), and readType(). { // PATCH: the id system is not available nlstop; // check if we already do a setType () nlassert (!_TypeSet); // don't accept negative value nlassert (id >= 0 && id < pow(2, sizeof (NLMISC::CStringIdArray::TStringId)*8)); _Id = id; TypeHasAnId = true; TypeHasAName = false; if (!isReading ()) { // check if they don't already serial some stuffs nlassert (length () == 0); uint8 format = FormatLong | (_StringMode << 1); //nlinfo( "MSG: OUT format = %hu", (uint16)format ); // Force binary mode for header bool msgmode = _StringMode; _StringMode = false; // debug features, we number all packet to be sure that they are all sent and received // \todo remove this debug feature when ok // this value will be fill after in the callback function uint32 zeroValue = 123; serial (zeroValue); serial (format); // End of binary header _StringMode = msgmode; serial (id); _HeaderSize = getPos (); } else { // we set the id, now, we try to set the name if available in the sida if (_SIDA != NULL) { _Name = _SIDA->getString (id); TypeHasAName = true; } } _TypeSet = true; }

void NLMISC::IStream::setVersionException (  bool  throwOnOlder, bool  throwOnNewer )  [static, inherited]

Set the behavior of IStream regarding input stream that are older/newer than the class. If throwOnOlder==true, IStream throws a EOlderStream when needed. If throwOnNewer==true, IStream throws a ENewerStream when needed. By default, the behavior is throwOnOlder=false, throwOnNewer=true. See also: serialVersion() getVersionException() Definition at line 71 of file stream.cpp. References NLMISC::IStream::_ThrowOnNewer, and NLMISC::IStream::_ThrowOnOlder. { _ThrowOnOlder=throwOnOlder; _ThrowOnNewer=throwOnNewer; }

void NLMISC::IStream::setXMLMode (  bool  on  )  [protected, inherited]

Set the XML mode is true to enable XML mode else false Definition at line 427 of file stream.cpp. References NLMISC::IStream::_XML. Referenced by NLMISC::COXml::COXml(), and NLMISC::COXml::init(). { _XML = on; }

uint32 NLMISC::CMemStream::size (   )  const [inline, inherited]

Returns the size of the buffer (can be greater than the length, especially in output mode). Definition at line 230 of file mem_stream.h. References NLMISC::CObjectVector< uint8, false >::size(), and uint32. Referenced by NLMISC::CMemStream::lengthR(). { return _Buffer.size(); }

bool NLMISC::CMemStream::stringMode (   )  const [inline, inherited]

Return string mode. Definition at line 116 of file mem_stream.h. References NLMISC::CMemStream::_StringMode. Referenced by NLNET::TMessageRecord::serial(), and NLNET::CInetAddress::serial(). { return _StringMode; }

std::string NLNET::CMessage::toString (   )  const

Returns a readable string to display it to the screen. It's only for debugging purpose! Don't use it for anything else than to debugging, the string format could change in the futur Definition at line 441 of file message.cpp. References _SIDA, _TypeSet, NLMISC::CStringIdArray::getId(), NLMISC::CStringIdArray::getString(), nlassert, NLMISC::toString(), TypeHasAName, and TypeHasAnId. Referenced by NLNET::CCallbackNetBase::processOneMessage(). { nlassert (_TypeSet); // std::stringstream s; // if (TypeHasAName && TypeHasAnId) s << "('" << _Name << "'," << _Id << ")"; // else if (TypeHasAName) s << "('" << _Name << "'," << _SIDA->getId (_Name, true) << ")"; // else if (TypeHasAnId) s << "('" << _SIDA->getString (_Id) << "'," << _Id << "')"; // return s.str(); std::string str; if (TypeHasAName && TypeHasAnId) str += "('" + _Name + "'," + NLMISC::toString(_Id) + ")"; else if (TypeHasAName) str += "('" + _Name + "'," + NLMISC::toString(_SIDA->getId (_Name, true)) + ")"; else if (TypeHasAnId) str += "('" + _SIDA->getString (_Id) + "'," + NLMISC::toString(_Id) + "')"; return str; }

bool NLNET::CMessage::typeIsSet (   )  const

Definition at line 392 of file message.cpp. References _TypeSet. { return _TypeSet; }

void NLNET::CMessage::unlockSubMessage (   )  [inline]

Exit from sub message locking, and skip the whole sub message. Preconditions: The message is an input message (isReading()) and has been locked using lockSubMessage() The reading pos is within or at the end of the previous sub message (if any) (see nlassertex) Postconditions: The current pos is the next byte after the sub message Definition at line 164 of file message.h. References _LengthR, getName(), NLMISC::CMemStream::getPos(), hasLockedSubMessage(), NLMISC::IStream::isReading(), nlassert, nlassertex, resetSubMessageInternals(), NLMISC::CMemStream::seek(), sint32, and uint32. { nlassert( isReading() && hasLockedSubMessage() ); nlassertex( getPos() <= (sint32)_LengthR, ("The callback for msg %s read more data than there is in the message (pos=%d len=%u)", getName().c_str(), getPos(), _LengthR) ); uint32 subMsgEndPos = _LengthR; resetSubMessageInternals(); seek( subMsgEndPos, IStream::begin ); }

bool NLMISC::IStream::xmlBreakLine (   )  [inline, inherited]

xmlBreakLine() insert a break line in the XML stream. Returns: true if the break line is added, return false if no node is opened. Definition at line 794 of file stream.h. References NLMISC::IStream::_XML, and NLMISC::IStream::xmlBreakLineInternal(). { // XML Mode ? if (_XML) { return xmlBreakLineInternal (); } // Return ok return true; }

virtual bool NLMISC::IStream::xmlBreakLineInternal (   )  [inline, protected, virtual, inherited]

xmlBreakLine implementation Reimplemented in NLMISC::COXml. Definition at line 845 of file stream.h. Referenced by NLMISC::IStream::xmlBreakLine(). { return true; };

bool NLMISC::IStream::xmlComment (  const char *  comment  )  [inline, inherited]

xmlComment() insert a comment line in the XML stream. Returns: true if the comment is added, return false if no node is opened. Definition at line 811 of file stream.h. References NLMISC::IStream::_XML, comment(), and NLMISC::IStream::xmlCommentInternal(). { // XML Mode ? if (_XML) { return xmlCommentInternal (comment); } // Return ok return true; }

virtual bool NLMISC::IStream::xmlCommentInternal (  const char *  comment  )  [inline, protected, virtual, inherited]

xmlComment implementation Reimplemented in NLMISC::COXml. Definition at line 848 of file stream.h. Referenced by NLMISC::IStream::xmlComment(). { return true; };

bool NLMISC::IStream::xmlPop (   )  [inline, inherited]

xmlPop() close the node. Returns: true if you can close the node, false if the node can't be closed (its header is still opened) or if there is no node to close. Definition at line 759 of file stream.h. References NLMISC::IStream::_XML, and NLMISC::IStream::xmlPopInternal(). Referenced by NLLIGO::CZoneRegion::serial(), NLLIGO::CZoneBankElement::serial(), NL3D::CZone::serial(), NL3D::CPatch::serial(), NLMISC::CObjectVector< sint8, false >::serial(), NLMISC::COXml::serial(), NLMISC::COXml::serialBuffer(), NLMISC::IStream::serialCheck(), NLMISC::IStream::serialIStreamable(), NLMISC::IStream::serialMap(), NLMISC::IStream::serialMultimap(), NLMISC::IStream::serialPtr(), NLMISC::IStream::serialSTLCont(), NLMISC::IStream::serialSTLContLen(), NLMISC::IStream::serialSTLContPtr(), NLMISC::IStream::serialVector(), NLMISC::IStream::serialVectorPolyPtr(), NLMISC::IStream::serialVectorPtr(), NLMISC::IStream::serialVersion(), and NLMISC::IStream::xmlSerial(). { // XML Mode ? if (_XML) { return xmlPopInternal (); } // Return ok return true; }

virtual bool NLMISC::IStream::xmlPopInternal (   )  [inline, protected, virtual, inherited]

xmlPop implementation Reimplemented in NLMISC::COXml. Definition at line 839 of file stream.h. Referenced by NLMISC::IStream::xmlPop(). { return true; };

bool NLMISC::IStream::xmlPush (  const char *  name  )  [inline, inherited]

Definition at line 701 of file stream.h. References NLMISC::IStream::_XML, res, NLMISC::IStream::xmlPushBeginInternal(), and NLMISC::IStream::xmlPushEndInternal(). Referenced by NLLIGO::CZoneRegion::serial(), NLLIGO::CZoneBankElement::serial(), NL3D::CZone::serial(), NL3D::CPatch::serial(), NLMISC::CObjectVector< sint8, false >::serial(), NLMISC::COXml::serial(), NLMISC::COXml::serialBuffer(), NLMISC::IStream::serialCheck(), NLMISC::IStream::serialMap(), NLMISC::IStream::serialMultimap(), NLMISC::IStream::serialSTLContLen(), NLMISC::IStream::serialVector(), NLMISC::IStream::serialVersion(), and NLMISC::IStream::xmlSerial(). { // XML Mode ? if (_XML) { // Open the header bool res=xmlPushBeginInternal (name); if (res) // close the header xmlPushEndInternal (); // Return the result return res; } // Return ok return true; }

bool NLMISC::IStream::xmlPushBegin (  const char *  name  )  [inline, inherited]

xmlBreakLine() insert a break line in the XML stream. Returns: true if the break line is added, return false if no node is opened. Definition at line 725 of file stream.h. References NLMISC::IStream::_XML, and NLMISC::IStream::xmlPushBeginInternal(). Referenced by NLMISC::CObjectVector< sint8, false >::serial(), NLMISC::IStream::serialIStreamable(), NLMISC::IStream::serialMap(), NLMISC::IStream::serialMultimap(), NLMISC::IStream::serialPtr(), NLMISC::IStream::serialSTLCont(), NLMISC::IStream::serialSTLContPtr(), NLMISC::IStream::serialVector(), NLMISC::IStream::serialVectorPolyPtr(), and NLMISC::IStream::serialVectorPtr(). { // XML Mode ? if (_XML) { return xmlPushBeginInternal (name); } // Return ok return true; }

virtual bool NLMISC::IStream::xmlPushBeginInternal (  const char *  name  )  [inline, protected, virtual, inherited]

xmlPushBegin implementation Reimplemented in NLMISC::COXml. Definition at line 833 of file stream.h. Referenced by NLMISC::IStream::xmlPush(), and NLMISC::IStream::xmlPushBegin(). { return true; };

bool NLMISC::IStream::xmlPushEnd (   )  [inline, inherited]

xmlPushEnd() close the node header. Returns: true if you can close the node header, false if no node header have been opened with xmlPushBegin(). Definition at line 742 of file stream.h. References NLMISC::IStream::_XML, and NLMISC::IStream::xmlPushEndInternal(). Referenced by NLMISC::CObjectVector< sint8, false >::serial(), NLMISC::IStream::serialIStreamable(), NLMISC::IStream::serialMap(), NLMISC::IStream::serialMultimap(), NLMISC::IStream::serialPtr(), NLMISC::IStream::serialSTLCont(), NLMISC::IStream::serialSTLContPtr(), NLMISC::IStream::serialVector(), NLMISC::IStream::serialVectorPolyPtr(), and NLMISC::IStream::serialVectorPtr(). { // XML Mode ? if (_XML) { return xmlPushEndInternal (); } // Return ok return true; }

virtual bool NLMISC::IStream::xmlPushEndInternal (   )  [inline, protected, virtual, inherited]

xmlPushEnd implementation Reimplemented in NLMISC::COXml. Definition at line 836 of file stream.h. Referenced by NLMISC::IStream::xmlPush(), and NLMISC::IStream::xmlPushEnd(). { return true; };

template<class T> void NLMISC::IStream::xmlSerial (  T &  value0, T &  value1, T &  value2, T &  value3, const char *  nodeName )  [inline, inherited]

Definition at line 683 of file stream.h. References NLMISC::IStream::serial(), NLMISC::IStream::xmlPop(), and NLMISC::IStream::xmlPush(). { // Open the node xmlPush (nodeName); // Serial the values serial (value0, value1, value2, value3); // Close the node xmlPop (); }

template<class T> void NLMISC::IStream::xmlSerial (  T &  value0, T &  value1, T &  value2, const char *  nodeName )  [inline, inherited]

Definition at line 671 of file stream.h. References NLMISC::IStream::serial(), NLMISC::IStream::xmlPop(), and NLMISC::IStream::xmlPush(). { // Open the node xmlPush (nodeName); // Serial the values serial (value0, value1, value2); // Close the node xmlPop (); }

template<class T> void NLMISC::IStream::xmlSerial (  T &  value0, T &  value1, const char *  nodeName )  [inline, inherited]

Definition at line 659 of file stream.h. References NLMISC::IStream::serial(), NLMISC::IStream::xmlPop(), and NLMISC::IStream::xmlPush(). { // Open the node xmlPush (nodeName); // Serial the values serial (value0, value1); // Close the node xmlPop (); }

template<class T> void NLMISC::IStream::xmlSerial (  T &  value0, const char *  nodeName )  [inline, inherited]

xmlSerial() serial a values into a node. Definition at line 647 of file stream.h. References NLMISC::IStream::serial(), NLMISC::IStream::xmlPop(), and NLMISC::IStream::xmlPush(). Referenced by NLLIGO::CZoneRegion::serial(), NLLIGO::CZoneRegion::SZoneUnit2::serial(), NLLIGO::CZoneRegion::SZoneUnit::serial(), NL3D::CZone::serial(), NL3D::CPatchInfo::CBindInfo::serial(), NL3D::CZone::CPatchConnect::serial(), NL3D::CBorderVertex::serial(), NL3D::CTileElement::serial(), NL3D::CTileColorOldPatchVersion6::serial(), NL3D::CTileColor::serial(), and NL3D::CPatch::serial(). { // Open the node xmlPush (nodeName); // Serial the value serial (value0); // Close the node xmlPop (); }

bool NLMISC::IStream::xmlSetAttrib (  const char *  name  )  [inline, inherited]

xmlSetAttrib() set the name of the next node header attribute serialised. is the name of the node header attribute serialised. Returns: true if the attribute name have been set, false if the node header is not open (the call is not between xmlPushBegin and xmlPushEnd) Definition at line 777 of file stream.h. References NLMISC::IStream::_XML, and NLMISC::IStream::xmlSetAttribInternal(). Referenced by NLMISC::CObjectVector< sint8, false >::serial(), NLMISC::IStream::serialIStreamable(), NLMISC::IStream::serialMap(), NLMISC::IStream::serialMultimap(), NLMISC::IStream::serialPtr(), NLMISC::IStream::serialSTLCont(), NLMISC::IStream::serialSTLContPtr(), NLMISC::IStream::serialVector(), NLMISC::IStream::serialVectorPolyPtr(), and NLMISC::IStream::serialVectorPtr(). { // XML Mode ? if (_XML) { return xmlSetAttribInternal (name); } // Return ok return true; }

virtual bool NLMISC::IStream::xmlSetAttribInternal (  const char *  name  )  [inline, protected, virtual, inherited]

xmlBreakLine implementation Reimplemented in NLMISC::COXml. Definition at line 842 of file stream.h. Referenced by NLMISC::IStream::xmlSetAttrib(). { return true; };

---

Field Documentation

CObjectVector<uint8, false> NLMISC::CMemStream::_Buffer [protected, inherited]

Definition at line 516 of file mem_stream.h. Referenced by NLMISC::CMemStream::operator=().

uint8* NLMISC::CMemStream::_BufPos [protected, inherited]

Definition at line 517 of file mem_stream.h. Referenced by NLMISC::CMemStream::bufferToFill(), NLMISC::CMemStream::clear(), NLMISC::CMemStream::CMemStream(), NLMISC::CMemStream::fastRead(), NLMISC::CMemStream::fastSerial(), NLMISC::CMemStream::fastWrite(), NLMISC::CMemStream::fill(), NLMISC::CMemStream::getPos(), NLMISC::CMemStream::increaseBufferIfNecessary(), NLMISC::CMemStream::invert(), NLMISC::CMemStream::lengthS(), NLMISC::CMemStream::operator=(), NLMISC::CMemStream::poke(), NLMISC::CMemStream::reserve(), NLMISC::CMemStream::resetBufPos(), NLMISC::CMemStream::resize(), NLMISC::CMemStream::serialBuffer(), NLMISC::CMemStream::serialSeparatedBufferIn(), and NLMISC::CMemStream::serialSeparatedBufferOut().

uint32 NLMISC::CMemStream::_DefaultCapacity [protected, inherited]

Definition at line 521 of file mem_stream.h. Referenced by NLMISC::CMemStream::clear(), NLMISC::CMemStream::CMemStream(), and NLMISC::CMemStream::operator=().

bool NLNET::CMessage::_DefaultStringMode = false [static, private]

Definition at line 39 of file message.cpp. Referenced by init(), and setDefaultStringMode().

uint32 NLNET::CMessage::_HeaderSize [private]

Definition at line 266 of file message.h. Referenced by getHeaderSize(), operator=(), readType(), and setType().

NLMISC::CStringIdArray::TStringId NLNET::CMessage::_Id [private]

Definition at line 268 of file message.h. Referenced by operator=().

uint32 NLNET::CMessage::_LengthR [private]

Definition at line 263 of file message.h. Referenced by assignFromSubMessage(), clear(), lengthR(), lockSubMessage(), operator=(), resetSubMessageInternals(), and unlockSubMessage().

std::string NLNET::CMessage::_Name [private]

Definition at line 257 of file message.h. Referenced by operator=().

NLMISC::CStringIdArray* NLNET::CMessage::_SIDA [private]

Definition at line 255 of file message.h. Referenced by operator=(), setType(), and toString().

bool NLMISC::CMemStream::_StringMode [protected, inherited]

Definition at line 519 of file mem_stream.h. Referenced by NLMISC::CMemStream::CMemStream(), NLMISC::CMemStream::operator=(), NLMISC::CMemStream::serial(), NLMISC::CMemStream::serialHex(), NLMISC::CMemStream::serialSeparatedBufferIn(), NLMISC::CMemStream::serialSeparatedBufferOut(), NLMISC::CMemStream::setStringMode(), and NLMISC::CMemStream::stringMode().

uint32 NLNET::CMessage::_SubMessagePosR [private]

Definition at line 260 of file message.h. Referenced by assignFromSubMessage(), clear(), getName(), hasLockedSubMessage(), lockSubMessage(), operator=(), and resetSubMessageInternals().

bool NLNET::CMessage::_TypeSet [private]

Definition at line 270 of file message.h. Referenced by assignFromSubMessage(), clear(), getId(), getName(), invert(), operator=(), setType(), toString(), and typeIsSet().

bool NLNET::CMessage::TypeHasAName

Definition at line 240 of file message.h. Referenced by getName(), operator=(), setType(), and toString().

bool NLNET::CMessage::TypeHasAnId

Definition at line 239 of file message.h. Referenced by getId(), operator=(), NLNET::CCallbackNetBase::processOneMessage(), setType(), and toString().

---

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

• message.h
• message.cpp

---