ServerClient Class Reference

Base class for network server clients. More...

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

Inheritance diagram for ServerClient:

Collaboration diagram for ServerClient:

Public Member Functions
virtual const string &	getIp () const =0
	returns client's ip More...
virtual const unsigned int	getPort () const =0
	returns client port More...
virtual const string &	getKey () const =0
	Client identification key. More...
virtual const bool	setKey (const string &key)=0
	sets the clients identification key More...
stringstream *	createFrame ()
	Creates a frame to be used with send. More...
virtual void	shutdown ()=0
	Shuts down this network client. More...
Public Member Functions inherited from Reference
	Reference ()
	Public constructor. More...
virtual	~Reference ()
	destructor More...
void	acquireReference ()
	acquires a reference, incrementing the counter More...
void	releaseReference ()
	releases a reference, thus decrementing the counter and delete it if reference counter is zero More...
virtual void	onDelete ()
	Callback method to be overridden, will be called if object will be deleted. More...

Static Public Attributes
static STATIC_DLL_IMPEXT const char *	KEY_PREFIX_UNNAMED = "unnamed."

Protected Member Functions
virtual void	onRequest (stringstream *frame, const uint32_t messageId, const uint8_t retries)=0
	To be overwritten with a request handler, will be called from worker. More...
virtual void	onInit ()=0
virtual void	onClose ()=0
virtual void	onCustom (const string &type)=0
virtual void	onFrameReceived (stringstream *frame, const uint32_t messageId=0, const uint8_t retries=0)=0
	Event, which will be called if frame has been received, defaults to worker thread pool. More...
virtual void	close ()=0
	Shuts down this network client. More...

Protected Attributes
std::string	key

Friends
class	ServerWorkerThread

Detailed Description

Base class for network server clients.

Author

Andreas Drewke

Definition at line 33 of file ServerClient.h.

Member Function Documentation

close()

virtual void close ( )

protectedpure virtual

Shuts down this network client.

Implemented in UDPServerClient.

createFrame()

stringstream * createFrame

(

)

Creates a frame to be used with send.

Returns

frame to be send

Definition at line 12 of file ServerClient.cpp.

getIp()

virtual const string & getIp ( ) const

pure virtual

returns client's ip

Returns

client ip

Implemented in UDPServerClient.

getKey()

virtual const string & getKey ( ) const

pure virtual

Client identification key.

Returns

client key

Implemented in UDPServerClient.

getPort()

virtual const unsigned int getPort ( ) const

pure virtual

returns client port

Returns

client port

Implemented in UDPServerClient.

onClose()

virtual void onClose ( )

protectedpure virtual

Implemented in UDPServerClient.

onCustom()

virtual void onCustom ( const string &  type )

protectedpure virtual

onFrameReceived()

virtual void onFrameReceived ( stringstream *  frame, const uint32_t  messageId = 0, const uint8_t  retries = 0  )

protectedpure virtual

Event, which will be called if frame has been received, defaults to worker thread pool.

Parameters

frame	frame
messageId	message id (upd server only)
retries	retries (udp server only)

Implemented in UDPServerClient.

onInit()

virtual void onInit ( )

protectedpure virtual

onRequest()

virtual void onRequest ( stringstream *  frame, const uint32_t  messageId, const uint8_t  retries  )

protectedpure virtual

To be overwritten with a request handler, will be called from worker.

Parameters

frame	frame
messageId	message id (udp server only)
retries	retries (udp server only)

Implemented in UDPServerClient.

setKey()

virtual const bool setKey ( const string &  key )

pure virtual

sets the clients identification key

Parameters

&key	client identification key

Returns

if setting the key was succesful

Implemented in UDPServerClient.

shutdown()

virtual void shutdown ( )

pure virtual

Shuts down this network client.

Implemented in UDPServerClient.

Friends And Related Function Documentation

ServerWorkerThread

friend class ServerWorkerThread

friend

Definition at line 34 of file ServerClient.h.

Member Data Documentation

key

std::string key

protected

Definition at line 113 of file ServerClient.h.

KEY_PREFIX_UNNAMED

const char * KEY_PREFIX_UNNAMED = "unnamed."

static

Definition at line 37 of file ServerClient.h.

---

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

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