ComsChannelMessage Class Reference

#include <ComsChannelMessage.h>

Inheritance diagram for ComsChannelMessage:

List of all members.

Public Types
enum	RequestType {   eNoRequest = 0, eRegisterRequest = 1, eDeregisterRequest = 2,   eJoinRequest = 3 }
Public Member Functions
	ComsChannelMessage ()
	ComsChannelMessage (RequestType type, unsigned int id)
virtual	~ComsChannelMessage ()
RequestType	getType ()
unsigned int	getId ()
std::list < ChannelDefinition > &	getChannels ()
std::list < ChannelDefinition > &	getAvailableChannels ()
virtual bool	writeMessage (NetBuffer &buffer)
virtual bool	readMessage (NetBufferReader &reader)
Protected Attributes
RequestType	type_
unsigned int	id_
std::list < ChannelDefinition >	channels_
std::list < ChannelDefinition >	availableChannels_
Private Member Functions
	ComsChannelMessage (const ComsChannelMessage &)
const ComsChannelMessage &	operator= (const ComsChannelMessage &)

---

Detailed Description

Definition at line 28 of file ComsChannelMessage.h.

---

Member Enumeration Documentation

enum ComsChannelMessage::RequestType

Enumerator:

eNoRequest
eRegisterRequest
eDeregisterRequest
eJoinRequest

Definition at line 31 of file ComsChannelMessage.h.

---

Constructor & Destructor Documentation

ComsChannelMessage::ComsChannelMessage

(

)

Definition at line 23 of file ComsChannelMessage.cpp.

ComsChannelMessage::ComsChannelMessage	(	RequestType	type,
		unsigned int	id
	)

Definition at line 28 of file ComsChannelMessage.cpp.

ComsChannelMessage::~ComsChannelMessage

(

)

[virtual]

Definition at line 34 of file ComsChannelMessage.cpp.

ComsChannelMessage::ComsChannelMessage

(

const ComsChannelMessage &

)

[private]

---

Member Function Documentation

RequestType ComsChannelMessage::getType

(

)

[inline]

Definition at line 43 of file ComsChannelMessage.h.

References type_.

Referenced by ServerChannelManager::processMessage(), and ClientChannelManager::processMessage().

unsigned int ComsChannelMessage::getId

(

)

[inline]

Definition at line 44 of file ComsChannelMessage.h.

References id_.

Referenced by ServerChannelManager::processMessage(), and ClientChannelManager::processMessage().

std::list<ChannelDefinition>& ComsChannelMessage::getChannels

(

)

[inline]

Definition at line 45 of file ComsChannelMessage.h.

References channels_.

Referenced by ClientChannelManager::changeRegistration(), ServerChannelManager::joinClient(), ServerChannelManager::processMessage(), ClientChannelManager::processMessage(), ServerChannelManager::refreshDestination(), and ClientChannelManager::registerClient().

std::list<ChannelDefinition>& ComsChannelMessage::getAvailableChannels

(

)

[inline]

Definition at line 46 of file ComsChannelMessage.h.

References availableChannels_.

Referenced by ServerChannelManager::joinClient(), ClientChannelManager::processMessage(), and ServerChannelManager::refreshDestination().

bool ComsChannelMessage::writeMessage

(

NetBuffer &

buffer

)

[virtual]

Implements ComsMessage.

Definition at line 38 of file ComsChannelMessage.cpp.

References NetBuffer::addToBuffer(), availableChannels_, channels_, id_, and type_.

bool ComsChannelMessage::readMessage

(

NetBufferReader &

reader

)

[virtual]

Implements ComsMessage.

Definition at line 62 of file ComsChannelMessage.cpp.

References availableChannels_, channels_, NetBufferReader::getFromBuffer(), id_, and type_.

Referenced by ServerChannelManager::processMessage(), and ClientChannelManager::processMessage().

const ComsChannelMessage& ComsChannelMessage::operator=

(

const ComsChannelMessage &

)

[private]

---

Member Data Documentation

RequestType ComsChannelMessage::type_ [protected]

Reimplemented from ComsMessage.

Definition at line 53 of file ComsChannelMessage.h.

Referenced by getType(), readMessage(), and writeMessage().

unsigned int ComsChannelMessage::id_ [protected]

Definition at line 54 of file ComsChannelMessage.h.

Referenced by getId(), readMessage(), and writeMessage().

std::list<ChannelDefinition> ComsChannelMessage::channels_ [protected]

Definition at line 55 of file ComsChannelMessage.h.

Referenced by getChannels(), readMessage(), and writeMessage().

std::list<ChannelDefinition> ComsChannelMessage::availableChannels_ [protected]

Definition at line 56 of file ComsChannelMessage.h.

Referenced by getAvailableChannels(), readMessage(), and writeMessage().

---

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

• src/common/coms/ComsChannelMessage.h
• src/common/coms/ComsChannelMessage.cpp

---