NetMessage Class Reference

#include <NetMessage.h>

List of all members.

Public Types
enum	MessageType {   NoMessage = 0, ConnectMessage, DisconnectMessage,   DisconnectAllMessage, BufferMessage, SentMessage }
enum	DisconnectFlags {   UnknownDisconnect = 0, UserDisconnect = 1, KickDisconnect = 2,   TimeoutDisconnect = 4 }
Public Member Functions
unsigned int &	getDestinationId ()
unsigned int &	getIpAddress ()
unsigned int	getFlags ()
MessageType	getMessageType ()
NetBuffer &	getBuffer ()
void	setType (MessageType type)
void	setFlags (unsigned int flags)
Protected Member Functions
void	setDestinationId (unsigned int destinationId)
void	setIpAddress (unsigned int ipAddress)
	NetMessage (MessageType type=NetMessage::NoMessage, unsigned int destinationId=0, unsigned int ipAddress=0)
virtual	~NetMessage ()
Protected Attributes
NetBuffer	messageBuffer_
MessageType	type_
unsigned int	destinationId_
unsigned int	ipAddress_
unsigned int	flags_
Friends
class	NetMessagePool

---

Detailed Description

Definition at line 28 of file NetMessage.h.

---

Member Enumeration Documentation

enum NetMessage::MessageType

Enumerator:

NoMessage
ConnectMessage
DisconnectMessage
DisconnectAllMessage
BufferMessage
SentMessage

Definition at line 33 of file NetMessage.h.

enum NetMessage::DisconnectFlags

Enumerator:

UnknownDisconnect
UserDisconnect
KickDisconnect
TimeoutDisconnect

Definition at line 42 of file NetMessage.h.

---

Constructor & Destructor Documentation

NetMessage::NetMessage	(	MessageType	type = NetMessage::NoMessage,
		unsigned int	destinationId = 0,
		unsigned int	ipAddress = 0
	)			[protected]

Definition at line 23 of file NetMessage.cpp.

NetMessage::~NetMessage

(

)

[protected, virtual]

Definition at line 32 of file NetMessage.cpp.

---

Member Function Documentation

unsigned int& NetMessage::getDestinationId

(

)

[inline]

Definition at line 50 of file NetMessage.h.

References destinationId_.

Referenced by ServerMessageHandler::clientConnected(), ServerMessageHandler::clientDisconnected(), ServerMessageHandler::clientError(), ServerWebServer::processMessage(), ServerPlayerReadyHandler::processMessage(), ServerPlayedMoveHandler::processMessage(), ServerLinesHandler::processMessage(), ServerInitializeHandler::processMessage(), ServerHaveModFilesHandler::processMessage(), ServerGiftMoneyHandler::processMessage(), ServerFileAkHandler::processMessage(), ServerDefenseHandler::processMessage(), ServerConnectHandler::processMessage(), ServerConnectAuthHandler::processMessage(), ServerChannelManager::processMessage(), ServerBuyAccessoryHandler::processMessage(), ServerAdminHandler::processMessage(), ServerAddPlayerHandler::processMessage(), NetServerTCP3Send::processMessage(), NetServerTCP3::processMessage(), NetServerTCP2Destination::processMessage(), NetServerTCP2::processMessage(), ComsMessageHandler::processMessage(), ServerWebServer::processMessages(), ServerWebServer::processQueue(), ComsMessageHandler::processReceiveMessage(), ServerWebServer::processRequest(), and ComsMessageHandler::processSentMessage().

unsigned int& NetMessage::getIpAddress

(

)

[inline]

Definition at line 51 of file NetMessage.h.

References ipAddress_.

Referenced by ServerMessageHandler::clientConnected(), ServerMessageHandler::clientDisconnected(), ServerWebServer::processMessage(), ServerConnectHandler::processMessage(), ServerConnectAuthHandler::processMessage(), ServerAdminHandler::processMessage(), NetServerTCP3::processMessage(), NetServerTCP2::processMessage(), and ClientConnectionAcceptHandler::processMessage().

unsigned int NetMessage::getFlags

(

)

[inline]

Definition at line 52 of file NetMessage.h.

