ServerRequest Class Reference

Server request bean. More...

#include <tdme/network/udpserver/ServerRequest.h>

Collaboration diagram for ServerRequest:

Public Types
enum	RequestType {   REQUESTTYPE_CLIENT_REQUEST , REQUESTTYPE_CLIENT_INIT , REQUESTTYPE_CLIENT_CLOSE , REQUESTTYPE_CLIENT_CUSTOM ,   REQUESTTYPE_GROUP_INIT , REQUESTTYPE_GROUP_CLOSE , REQUESTTYPE_GROUP_CUSTOM }

Public Member Functions
	ServerRequest (const RequestType requestType, void *object, const string &custom=EVENT_CUSTOM_NONE, stringstream *messageFrame=NULL, const uint32_t messageId=MESSAGE_ID_UNSUPPORTED, const uint8_t messageRetries=MESSAGE_RETRIES_NONE)
	Public constructor. More...
	~ServerRequest ()
	Public destructor. More...
const RequestType	getRequestType ()
	Returns the request type. More...
void *	getObject ()
	Returns the associated object. More...
const string &	getCustomEvent ()
stringstream *	getMessageFrame ()
	Returns the associated request message frame stream. More...
const uint32_t	getMessageId ()
	Returns associated message id (udp server only) More...
const uint8_t	getMessageRetries ()
	Returns number of message retries (udp server only) More...

Static Public Attributes
static const uint32_t	MESSAGE_ID_UNSUPPORTED = 0
static const uint8_t	MESSAGE_RETRIES_NONE = 0
static const string	EVENT_CUSTOM_NONE = ""

Private Attributes
RequestType	requestType
void *	object
string	customEvent
stringstream *	messageFrame
uint32_t	messageId
uint8_t	messageRetries

Detailed Description

Server request bean.

Author

Andreas Drewke

Definition at line 25 of file ServerRequest.h.

Member Enumeration Documentation

RequestType

enum RequestType

Enumerator
REQUESTTYPE_CLIENT_REQUEST
REQUESTTYPE_CLIENT_INIT
REQUESTTYPE_CLIENT_CLOSE
REQUESTTYPE_CLIENT_CUSTOM
REQUESTTYPE_GROUP_INIT
REQUESTTYPE_GROUP_CLOSE
REQUESTTYPE_GROUP_CUSTOM

Definition at line 28 of file ServerRequest.h.

Constructor & Destructor Documentation

ServerRequest()

ServerRequest ( const RequestType  requestType, void *  object, const string &  custom = EVENT_CUSTOM_NONE, stringstream *  messageFrame = NULL, const uint32_t  messageId = MESSAGE_ID_UNSUPPORTED, const uint8_t  messageRetries = MESSAGE_RETRIES_NONE  )

inline

Public constructor.

Parameters

requestType	request type
object	object
custom	custom event type if any
messageFrame	request frame stream
messageId	message id (udp server only)
messageRetries	message retries (udp server only)

Definition at line 50 of file ServerRequest.h.

~ServerRequest()

~ServerRequest ( )

inline

Public destructor.

Definition at line 58 of file ServerRequest.h.

Member Function Documentation

getCustomEvent()

const string & getCustomEvent ( )

inline

Returns

custom event name

Definition at line 80 of file ServerRequest.h.

getMessageFrame()

stringstream * getMessageFrame ( )

inline

Returns the associated request message frame stream.

Returns

frame stream

Definition at line 88 of file ServerRequest.h.

getMessageId()

const uint32_t getMessageId ( )

inline

Returns associated message id (udp server only)

Returns

message id

Definition at line 96 of file ServerRequest.h.

getMessageRetries()

const uint8_t getMessageRetries ( )

inline

Returns number of message retries (udp server only)

Returns

retries

Definition at line 104 of file ServerRequest.h.

getObject()

void * getObject ( )

inline

Returns the associated object.

Returns

client

Definition at line 73 of file ServerRequest.h.

getRequestType()

const RequestType getRequestType ( )

inline

Returns the request type.

Returns

request type

Definition at line 65 of file ServerRequest.h.

Member Data Documentation

customEvent

string customEvent

private

Definition at line 110 of file ServerRequest.h.

EVENT_CUSTOM_NONE

const string EVENT_CUSTOM_NONE = ""

static

Definition at line 39 of file ServerRequest.h.

MESSAGE_ID_UNSUPPORTED

const uint32_t MESSAGE_ID_UNSUPPORTED = 0

static

Definition at line 37 of file ServerRequest.h.

MESSAGE_RETRIES_NONE

const uint8_t MESSAGE_RETRIES_NONE = 0

static

Definition at line 38 of file ServerRequest.h.

messageFrame

stringstream* messageFrame

private

Definition at line 111 of file ServerRequest.h.

messageId

uint32_t messageId

private

Definition at line 112 of file ServerRequest.h.

messageRetries

uint8_t messageRetries

private

Definition at line 113 of file ServerRequest.h.

object

void* object

private

Definition at line 109 of file ServerRequest.h.

requestType

RequestType requestType

private

Definition at line 108 of file ServerRequest.h.

---

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

• /home/andreas/Development/drewke.net/tdme2/src/tdme/network/udpserver/ServerRequest.h
• /home/andreas/Development/drewke.net/tdme2/src/tdme/network/udpserver/ServerRequest.cpp