ArServerData Class Reference

#include <ArServerData.h>

List of all members.

Public Member Functions
bool	addDataFlags (const char *dataFlags)
	ArServerData (const char *name, const char *description, unsigned int command, ArFunctor2< ArServerClient *, ArNetPacket * > *functor, const char *argumentDescription, const char *returnDescription, const char *commandGroup=NULL, const char *dataFlags=NULL, ArRetFunctor1< long, unsigned int > *getFrequencyFunctor=NULL, ArFunctor2< long, unsigned int > *requestChangedFunctor=NULL, ArFunctor2< ArServerClient *, ArNetPacket * > *requestOnceFunctor=NULL)
	Constructor.
void	callRequestChangedFunctor (void)
const char *	getArgumentDescription (void)
unsigned int	getCommand (void)
const char *	getCommandGroup (void)
const char *	getDataFlagsString (void)
const char *	getDescription (void)
ArFunctor2< ArServerClient *, ArNetPacket * > *	getFunctor (void)
const char *	getName (void)
ArFunctor2< ArServerClient *, ArNetPacket * > *	getRequestOnceFunctor (void)
const char *	getReturnDescription (void)
bool	hasDataFlag (const char *dataFlag)
bool	remDataFlag (const char *dataFlag)
virtual	~ArServerData ()
	Destructor.
Protected Attributes
std::string	myArgumentDescription
unsigned int	myCommand
std::string	myCommandGroup
ArArgumentBuilder	myDataFlagsBuilder
ArMutex	myDataMutex
std::string	myDescription
ArFunctor2< ArServerClient *, ArNetPacket * > *	myFunctor
ArRetFunctor1< long, unsigned int > *	myGetFrequencyFunctor
std::string	myName
std::string	myRawDataFlags
ArFunctor2< long, unsigned int > *	myRequestChangedFunctor
ArFunctor2< ArServerClient *, ArNetPacket * > *	myRequestOnceFunctor
std::string	myReturnDescription

---

Constructor & Destructor Documentation

ArServerData::ArServerData (  const char *  name, const char *  description, unsigned int  command, ArFunctor2< ArServerClient *, ArNetPacket * > *  functor, const char *  argumentDescription, const char *  returnDescription, const char *  commandGroup = NULL, const char *  dataFlags = NULL, ArRetFunctor1< long, unsigned int > *  getFrequencyFunctor = NULL, ArFunctor2< long, unsigned int > *  requestChangedFunctor = NULL, ArFunctor2< ArServerClient *, ArNetPacket * > *  requestOnceFunctor = NULL )

Constructor. Definition at line 32 of file ArServerData.cpp. References ArArgumentBuilder::add(), myArgumentDescription, myCommand, myCommandGroup, myDataFlagsBuilder, myDescription, myFunctor, myGetFrequencyFunctor, myName, myRequestChangedFunctor, myRequestOnceFunctor, and myReturnDescription.

ArServerData::~ArServerData (   )  [virtual]

Destructor. Definition at line 63 of file ArServerData.cpp.

---

Member Function Documentation

bool ArServerData::addDataFlags (  const char *  dataFlags  )

Definition at line 85 of file ArServerData.cpp. References ArArgumentBuilder::add(), ArMutex::lock(), myDataFlagsBuilder, myDataMutex, and ArMutex::unlock(). Referenced by ArServerBase::addDataAdvanced().

void ArServerData::callRequestChangedFunctor (  void   )

Definition at line 111 of file ArServerData.cpp. References ArFunctor2< P1, P2 >::invoke(), ArRetFunctor1< Ret, P1 >::invokeR(), myCommand, myGetFrequencyFunctor, and myRequestChangedFunctor. Referenced by ArServerClient::processPacket(), and ArServerClient::~ArServerClient().

const char* ArServerData::getArgumentDescription (  void   )  [inline]

Definition at line 61 of file ArServerData.h. References myArgumentDescription. Referenced by ArServerClient::sendListPacket().

unsigned int ArServerData::getCommand (  void   )  [inline]

Definition at line 58 of file ArServerData.h. References myCommand. Referenced by ArServerClient::broadcastPacketTcp(), ArServerClient::broadcastPacketUdp(), ArServerClient::getFrequency(), ArServerClient::handleRequests(), ArServerClient::processPacket(), and ArServerClient::sendListPacket().

const char* ArServerData::getCommandGroup (  void   )  [inline]