References flags_.

Referenced by ServerMessageHandler::clientDisconnected(), ClientMessageHandler::clientDisconnected(), NetServerTCP3::processMessage(), NetServerTCP2::processMessage(), and ComsMessageHandler::processMessage().

MessageType NetMessage::getMessageType

(

)

[inline]

Definition at line 53 of file NetMessage.h.

References type_.

Referenced by NetServerTCPRead::addMessage(), NetServerTCPRead::pollOutgoing(), ServerWebServer::processMessage(), ServerRegistrationEntry::processMessage(), NetServerTCP3::processMessage(), NetServerTCP2::processMessage(), ComsMessageHandler::processMessage(), and ServerBrowserCollect::processMessage().

NetBuffer& NetMessage::getBuffer

(

)

[inline]

Definition at line 54 of file NetMessage.h.

References messageBuffer_.

Referenced by NetServerTCP3Recv::actualRecvFunc(), NetServerTCP3Send::actualSendFunc(), NetServerTCPRead::addMessage(), NetServerTCP2Destination::checkIncoming(), NetServerTCP2Destination::checkOutgoing(), ServerWebServerUtil::extractMultiPartPost(), NetMessagePool::getFromPool(), NetServerTCPRead::pollOutgoing(), ServerWebServer::processMessage(), ServerRegistrationEntry::processMessage(), NetServerTCP3Send::processMessage(), NetServerTCP3::processMessage(), NetServerTCP2Destination::processMessage(), NetServerTCP2::processMessage(), ServerBrowserCollect::processMessage(), ServerWebServer::processMessages(), ServerWebServer::processQueue(), ComsMessageHandler::processReceiveMessage(), ServerWebSettingsHandler::SettingsModHandler::processRequest(), ServerWebServer::processRequest(), ComsMessageHandler::processSentMessage(), NetServerHTTPProtocolRecv::readBuffer(), NetServerHTTPProtocolSend::readBuffer(), NetServerTCPScorchedProtocol::readBuffer(), NetServerTCP2Destination::sendHeader(), NetServerTCP3::sendMessageDest(), NetServerTCP2::sendMessageDest(), NetServerTCP::sendMessageDest(), and NetLoopBack::sendMessageDest().

void NetMessage::setType

(

MessageType

type

)

[inline]

Definition at line 55 of file NetMessage.h.

References type_.

Referenced by NetMessagePool::getFromPool(), and NetServerTCPRead::pollOutgoing().

void NetMessage::setFlags

(

unsigned int

flags

)

[inline]

Definition at line 56 of file NetMessage.h.

References flags_.

Referenced by NetServerTCP3::destroyDestination(), NetServerTCP2::destroyDestination(), and NetMessagePool::getFromPool().

void NetMessage::setDestinationId

(

unsigned int

destinationId

)

[inline, protected]

Definition at line 65 of file NetMessage.h.

References destinationId_.

Referenced by NetMessagePool::getFromPool().

void NetMessage::setIpAddress

(

unsigned int

ipAddress

)

[inline, protected]

Definition at line 66 of file NetMessage.h.

References ipAddress_.

Referenced by NetMessagePool::getFromPool().

---

Friends And Related Function Documentation

friend class NetMessagePool [friend]

Definition at line 31 of file NetMessage.h.

---

Member Data Documentation

NetBuffer NetMessage::messageBuffer_ [protected]

Definition at line 59 of file NetMessage.h.

Referenced by getBuffer().

MessageType NetMessage::type_ [protected]

Definition at line 60 of file NetMessage.h.

Referenced by getMessageType(), and setType().

unsigned int NetMessage::destinationId_ [protected]

Definition at line 61 of file NetMessage.h.

Referenced by getDestinationId(), and setDestinationId().

unsigned int NetMessage::ipAddress_ [protected]

Definition at line 62 of file NetMessage.h.

Referenced by getIpAddress(), and setIpAddress().

unsigned int NetMessage::flags_ [protected]

Definition at line 63 of file NetMessage.h.

Referenced by getFlags(), and setFlags().

---

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

• src/common/net/NetMessage.h
• src/common/net/NetMessage.cpp

---