ArServerClientIdentifier Class Reference

#include <ArServerClientIdentifier.h>

List of all members.

---

Detailed Description

Class that holds an identifier for a particular serverClient.

Public Member Functions
	ArServerClientIdentifier ()
	Constructor.
ArTypes::UByte4	getConnectionID (void)
	Gets the id num.
const char *	getHereGoal (void)
	Gets the here goal.
const char *	getIDString (void)
	Gets an ID string which is just the other information in this combined.
const char *	getSelfIdentifier (void)
	Gets the self identifier.
bool	matches (ArServerClientIdentifier identifier, bool matchConnectionID)
	It can either match id, or the other parameters (for the other parameters if the self id matches its a match, otherwise it checks the here goal, and if that matches its a match).
void	rebuildIDString (void)
void	setConnectionID (ArTypes::UByte4 idNum)
	set the id num
void	setHereGoal (const char *selfIdentifier)
	Sets the here goal.
void	setSelfIdentifier (const char *selfIdentifier)
	Sets the self identifier.
virtual	~ArServerClientIdentifier ()
	Destructor.
Protected Attributes
ArTypes::UByte4	myConnectionID
std::string	myHereGoal
std::string	myIDString
std::string	mySelfIdentifier

---

Constructor & Destructor Documentation

ArServerClientIdentifier::ArServerClientIdentifier

(

)

[inline]

Constructor.

virtual ArServerClientIdentifier::~ArServerClientIdentifier

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

ArTypes::UByte4 ArServerClientIdentifier::getConnectionID

(

void

)

[inline]

Gets the id num.

const char* ArServerClientIdentifier::getHereGoal

(

void

)

[inline]

Gets the here goal.

const char* ArServerClientIdentifier::getIDString

(

void

)

[inline]

Gets an ID string which is just the other information in this combined.

const char* ArServerClientIdentifier::getSelfIdentifier

(

void

)

[inline]

Gets the self identifier.

bool ArServerClientIdentifier::matches	(	ArServerClientIdentifier	identifier,
		bool	matchConnectionID
	)			[inline]

It can either match id, or the other parameters (for the other parameters if the self id matches its a match, otherwise it checks the here goal, and if that matches its a match).

.. this is so that if someone's set a self id but changes their here goal they'll still get their messages

void ArServerClientIdentifier::rebuildIDString

(

void

)

[inline]

void ArServerClientIdentifier::setConnectionID

(

ArTypes::UByte4

idNum

)

[inline]

set the id num

void ArServerClientIdentifier::setHereGoal

(

const char *

selfIdentifier

)

[inline]

Sets the here goal.

void ArServerClientIdentifier::setSelfIdentifier

(

const char *

selfIdentifier

)

[inline]

Sets the self identifier.

---

Member Data Documentation

ArTypes::UByte4 ArServerClientIdentifier::myConnectionID [protected]

std::string ArServerClientIdentifier::myHereGoal [protected]

std::string ArServerClientIdentifier::myIDString [protected]

std::string ArServerClientIdentifier::mySelfIdentifier [protected]

---

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

• ArServerClientIdentifier.h

---