Definition at line 65 of file ArServerData.h. References myCommandGroup. Referenced by ArServerClient::processPacket(), and ArServerClient::sendListPacket().

const char* ArServerData::getDataFlagsString (  void   )  [inline]

Definition at line 72 of file ArServerData.h. References ArArgumentBuilder::getFullString(), and myDataFlagsBuilder. Referenced by ArServerClient::sendListPacket().

const char* ArServerData::getDescription (  void   )  [inline]

Definition at line 57 of file ArServerData.h. References myDescription. Referenced by ArServerClient::sendListPacket().

ArFunctor2<ArServerClient *, ArNetPacket *>* ArServerData::getFunctor (  void   )  [inline]

Definition at line 59 of file ArServerData.h. References myFunctor. Referenced by ArServerClient::handleRequests(), and ArServerClient::processPacket().

const char* ArServerData::getName (  void   )  [inline]

Definition at line 56 of file ArServerData.h. References myName. Referenced by ArServerClient::processPacket(), and ArServerClient::sendListPacket().

ArFunctor2<ArServerClient *, ArNetPacket *>* ArServerData::getRequestOnceFunctor (  void   )  [inline]

Definition at line 67 of file ArServerData.h. References myRequestOnceFunctor. Referenced by ArServerClient::processPacket().

const char* ArServerData::getReturnDescription (  void   )  [inline]

Definition at line 63 of file ArServerData.h. References myReturnDescription. Referenced by ArServerClient::sendListPacket().

bool ArServerData::hasDataFlag (  const char *  dataFlag  )

Definition at line 68 of file ArServerData.cpp. References ArArgumentBuilder::getArg(), ArArgumentBuilder::getArgc(), ArMutex::lock(), myDataFlagsBuilder, myDataMutex, and ArMutex::unlock().

bool ArServerData::remDataFlag (  const char *  dataFlag  )

Definition at line 93 of file ArServerData.cpp. References ArArgumentBuilder::getArg(), ArArgumentBuilder::getArgc(), ArMutex::lock(), myDataFlagsBuilder, myDataMutex, ArArgumentBuilder::removeArg(), and ArMutex::unlock().

---

Member Data Documentation

std::string ArServerData::myArgumentDescription [protected]

Definition at line 78 of file ArServerData.h. Referenced by ArServerData(), and getArgumentDescription().

unsigned int ArServerData::myCommand [protected]

Definition at line 84 of file ArServerData.h. Referenced by ArServerData(), callRequestChangedFunctor(), and getCommand().

std::string ArServerData::myCommandGroup [protected]

Definition at line 80 of file ArServerData.h. Referenced by ArServerData(), and getCommandGroup().

ArArgumentBuilder ArServerData::myDataFlagsBuilder [protected]

Definition at line 83 of file ArServerData.h. Referenced by addDataFlags(), ArServerData(), getDataFlagsString(), hasDataFlag(), and remDataFlag().

ArMutex ArServerData::myDataMutex [protected]

Definition at line 82 of file ArServerData.h. Referenced by addDataFlags(), hasDataFlag(), and remDataFlag().

std::string ArServerData::myDescription [protected]

Definition at line 77 of file ArServerData.h. Referenced by ArServerData(), and getDescription().

ArFunctor2<ArServerClient *, ArNetPacket *>* ArServerData::myFunctor [protected]

Definition at line 85 of file ArServerData.h. Referenced by ArServerData(), and getFunctor().

ArRetFunctor1<long, unsigned int>* ArServerData::myGetFrequencyFunctor [protected]

Definition at line 86 of file ArServerData.h. Referenced by ArServerData(), and callRequestChangedFunctor().

std::string ArServerData::myName [protected]

Definition at line 76 of file ArServerData.h. Referenced by ArServerData(), and getName().

std::string ArServerData::myRawDataFlags [protected]

Definition at line 81 of file ArServerData.h.

ArFunctor2<long, unsigned int>* ArServerData::myRequestChangedFunctor [protected]

Definition at line 87 of file ArServerData.h. Referenced by ArServerData(), and callRequestChangedFunctor().

ArFunctor2<ArServerClient *, ArNetPacket *>* ArServerData::myRequestOnceFunctor [protected]

Definition at line 88 of file ArServerData.h. Referenced by ArServerData(), and getRequestOnceFunctor().

std::string ArServerData::myReturnDescription [protected]

Definition at line 79 of file ArServerData.h. Referenced by ArServerData(), and getReturnDescription().

---

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

• ArServerData.h
• ArServerData.cpp

---