ppl7::SocketMessage Klassenreferenz

TCP-Socket-Nachrichten.

Öffentliche Methoden
	SocketMessage ()
	SocketMessage (const SocketMessage &other)
virtual	~SocketMessage ()
void	clear ()
void	copy (const SocketMessage &other)
void	enableCompression (bool flag=true)
void	enableMsgChannel (bool flag=true)
int	getCommandId ()
int	getId ()
void	getPayload (String &msg) const
void	getPayload (AssocArray &msg) const
void	getPayload (ByteArray &msg) const
int	getPayloadType ()
bool	isCompressionSupported () const
bool	isMsgChannelSupported () const
	PPL7EXCEPTION (NoDataAvailableException, Exception)
	PPL7EXCEPTION (DataInOtherFormatException, Exception)
	PPL7EXCEPTION (InvalidProtocolVersion, Exception)
	PPL7EXCEPTION (InvalidPacketException, Exception)
	PPL7EXCEPTION (PayloadTooBigException, Exception)
void	setCommandId (int id)
void	setId (int id)
void	setPayload (const String &msg)
void	setPayload (const AssocArray &msg)
void	setPayload (const ByteArrayPtr &msg)

Öffentliche Attribute
bool	ClientSupportsCompression

Private Methoden
void	compilePacketHeader (char *buffer, size_t *buffer_size, const void *payload, size_t payload_size, bool is_compressed) const
void	readFromPacketHeader (const char *msgbuffer, int &flags)

Private Attribute
int	commandId
int	Id
void *	payload
size_t	payload_size
int	payload_type
bool	SupportMsgChannel
bool	UseCompression
int	Version

Freundbeziehungen
class	TCPSocket

Beschreibung der Konstruktoren und Destruktoren

ppl7::SocketMessage::SocketMessage

(

)

ppl7::SocketMessage::SocketMessage

(

const SocketMessage &

other

)

ppl7::SocketMessage::~SocketMessage ( )

virtual

Dokumentation der Elementfunktionen

void ppl7::SocketMessage::clear

(

)

void ppl7::SocketMessage::compilePacketHeader ( char *  buffer, size_t *  buffer_size, const void *  payload, size_t  payload_size, bool  is_compressed  ) const

private

void ppl7::SocketMessage::copy

(

const SocketMessage &

other

)

void ppl7::SocketMessage::enableCompression

(

bool

flag = true

)

void ppl7::SocketMessage::enableMsgChannel

(

bool

flag = true

)

int ppl7::SocketMessage::getCommandId

(

)

int ppl7::SocketMessage::getId

(

)

void ppl7::SocketMessage::getPayload

(

String &

msg

)

const

void ppl7::SocketMessage::getPayload

(

AssocArray &

msg

)

const

void ppl7::SocketMessage::getPayload

(

ByteArray &

msg

)

const

int ppl7::SocketMessage::getPayloadType

(

)

bool ppl7::SocketMessage::isCompressionSupported

(

)

const

bool ppl7::SocketMessage::isMsgChannelSupported

(

)

const

ppl7::SocketMessage::PPL7EXCEPTION	(	NoDataAvailableException	,
		Exception
	)

ppl7::SocketMessage::PPL7EXCEPTION	(	DataInOtherFormatException	,
		Exception
	)

ppl7::SocketMessage::PPL7EXCEPTION	(	InvalidProtocolVersion	,
		Exception
	)

ppl7::SocketMessage::PPL7EXCEPTION	(	InvalidPacketException	,
		Exception
	)

ppl7::SocketMessage::PPL7EXCEPTION	(	PayloadTooBigException	,
		Exception
	)

void ppl7::SocketMessage::readFromPacketHeader ( const char *  msgbuffer, int &  flags  )

private

void ppl7::SocketMessage::setCommandId

(

int

id

)

void ppl7::SocketMessage::setId

(

int

id

)

void ppl7::SocketMessage::setPayload

(

const String &

msg

)

void ppl7::SocketMessage::setPayload

(

const AssocArray &

msg

)

void ppl7::SocketMessage::setPayload

(

const ByteArrayPtr &

msg

)

Freundbeziehungen und Funktionsdokumentation

friend class TCPSocket

friend

Dokumentation der Datenelemente

bool ppl7::SocketMessage::ClientSupportsCompression

int ppl7::SocketMessage::commandId

private

int ppl7::SocketMessage::Id

private

void* ppl7::SocketMessage::payload

private

size_t ppl7::SocketMessage::payload_size

private

int ppl7::SocketMessage::payload_type

private

bool ppl7::SocketMessage::SupportMsgChannel

private

bool ppl7::SocketMessage::UseCompression

private

int ppl7::SocketMessage::Version

private

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:

• /jenkins/jobs/clang_ppl7/workspace/include/ppl7-inet.h
• /jenkins/jobs/clang_ppl7/workspace/src/internet/SocketMessage.cpp