CGameSetupMessage Class Reference

Special message type for updated to game startup settings. More...

#include <NetMessage.h>

Inheritance diagram for CGameSetupMessage:

Collaboration diagram for CGameSetupMessage:

Public Member Functions
	CGameSetupMessage (const ScriptInterface &scriptInterface)
	CGameSetupMessage (const ScriptInterface &scriptInterface, JS::HandleValue data)
virtual u8 *	Serialize (u8 *pBuffer) const
	Serialize the message into the specified buffer parameter. More...
virtual const u8 *	Deserialize (const u8 *pStart, const u8 *pEnd)
	Deserializes the message from the specified buffer. More...
virtual size_t	GetSerializedLength () const
	Retrieves the size in bytes of the serialized message. More...
virtual CStr	ToString () const
	Returns a string representation for the message. More...
Public Member Functions inherited from CNetMessage
	CNetMessage ()
	CNetMessage (NetMessageType type)
virtual	~CNetMessage ()
NetMessageType	GetType () const
	Retrieves the message type. More...
virtual u8 *	Serialize (u8 *pBuffer) const
	Serialize the message into the specified buffer parameter. More...
virtual const u8 *	Deserialize (const u8 *pStart, const u8 *pEnd)
	Deserializes the message from the specified buffer. More...
virtual size_t	GetSerializedLength () const
	Retrieves the size in bytes of the serialized message. More...
virtual CStr	ToString () const
	Returns a string representation for the message. More...
Public Member Functions inherited from ISerializable
virtual	~ISerializable ()
virtual size_t	GetSerializedLength () const =0
	Return the length of the serialized form of this object. More...
virtual u8 *	Serialize (u8 *buffer) const =0
	Serialize the object into the passed buffer. More...
virtual const u8 *	Deserialize (const u8 *buffer, const u8 *end)=0
	Deserialize the object (i.e. More...

Public Attributes
JS::PersistentRootedValue	m_Data

Private Member Functions
	NONCOPYABLE (CGameSetupMessage)

Private Attributes
const ScriptInterface &	m_ScriptInterface

Detailed Description

Special message type for updated to game startup settings.

Constructor & Destructor Documentation

CGameSetupMessage() [1/2]

CGameSetupMessage::CGameSetupMessage

(

const ScriptInterface &

scriptInterface

)

CGameSetupMessage() [2/2]

CGameSetupMessage::CGameSetupMessage	(	const ScriptInterface &	scriptInterface,
		JS::HandleValue	data
	)

Member Function Documentation

Deserialize()

const u8 * CGameSetupMessage::Deserialize ( const u8 *  pStart, const u8 *  pEnd  )

virtual

Deserializes the message from the specified buffer.

Parameters

pStart	Message start within the serialized buffer
pEnd	Message end within the serialized buffer

Returns

The position in the buffer right after the message or NULL if an error occurred

Reimplemented from CNetMessage.

GetSerializedLength()

size_t CGameSetupMessage::GetSerializedLength ( ) const

virtual

Retrieves the size in bytes of the serialized message.

Before calling Serialize, the memory size for the buffer where to serialize the message object can be found by calling this method.

Returns

The size of serialized message

Reimplemented from CNetMessage.

NONCOPYABLE()

CGameSetupMessage::NONCOPYABLE ( CGameSetupMessage  )

private

Serialize()

u8 * CGameSetupMessage::Serialize ( u8 *  pBuffer ) const

virtual

Serialize the message into the specified buffer parameter.

The size required by the buffer parameter can be found by a call to GetSerializedLength method. The information contained within the message must be serialized before the message is sent. By default only the message type and its size are serialized in the buffer parameter.

Parameters

pBuffer

Buffer where to serialize the message

Returns

The position in the buffer right after the serialized message

Reimplemented from CNetMessage.

ToString()

CStr CGameSetupMessage::ToString ( ) const

virtual

Returns a string representation for the message.

Returns

The message as a string

Reimplemented from CNetMessage.

Member Data Documentation

m_Data

JS::PersistentRootedValue CGameSetupMessage::m_Data

m_ScriptInterface

const ScriptInterface& CGameSetupMessage::m_ScriptInterface

private

---

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

• /home/docker/jenkins/workspace/technical-docs/source/network/NetMessage.h
• /home/docker/jenkins/workspace/technical-docs/source/network/NetMessageSim.cpp