NLNET::IService Class Reference

#include <service.h>

---

Detailed Description

Base class for all network services. You must inherite from this class to create your own service. You must not create ctor and dtor but implement init() and release() methods. You have to create a global callback array called CallbackArray.

service_howto

Temporary command line arguments :

• -n

Author:

Vianney Lecroart

Olivier Cado

Nevrax France

Date:

2000

Definition at line 177 of file service.h.

get methods. These methods provide a way to read internal service variables.
std::string	getArg (char argName)
const std::vector< std::string > &	getArgs () const
	Returns arguments of the program pass from the user to the program using parameters (ie: "myprog param1 param2").
CCallbackNetBase::TRecordingState	getRecordingState () const
	Returns the recording state (don't needed if you use layer5).
const std::string &	getServiceAliasName () const
	Returns the current service alias name setted by AES.
TServiceId	getServiceId () const
	Returns the service identifier.
const std::string &	getServiceLongName () const
	Returns the current service long name (ie: test_serivce).
const std::string &	getServiceShortName () const
	Returns the current service short name (ie: TS).
std::string	getServiceUnifiedName () const
	Returns the current service unified name that is alias/short-id or short-id if alias is empty.
sint	getStatus () const
	Returns the status.
bool	haveArg (char argName)
	Returns true if the argument if present in the command line (ie: haveArg('p') will return true if -p is in the command line).
IService *	getInstance ()
	Returns the instance of the service to access to methods/variables class.
variables. These variables are used by the internal system.
std::string	_AliasName
std::vector< std::string >	_Args
	Array of arguments pass from the command line.
TUnifiedCallbackItem *	_CallbackArray
uint	_CallbackArraySize
bool	_DontUseAES
	true if the service don't use the admin executor service
bool	_DontUseNS
	true if the service don't use the naming service
bool	_Initialized
	true if the service initialisation is passed
std::string	_LongName
CCallbackNetBase::TRecordingState	_RecordingState
	Recording state.
bool	_ResetMeasures
	Require to reset the hierarchical timer.
uint32	_ShardId
	Shard Id.
std::string	_ShortName
	Current service name sets by the actual service when declaring NLNET_SERVICE_MAIN.
TServiceId	_SId
	the service id of this sevice
sint	_Status
	the status of this service (the status is give to the at the release time)
NLMISC::TTime	_UpdateTimeout
	Select timeout value in milliseconds between to call of user update().
NLMISC::CVariable< std::string >	ConfigDirectory
	The directory where the configfile is.
NLMISC::CVariable< uint16 >	ListeningPort
	Listening port of this service.
NLMISC::CVariable< std::string >	LogDirectory
	The directory where the logfiles are.
NLMISC::CVariable< std::string >	RunningDirectory
	The directory where the service is running.
NLMISC::CVariable< std::string >	Version
IService *	_Instance = NULL
	Instance of this service (singleton).
Public Member Functions
uint16	getPort ()
uint32	getShardId () const
void	setVersion (const std::string &version)
set methods. These methods provide a way to modify internal service variables.
void	exit (sint code=0x10)
void	setStatus (sint status)
void	setUpdateTimeout (NLMISC::TTime timeout)
User overload methods. These methods can be overload by the user do handle init, update and release operation.
virtual void	init ()
	Initializes the service (must be called before the first call to update()).
virtual void	release ()
	Finalization. Release the service. For example, this founction free all allocation made in the init() function.
virtual bool	update ()
	This function is called every "frame" (you must call init() before). It returns false if the service is stopped.
private methods. These methods are used by internal system but can't be put in private, don't use them.
	IService ()
	Ctor. You must not inherit ctor but overload init() function.
sint	main (const char *serviceShortName, const char *serviceLongName, uint16 servicePort, const char *configDir, const char *logDir, const char *compilationDate)
	This main is called by the macro (service5 says if we have to use layer5 or not).
void	requireResetMeasures ()
	Require to reset the hierarchical timer.
void	setArgs (const char *args)
	Sets the command line and init _Args variable. You must call this before calling main().
void	setArgs (int argc, const char **argv)
	Sets the command line and init _Args variable. You must call this before calling main().
void	setCallbackArray (TUnifiedCallbackItem *array, uint nbelem)
	Sets the default callback array given from the macro.
virtual	~IService ()
	Dtor. You must not inherit dtor but overload release() function.
Data Fields
NLMISC::CVariable< std::string >	SaveFilesDirectory
NLMISC::CWindowDisplayer *	WindowDisplayer
	The window displayer instance.
NLMISC::CVariable< std::string >	WriteFilesDirectory
variables. These variables can be read/modified by the user.
NLMISC::CLog	CommandLog
NLMISC::CConfigFile	ConfigFile
Private Member Functions
methods. These methods are used by internal system.
void	setRecordingState (CCallbackNetBase::TRecordingState rec)
	Changes the recording state (use if you know what you are doing).
Friends
void	cbAESConnection (const std::string &serviceName, uint16 sid, void *arg)
void	cbDirectoryChanged (const NLMISC::IVariable &var)
void	cbReceiveShardId (NLNET::CMessage &msgin, const std::string &serviceName, uint16 serviceId)
struct	getWinDisplayerInfoClass
void	serviceGetView (uint32 rid, const std::string &rawvarpath, std::vector< std::string > &vara, std::vector< std::string > &vala)
struct	serviceInfoClass

---

Constructor & Destructor Documentation

NLNET::IService::IService (   )

Ctor. You must not inherit ctor but overload init() function. Definition at line 278 of file service.cpp. References NLNET::cbDirectoryChanged(). : WindowDisplayer(0), WriteFilesDirectory("WriteFilesDirectory", "directory where to save generic shard information (packed_sheets for example)", ".", 0, true, cbDirectoryChanged), SaveFilesDirectory("SaveFilesDirectory", "directory where to save specific shard information (shard time for example)", ".", 0, true, cbDirectoryChanged), ListeningPort("ListeningPort", "listening port for this service", 0, 0, true), _RecordingState(CCallbackNetBase::Off), _UpdateTimeout(100), _SId(0), _Status(0), _Initialized(false), ConfigDirectory("ConfigDirectory", "directory where config files are", ".", 0, true, cbDirectoryChanged), LogDirectory("LogDirectory", "directory where the service is logging", ".", 0, true, cbDirectoryChanged), RunningDirectory("RunningDirectory", "directory where the service is running on", ".", 0, true, cbDirectoryChanged), Version("Version", "Version of the shard", ""), _CallbackArray (0), _CallbackArraySize (0), _DontUseNS(false), _DontUseAES(false), _ResetMeasures(false) { // Singleton _Instance = this; }

virtual NLNET::IService::~IService (   )  [inline, virtual]

Dtor. You must not inherit dtor but overload release() function. Definition at line 300 of file service.h. {}

---

Member Function Documentation

void NLNET::IService::exit (  sint  code = 0x10  )

Call this function if you want the service quits next loop. The code will be returned outside of the application. Warning: If you set the code to 0, it ll NOT exit the service Definition at line 1333 of file service.cpp. References NLNET::ExitSignalAsked, nlinfo, and sint. { nlinfo ("SERVICE: Somebody called IService::exit(), I have to quit"); ExitSignalAsked = code; }

string NLNET::IService::getArg (  char  argName  )

Returns the parameter linked to an option (ie: getArg('p') will return "toto" if -ptoto is in the command line) It'll thrown an Exception if the argName is not found Definition at line 319 of file service.cpp. References uint32. Referenced by main(). { for (uint32 i = 0; i < _Args.size(); i++) { if (_Args[i].size() >= 2 && _Args[i][0] == '-') { if (_Args[i][1] == argName) { return _Args[i].substr(2); } } } throw Exception ("Parameter '-%c' is not found in command line", argName); }

const std::vector<std::string>& NLNET::IService::getArgs (   )  const [inline]

Returns arguments of the program pass from the user to the program using parameters (ie: "myprog param1 param2"). Definition at line 221 of file service.h. { return _Args; }

IService* NLNET::IService::getInstance (   )  [inline, static]

Returns the instance of the service to access to methods/variables class. Definition at line 200 of file service.h. References nlassert. Referenced by NLAILINK::getLocalServerID(). { nlassert (_Instance != NULL); return _Instance; }

uint16 NLNET::IService::getPort (   )  [inline]

Definition at line 317 of file service.h. References ListeningPort, and uint16. { return ListeningPort; }

CCallbackNetBase::TRecordingState NLNET::IService::getRecordingState (   )  const [inline]

Returns the recording state (don't needed if you use layer5). Definition at line 238 of file service.h. { return _RecordingState; }

const std::string& NLNET::IService::getServiceAliasName (   )  const [inline]

Returns the current service alias name setted by AES. Definition at line 209 of file service.h. References _AliasName. { return _AliasName; };

TServiceId NLNET::IService::getServiceId (   )  const [inline]

Returns the service identifier. Definition at line 215 of file service.h. References _SId, and NLNET::TServiceId. { return _SId; }

const std::string& NLNET::IService::getServiceLongName (   )  const [inline]

Returns the current service long name (ie: test_serivce). Definition at line 206 of file service.h. References _LongName. Referenced by main(). { return _LongName; };

const std::string& NLNET::IService::getServiceShortName (   )  const [inline]

Returns the current service short name (ie: TS). Definition at line 203 of file service.h. References _ShortName. { return _ShortName; };

std::string NLNET::IService::getServiceUnifiedName (   )  const

Returns the current service unified name that is alias/short-id or short-id if alias is empty. Definition at line 1348 of file service.cpp. References _AliasName, _ShortName, _SId, nlassert, res, and NLMISC::toString(). { nlassert (!_ShortName.empty()); string res; if (!_AliasName.empty()) { res = _AliasName+"/"; } res += _ShortName; if (_SId != 0) { res += "-"; res += toString (_SId); } return res; }

uint32 NLNET::IService::getShardId (   )  const [inline]

Definition at line 319 of file service.h. References _ShardId, and uint32. { return _ShardId; }

sint NLNET::IService::getStatus (   )  const [inline]

Returns the status. Definition at line 218 of file service.h. References _Status, and sint. Referenced by main(). { return _Status; }

bool NLNET::IService::haveArg (  char  argName  )

Returns true if the argument if present in the command line (ie: haveArg('p') will return true if -p is in the command line). Definition at line 304 of file service.cpp. References uint32. Referenced by main(). { for (uint32 i = 0; i < _Args.size(); i++) { if (_Args[i].size() >= 2 && _Args[i][0] == '-') { if (_Args[i][1] == argName) { return true; } } } return false; }

virtual void NLNET::IService::init (  void   )  [inline, virtual]

Initializes the service (must be called before the first call to update()). Definition at line 185 of file service.h. Referenced by main(). {}

sint NLNET::IService::main (  const char *  serviceShortName, const char *  serviceLongName, uint16  servicePort, const char *  configDir, const char *  logDir, const char *  compilationDate )

This main is called by the macro (service5 says if we have to use layer5 or not). Layer5 Startup Definition at line 419 of file service.cpp. References _AliasName, _CallbackArraySize, _DontUseAES, _DontUseNS, _LongName, _ResetMeasures, _ShardId, _ShortName, _SId, _UpdateTimeout, CTimeoutAssertionThread::activate(), NLNET::CUnifiedNetwork::addCallbackArray(), NLMISC::CLog::addDisplayer(), NLMISC::CConfigFile::CVar::asInt(), NLMISC::AssertLog, NLNET::CInetAddress::asString(), NLMISC::CConfigFile::CVar::asString(), NLMISC::beep(), NLNET::Bench(), NLNET::builtinServiceCallbacks, NLNET::cbExecuteCommands(), NLNET::cbLogFilter(), NLMISC::changeLogDirectory(), NLMISC::CMemDisplayer::clear(), CommandLog, NLNET::CompilationDate, ConfigDirectory, ConfigFile, NLMISC::CWindowDisplayer::create(), NLMISC::CWindowDisplayer::createLabel(), NLMISC::DebugLog, CTimeoutAssertionThread::desactivate(), NLMISC::CLog::displayNL(), NLMISC::ErrorLog, NLMISC::CConfigFile::exists(), NLNET::ExitSignalAsked, getArg(), NLNET::CUnifiedNetwork::getInstance(), getServiceLongName(), getStatus(), NLMISC::CConfigFile::getVar(), NLMISC::CConfigFile::getVarPtr(), H_AUTO, haveArg(), NLMISC::InfoLog, init(), NLMISC::IVariable::init(), NLNET::initAdmin(), NLNET::initSignal(), IsDebuggerPresent, NLNET::LaunchingDate, ListeningPort, NLMISC::CConfigFile::load(), NLMISC::CMemDisplayer::lockStrings(), LogDirectory, NLNET::MyTAT, NLNET::NbUserUpdate, NLNET::NegFiltersNames, NLNET::NetSpeedLoop(), nlassert, nldebug, nlerror, nlinfo, NLMISC::nlSleep(), nlwarning, release(), NLMISC::CLog::removeDisplayer(), RunningDirectory, SaveFilesDirectory, NLNET::sendEmail(), NLMISC::setAssert(), NLMISC::CConfigFile::setCallback(), NLNET::setDefaultEmailParams(), NLMISC::CWindowDisplayer::setLabel(), NLMISC::CLog::setProcessName(), NLMISC::setReportEmailFunction(), NLMISC::CEntityId::setServiceId(), setStatus(), NLMISC::CWindowDisplayer::setTitleBar(), sint, sint32, size, NLMISC::CConfigFile::CVar::size(), NLMISC::strupr(), NLMISC::toString(), NLMISC::TTime, uint, uint16, uint32, uint64, uint8, NLMISC::CMemDisplayer::unlockStrings(), NLMISC::CWindowDisplayer::update(), update(), NLNET::updateAdmin(), NLNET::UserSpeedLoop(), v, w, NLMISC::WarningLog, WindowDisplayer, x, and y. { bool userInitCalled = false; // bool resyncEvenly = false; CConfigFile::CVar *var = NULL; // a short name service can't be a number nlassert (atoi(serviceShortName) == 0); try { // // Init parameters // _ShortName = serviceShortName; CLog::setProcessName (_ShortName); // get the path where to run the service if any in the command line if (haveArg('A')) RunningDirectory = CPath::standardizePath(getArg('A')); ConfigDirectory = CPath::standardizePath(configDir); LogDirectory = CPath::standardizePath(logDir); _LongName = serviceLongName; CompilationDate = compilationDate; LaunchingDate = CTime::getSecondsSince1970(); ListeningPort = servicePort; setReportEmailFunction ((void*)sendEmail); setDefaultEmailParams ("gw.nevrax.com", "", "lecroart@nevrax.com"); // // Load the config file // // get the config file dir if any in the command line if (haveArg('C')) ConfigDirectory = CPath::standardizePath(getArg('C')); string cfn = ConfigDirectory.c_str() + _LongName + ".cfg"; if (!CFile::fileExists(ConfigDirectory.c_str() + _LongName + ".cfg")) { // check if the default exists if (!CFile::fileExists(ConfigDirectory.c_str() + _LongName + "_default.cfg")) { nlerror ("SERVICE: The config file '%s' is not found, neither the default one, can't launch the service", cfn.c_str()); } else { // create the basic .cfg that link the default one FILE *fp = fopen (cfn.c_str(), "w"); if (fp == NULL) { nlerror ("SERVICE: Can't create config file '%s'", cfn.c_str()); } fprintf(fp, "// link the default config file for %s\n", _LongName.c_str()); fprintf(fp, "RootConfigFilename = \"%s_default.cfg\";\n", _LongName.c_str()); fclose (fp); } } ConfigFile.load (cfn); // setup variable with config file variable IVariable::init (ConfigFile); // we have to call this again because the config file can changed this variable but the cmd line is more prioritary if (haveArg('A')) RunningDirectory = CPath::standardizePath(getArg('A')); // // Init debug/log stuffs (must be first things otherwise we can't log if errors) // // get the log dir if any in the command line if (haveArg('L')) LogDirectory = CPath::standardizePath(getArg('L')); changeLogDirectory (LogDirectory); // we create the log with service name filename ("test_service.log" for example) fd.setParam (LogDirectory.c_str() + _LongName + ".log", false); DebugLog->addDisplayer (&fd); InfoLog->addDisplayer (&fd); WarningLog->addDisplayer (&fd); AssertLog->addDisplayer (&fd); ErrorLog->addDisplayer (&fd); CommandLog.addDisplayer (&fd, true); // // Init the hierarchical timer // CHTimer::startBench(false, true); CHTimer::endBench(); // // Set the assert mode // if (ConfigFile.exists ("Assert")) setAssert (ConfigFile.getVar("Assert").asInt() == 1); // // Set the shard Id // if ((var = ConfigFile.getVarPtr("NoWSShardId")) != NULL) { _ShardId = var->asInt(); } else { // something high enough as default _ShardId = 666; } // // Set the negative filter from the config file // for(const char **name = NegFiltersNames; *name; name++) { if ((var = ConfigFile.getVarPtr (*name)) != NULL) { ConfigFile.setCallback (*name, cbLogFilter); cbLogFilter(*var); } } ConfigFile.setCallback ("Commands", cbExecuteCommands); if ((var = ConfigFile.getVarPtr ("Commands")) != NULL) { cbExecuteCommands(*var); } // // Create the window if needed // if ((var = ConfigFile.getVarPtr ("WindowStyle")) != NULL) { string disp = var->asString (); #ifdef NL_USE_GTK if (disp == "GTK") { WindowDisplayer = new CGtkDisplayer ("DEFAULT_WD"); } #endif // NL_USE_GTK #ifdef NL_OS_WINDOWS if (disp == "WIN") { WindowDisplayer = new CWinDisplayer ("DEFAULT_WD"); } #endif // NL_OS_WINDOWS if (WindowDisplayer == NULL && disp != "NONE") { nlwarning ("SERVICE: Unknown value for the WindowStyle (should be GTK, WIN or NONE), use no window displayer"); } } vector <pair<string,uint> > displayedVariables; //uint speedNetLabel, speedUsrLabel, rcvLabel, sndLabel, rcvQLabel, sndQLabel, scrollLabel; if (WindowDisplayer != NULL) { // // Init window param if necessary // sint x=-1, y=-1, w=-1, h=-1, fs=10, history=-1; bool iconified = false, ww = false; string fn; if ((var = ConfigFile.getVarPtr("XWinParam")) != NULL) x = var->asInt(); if ((var = ConfigFile.getVarPtr("YWinParam")) != NULL) y = var->asInt(); if ((var = ConfigFile.getVarPtr("WWinParam")) != NULL) w = var->asInt(); if ((var = ConfigFile.getVarPtr("HWinParam")) != NULL) h = var->asInt(); if ((var = ConfigFile.getVarPtr("HistoryWinParam")) != NULL) history = var->asInt(); if ((var = ConfigFile.getVarPtr("IWinParam")) != NULL) iconified = var->asInt() == 1; if ((var = ConfigFile.getVarPtr("FontSize")) != NULL) fs = var->asInt(); if ((var = ConfigFile.getVarPtr("FontName")) != NULL) fn = var->asString(); if ((var = ConfigFile.getVarPtr("WordWrap")) != NULL) ww = var->asInt() == 1; if (haveArg('I')) iconified = true; WindowDisplayer->create (string("*INIT* ") + _ShortName + " " + _LongName, iconified, x, y, w, h, history, fs, fn, ww, &CommandLog); DebugLog->addDisplayer (WindowDisplayer); InfoLog->addDisplayer (WindowDisplayer); WarningLog->addDisplayer (WindowDisplayer); ErrorLog->addDisplayer (WindowDisplayer); AssertLog->addDisplayer (WindowDisplayer); CommandLog.addDisplayer(WindowDisplayer, true); // adding default displayed variables displayedVariables.push_back(make_pair(string("NetLop|NetSpeedLoop"), WindowDisplayer->createLabel ("NetLop"))); displayedVariables.push_back(make_pair(string("UsrLop|UserSpeedLoop"), WindowDisplayer->createLabel ("UsrLop"))); // displayedVariables.push_back(make_pair(string("Rcv|ReceivedBytes"), WindowDisplayer->createLabel ("Rcv"))); // displayedVariables.push_back(make_pair(string("Snd|SentBytes"), WindowDisplayer->createLabel ("Snd"))); // displayedVariables.push_back(make_pair(string("RcvQ|ReceivedQueueSize"), WindowDisplayer->createLabel ("RcvQ"))); // displayedVariables.push_back(make_pair(string("SndQ|SentQueueSize"), WindowDisplayer->createLabel ("SndQ"))); displayedVariables.push_back(make_pair(string("|Scroller"), WindowDisplayer->createLabel ("NeL Rulez"))); CConfigFile::CVar *v = ConfigFile.getVarPtr("DisplayedVariables"); if (v != NULL) { for (sint i = 0; i < v->size(); i++) { displayedVariables.push_back(make_pair(v->asString(i), WindowDisplayer->createLabel (v->asString(i).c_str()))); } } } nlinfo ("SERVICE: Starting Service '%s' using NeL ("__DATE__" "__TIME__") compiled %s", _ShortName.c_str(), CompilationDate.c_str()); nlinfo ("SERVICE: On OS: %s", CSystemInfo::getOS().c_str()); setStatus (EXIT_SUCCESS); // // Redirect signal if needed (in release mode only) // #ifdef NL_OS_WINDOWS #ifdef NL_RELEASE initSignal(); #else // don't install signal is the application is started in debug mode if (IsDebuggerPresent ()) { //nlinfo("Running with the debugger, don't redirect signals"); initSignal(); } else { //nlinfo("Running without the debugger, redirect SIGINT signal"); initSignal(); } #endif #else // NL_OS_UNIX initSignal(); #endif // // Ignore SIGPIPE (broken pipe) on unix system // #ifdef NL_OS_UNIX // Ignore the SIGPIPE signal sigset_t SigList; bool IgnoredPipe = true; if (sigemptyset (&SigList) == -1) { perror("sigemptyset()"); IgnoredPipe = false; } if (sigaddset (&SigList, SIGPIPE) == -1) { perror("sigaddset()"); IgnoredPipe = false; } if (sigprocmask (SIG_BLOCK, &SigList, NULL) == -1) { perror("sigprocmask()"); IgnoredPipe = false; } nldebug ("SERVICE: SIGPIPE %s", IgnoredPipe?"Ignored":"Not Ignored"); #endif // NL_OS_UNIX // // Initialize the network system // string localhost; try { // Initialize WSAStartup and network stuffs CSock::initNetwork(); // Get the localhost name localhost = CInetAddress::localHost().hostName(); } catch (NLNET::ESocket &) { localhost = "<UnknownHost>"; } // Set the localhost name and service name to the logger CLog::setProcessName (localhost+"/"+_ShortName); nlinfo ("SERVICE: Host: %s", localhost.c_str()); // // Initialize server parameters // // set the listen port if there are a port arg in the command line if (haveArg('P')) { ListeningPort = atoi(getArg('P').c_str()); } // set the aliasname if is present in the command line if (haveArg('N')) { _AliasName = getArg('N'); } // Load the recording state from the config file if ((var = ConfigFile.getVarPtr ("Rec")) != NULL) { string srecstate = var->asString(); strupr( srecstate ); if ( srecstate == "RECORD" ) { _RecordingState = CCallbackNetBase::Record; nlinfo( "SERVICE: Service recording messages" ); } else if ( srecstate == "REPLAY" ) { _RecordingState = CCallbackNetBase::Replay; nlinfo( "SERVICE: Service replaying messages" ); } else { _RecordingState = CCallbackNetBase::Off; } } else { // Not found _RecordingState = CCallbackNetBase::Off; } // Load the default stream format if ((var = ConfigFile.getVarPtr ("StringMsgFormat")) != NULL) { CMessage::setDefaultStringMode( var->asInt() == 1 ); } else { // Not found => binary CMessage::setDefaultStringMode( false ); } /* // // Layer4 Startup (Connect to the Naming Service (except for the NS itself and Login Service)) // if (IService::_ShortName != "NS" && IService::_ShortName != "LS" && IService::_ShortName != "AES" && IService::_ShortName != "AS") { bool ok = false; while (!ok) { // read the naming service address from the config file CInetAddress loc(ConfigFile.getVar("NSHost").asString(), ConfigFile.getVar("NSPort").asInt()); try { CNetManager::init( &loc, _RecordingState ); ok = true; } catch (ESocketConnectionFailed &) { nlwarning ("Could not connect to the Naming Service (%s). Retrying in a few seconds...", loc.asString().c_str()); nlSleep (5000); } } } else { CNetManager::init( NULL, _RecordingState ); } */ // get the sid if ((var = ConfigFile.getVarPtr ("SId")) != NULL) { sint32 sid = var->asInt(); if (sid<=0 || sid>255) { nlwarning("SERVICE: Bad SId value in the config file, %d is not in [0;255] range", sid); _SId = 0; } else { _SId = (uint8) sid; } } else { // ok, SId not found, use dynamic sid _SId = 0; } // look if we don't want to use NS if ((var = ConfigFile.getVarPtr ("DontUseNS")) != NULL) { // if we set the value in the config file, get it _DontUseNS = (var->asInt() == 1); } else { // if not, we use ns only if service is not ns, ls, aes, as _DontUseNS = false; } // // Register all network associations (must be before the CUnifiedNetwork::getInstance()->init) // if ((var = ConfigFile.getVarPtr ("Networks")) != NULL) { for (uint8 i = 0; i < var->size (); i++) CUnifiedNetwork::getInstance()->addNetworkAssociation (var->asString(i), i); } if ((var = ConfigFile.getVarPtr ("DefaultNetworks")) != NULL) { for (uint8 i = 0; i < var->size (); i++) CUnifiedNetwork::getInstance()->addDefaultNetwork(var->asString(i)); } // normal setup for the common services if (!_DontUseNS) { bool ok = false; while (!ok) { string LSAddr; if (haveArg('B')) { // if the naming service address is set on the command line, get it (overwrite the cfg) LSAddr = getArg('B'); } else { // else read the naming service address from the config file LSAddr = ConfigFile.getVar ("NSHost").asString(); } // if there's no port to the NS, use the default one 50000 if (LSAddr.find(":") == string::npos) LSAddr += ":50000"; CInetAddress loc(LSAddr); try { if ( CUnifiedNetwork::getInstance()->init (&loc, _RecordingState, _ShortName, ListeningPort, _SId) ) { ok = true; } else { nlinfo( "SERVICE: Exiting..." ); beep( 880, 400 ); beep( 440, 400 ); beep( 220, 400 ); return 10; } } catch (ESocketConnectionFailed &) { nlwarning ("SERVICE: Could not connect to the Naming Service (%s). Retrying in a few seconds...", loc.asString().c_str()); nlSleep (5000); } } } else { CUnifiedNetwork::getInstance()->init(NULL, _RecordingState, _ShortName, ListeningPort, _SId); } // At this point, the _SId must be ok if we use the naming service. // If it's 0, it means that we don't use NS and we left the other side server to find a sid for your connection if(!_DontUseNS) { nlassert (_SId != 0); } // // Connect to the local AES and send identification // // look if we don't want to use NS if ((var = ConfigFile.getVarPtr ("DontUseAES")) != NULL) { // if we set the value in the config file, get it _DontUseAES = var->asInt() == 1; } else { // if not, we use aes only if service is not aes or as _DontUseAES = false; } initAdmin (_DontUseAES); // // Add callback array // // add inner service callback array NLNET::CUnifiedNetwork::getInstance()->addCallbackArray(builtinServiceCallbacks, sizeof(builtinServiceCallbacks)/sizeof(builtinServiceCallbacks[0])); // add callback set in the NLNET_SERVICE_MAIN macro NLNET::CUnifiedNetwork::getInstance()->addCallbackArray(_CallbackArray, _CallbackArraySize); // // Now we have the service id, we can set the entites id generator // NLMISC::CEntityId::setServiceId(_SId); // Set the localhost name and service name and the sid CLog::setProcessName (localhost+"/"+_ShortName+"-"+toString((uint16)_SId)); // // Add default pathes // if ((var = ConfigFile.getVarPtr ("IgnoredFiles")) != NULL) { for (sint i = 0; i < var->size(); i++) { CPath::addIgnoredDoubleFile (var->asString(i)); } } if ((var = ConfigFile.getVarPtr ("Paths")) != NULL) { for (sint i = 0; i < var->size(); i++) { CPath::addSearchPath (var->asString(i), true, false); } } if ((var = ConfigFile.getVarPtr ("PathsNoRecurse")) != NULL) { for (sint i = 0; i < var->size(); i++) { CPath::addSearchPath (var->asString(i), false, false); } } // if we can, try to setup where to save files if (IService::getInstance()->haveArg('W')) { // use the command line param if set SaveFilesDirectory = IService::getInstance()->getArg('W'); } // // Call the user service init // userInitCalled = true; // the bool must be put *before* the call to init() init (); // // Connects to the present services // WARNING: only after the user init() was called because the // addService may call up service callbacks. // CUnifiedNetwork::getInstance()->connect(); // // Say to the AES that the service is ready // if (!_DontUseAES) { // send the ready message (service init finished) CMessage msgout ("SR"); CUnifiedNetwork::getInstance()->send("AES", msgout); } _Initialized = true; nlinfo ("SERVICE: Service initialised, executing StartCommands"); // // Call the user command from the config file if any // if ((var = ConfigFile.getVarPtr ("StartCommands")) != NULL) { for (sint i = 0; i < var->size(); i++) { ICommand::execute (var->asString(i), CommandLog); } } string str; CLog logDisplayVars; CLightMemDisplayer mdDisplayVars; logDisplayVars.addDisplayer (&mdDisplayVars); // // Activate the timeout assertion thread // IThread::create(&MyTAT)->start(); // // Set service ready // nlinfo ("SERVICE: Service ready"); if (WindowDisplayer != NULL) WindowDisplayer->setTitleBar (_ShortName + " " + _LongName + " " + Version.c_str()); // // Call the user service update each loop and check files and network activity // do { MyTAT.activate(); if(Bench) CHTimer::startBench(false, true, false); // count the amount of time to manage internal system TTime bbefore = CTime::getLocalTime (); // call the user update and exit if the user update asks it { H_AUTO(NLNETServiceUpdate); if (!update ()) { CHTimer::endBench(); break; } } // if the launching mode is 'quit after the first update' we set the exit signal if (haveArg('Q')) { ExitSignalAsked = 1; } NbUserUpdate++; // count the amount of time to manage internal system TTime before = CTime::getLocalTime (); if (WindowDisplayer != NULL) { // update the window displayer and quit if asked if (!WindowDisplayer->update ()) { nlinfo ("SERVICE: The window displayer was closed by user, need to quit"); ExitSignalAsked = 1; } } // stop the loop if the exit signal asked if (ExitSignalAsked > 0) { CHTimer::endBench(); break; } CConfigFile::checkConfigFiles (); updateAdmin (); CFile::checkFileChange(); // get and manage layer 5 messages CUnifiedNetwork::getInstance()->update (_UpdateTimeout); // resync the clock every hours // if (resyncEvenly) // { // static TTime LastSyncTime = CTime::getLocalTime (); //--------------------------------------- // To simulate Ctrl-C in the debugger... Exit after 1 min ! /*if (CTime::getLocalTime () - LastSyncTime > 60 * 1000 ) { ExitSignalAsked = 1; }*/ //--------------------------------------- /* if (CTime::getLocalTime () - LastSyncTime > 60*60*1000) { CUniTime::syncUniTimeFromService ( _RecordingState ); LastSyncTime = CTime::getLocalTime (); } */ // } NetSpeedLoop = (sint32) (CTime::getLocalTime () - before); UserSpeedLoop = (sint32) (before - bbefore); if (WindowDisplayer != NULL) { uint64 rcv, snd, rcvq, sndq; rcv = CUnifiedNetwork::getInstance()->getBytesReceived (); snd = CUnifiedNetwork::getInstance()->getBytesSent (); rcvq = CUnifiedNetwork::getInstance()->getReceiveQueueSize (); sndq = CUnifiedNetwork::getInstance()->getSendQueueSize (); for (uint i = 0; i < displayedVariables.size(); i++) { // it s a separator, do nothing if (displayedVariables[i].first.empty()) continue; // it s a command, do nothing if (displayedVariables[i].first[0] == '@') continue; string dispName = displayedVariables[i].first; string varName = dispName; uint32 pos = dispName.find("|"); if (pos != string::npos) { varName = displayedVariables[i].first.substr(pos+1); dispName = displayedVariables[i].first.substr(0, pos); } if (dispName.empty()) str = ""; else str = dispName + ": "; mdDisplayVars.clear (); ICommand::execute(varName, logDisplayVars, true); const std::deque<std::string> &strs = mdDisplayVars.lockStrings(); if (strs.size()>0) { str += strs[0].substr(0,strs[0].size()-1); /* string s_ = strs[0]; uint32 pos = strs[0].find("="); if(pos != string::npos && pos + 2 < strs[0].size()) { uint32 pos2 = string::npos; if(strs[0][strs[0].size()-1] == '\n') pos2 = strs[0].size() - pos - 2 - 1; str += strs[0].substr (pos+2, pos2); } else { str += "???"; }*/ } else { str += "???"; } mdDisplayVars.unlockStrings(); WindowDisplayer->setLabel (displayedVariables[i].second, str); } } // nldebug ("SYNC: updatetimeout must be %d and is %d, sleep the rest of the time", _UpdateTimeout, delta); CHTimer::endBench(); // Resetting the hierarchical timer must be done outside the top-level timer if ( _ResetMeasures ) { CHTimer::clear(); _ResetMeasures = false; } MyTAT.desactivate(); } while (true); } /* catch (ETrapDebug &) { // we have to do that if we want to trap unhandled exception with the report message box setStatus (EXIT_FAILURE); } */ catch (EFatalError &) { // Somebody call nlerror, so we have to quit now, the message already display // so we don't have to to anything setStatus (EXIT_FAILURE); } catch ( uint ) // SEH exceptions { ErrorLog->displayNL( "SERVICE: System exception" ); } #ifdef NL_RELEASE /* // in release mode, we catch everything to handle clean release. catch (Exception &e) { // Catch NeL exception to release the system cleanly setStatus (EXIT_FAILURE); nlinfo ("ERROR: NeL Exception: Error running the service \"%s\": %s", _ShortName.c_str(), e.what()); } catch (...) { // Catch anything we can to release the system cleanly setStatus (EXIT_FAILURE); nlinfo ("ERROR: Unknown external exception"); } */ #endif try { nlinfo ("SERVICE: Service starts releasing"); // // Call the user service release() if the init() was called // if (userInitCalled) release (); // // Delete all network connection (naming client also) // CUnifiedNetwork::getInstance()->release (); CSock::releaseNetwork (); // // Remove the window displayer // if (WindowDisplayer != NULL) { DebugLog->removeDisplayer (WindowDisplayer); InfoLog->removeDisplayer (WindowDisplayer); WarningLog->removeDisplayer (WindowDisplayer); ErrorLog->removeDisplayer (WindowDisplayer); AssertLog->removeDisplayer (WindowDisplayer); CommandLog.removeDisplayer (WindowDisplayer); delete WindowDisplayer; WindowDisplayer = NULL; } nlinfo ("SERVICE: Service released succesfuly"); } /* catch (ETrapDebug &) { // we have to do that if we want to trap unhandled exception with the report message box setStatus (EXIT_FAILURE); } */ catch (EFatalError &) { // Somebody call nlerror, so we have to quit now, the message already display // so we don't have to to anything setStatus (EXIT_FAILURE); } #ifdef NL_RELEASE /* // in release mode, we catch everything to handle clean release. catch (Exception &e) { setStatus (EXIT_FAILURE); nlinfo ("ERROR: NeL Exception: Error releasing the service \"%s\": %s", _ShortName.c_str(), e.what()); } catch (...) { // Catch anything we can to release the system cleanly setStatus (EXIT_FAILURE); nlinfo ("ERROR: Unknown external exception"); } */ #endif CHTimer::display(); CHTimer::displayByExecutionPath (); CHTimer::displayHierarchical(&CommandLog, true, 64); CHTimer::displayHierarchicalByExecutionPathSorted (&CommandLog, CHTimer::TotalTime, true, 64); nlinfo ("SERVICE: Service ends"); string name = getServiceLongName () + ".memory_report"; NLMEMORY::StatisticsReport (name.c_str(), false); return ExitSignalAsked?100+ExitSignalAsked:getStatus (); }

virtual void NLNET::IService::release (  void   )  [inline, virtual]

Finalization. Release the service. For example, this founction free all allocation made in the init() function. Definition at line 191 of file service.h. Referenced by main(). {}

void NLNET::IService::requireResetMeasures (   )

Require to reset the hierarchical timer. Definition at line 1342 of file service.cpp. References _ResetMeasures. { _ResetMeasures = true; }

void NLNET::IService::setArgs (  const char *  args  )

Sets the command line and init _Args variable. You must call this before calling main(). Definition at line 335 of file service.cpp. References uint32. { _Args.push_back ("<ProgramName>"); string sargs (args); uint32 pos1 = 0, pos2 = 0; do { pos1 = sargs.find_first_not_of (" ", pos2); if (pos1 == string::npos) break; pos2 = sargs.find_first_of (" ", pos1); _Args.push_back (sargs.substr (pos1, pos2-pos1)); } while (pos2 != string::npos); }

void NLNET::IService::setArgs (  int  argc, const char **  argv )

Sets the command line and init _Args variable. You must call this before calling main(). Definition at line 352 of file service.cpp. References sint. { for (sint i = 0; i < argc; i++) { _Args.push_back (argv[i]); } }

void NLNET::IService::setCallbackArray (  TUnifiedCallbackItem *  array, uint  nbelem )  [inline]

Sets the default callback array given from the macro. Definition at line 291 of file service.h. References _CallbackArraySize, and uint. { _CallbackArray = array; _CallbackArraySize = nbelem; }

void NLNET::IService::setRecordingState (  CCallbackNetBase::TRecordingState  rec  )  [inline, private]

Changes the recording state (use if you know what you are doing). Definition at line 327 of file service.h. { _RecordingState = rec; }

void NLNET::IService::setStatus (  sint  status  )  [inline]

Sets the status of the service, this status is return to the application. EXIT_SUCCESS is the default status You can set it to EXIT_FAILURE or any value you want. It's useful when you use the service in a script and you want to know the return value of the application to do the appropriate things. Definition at line 251 of file service.h. References _Status, and sint. Referenced by main(). { _Status = status; }

void NLNET::IService::setUpdateTimeout (  NLMISC::TTime  timeout  )  [inline]

Selects timeout value in seconds for each update. You are absolutely certain that your update() function will not be called before this amount of time you set. If you set the update timeout value higher than 0, all messages in queues will be process until the time greater than the timeout user update(). If you set the update timeout value to 0, all messages in queues will be process one time before calling the user update(). The default value is 100 (100ms) Definition at line 264 of file service.h. References _UpdateTimeout, and NLMISC::TTime. { /*if (timeout>1.0) nlerror ("IServer::setUpdateTimeout is now a double in SECOND and not ms");*/ _UpdateTimeout = timeout; }

void NLNET::IService::setVersion (  const std::string &  version  )  [inline]

Definition at line 315 of file service.h. { Version = version; }

virtual bool NLNET::IService::update (   )  [inline, virtual]

This function is called every "frame" (you must call init() before). It returns false if the service is stopped. Definition at line 188 of file service.h. Referenced by main(). { return true; }

---

Friends And Related Function Documentation

void cbAESConnection (  const std::string &  serviceName, uint16  sid, void *  arg )  [friend]

void cbDirectoryChanged (  const NLMISC::IVariable &  var  )  [friend]

void cbReceiveShardId (  NLNET::CMessage &  msgin, const std::string &  serviceName, uint16  serviceId )  [friend]

friend struct getWinDisplayerInfoClass [friend]

Definition at line 394 of file service.h.

void serviceGetView (  uint32  rid, const std::string &  rawvarpath, std::vector< std::string > &  vara, std::vector< std::string > &  vala )  [friend]

friend struct serviceInfoClass [friend]

Definition at line 393 of file service.h.

---

Field Documentation

std::string NLNET::IService::_AliasName [private]

Definition at line 347 of file service.h. Referenced by getServiceAliasName(), getServiceUnifiedName(), and main().

std::vector<std::string> NLNET::IService::_Args [private]

Array of arguments pass from the command line. Definition at line 336 of file service.h.

TUnifiedCallbackItem* NLNET::IService::_CallbackArray [private]

Definition at line 375 of file service.h.

uint NLNET::IService::_CallbackArraySize [private]

Definition at line 376 of file service.h. Referenced by main(), and setCallbackArray().

bool NLNET::IService::_DontUseAES [private]

true if the service don't use the admin executor service Definition at line 381 of file service.h. Referenced by main().

bool NLNET::IService::_DontUseNS [private]

true if the service don't use the naming service Definition at line 379 of file service.h. Referenced by main().

bool NLNET::IService::_Initialized [private]

true if the service initialisation is passed Definition at line 362 of file service.h.

IService * NLNET::IService::_Instance = NULL [static, private]

Instance of this service (singleton). Definition at line 115 of file service.cpp.

std::string NLNET::IService::_LongName [private]

Definition at line 346 of file service.h. Referenced by getServiceLongName(), and main().

CCallbackNetBase::TRecordingState NLNET::IService::_RecordingState [private]

Recording state. Definition at line 342 of file service.h.

bool NLNET::IService::_ResetMeasures [private]

Require to reset the hierarchical timer. Definition at line 384 of file service.h. Referenced by main(), and requireResetMeasures().

uint32 NLNET::IService::_ShardId [private]

Shard Id. Definition at line 387 of file service.h. Referenced by getShardId(), and main().

std::string NLNET::IService::_ShortName [private]

Current service name sets by the actual service when declaring NLNET_SERVICE_MAIN. Definition at line 345 of file service.h. Referenced by getServiceShortName(), getServiceUnifiedName(), and main().

TServiceId NLNET::IService::_SId [private]

the service id of this sevice Definition at line 356 of file service.h. Referenced by getServiceId(), getServiceUnifiedName(), and main().

sint NLNET::IService::_Status [private]

the status of this service (the status is give to the at the release time) Definition at line 359 of file service.h. Referenced by getStatus(), and setStatus().

NLMISC::TTime NLNET::IService::_UpdateTimeout [private]

Select timeout value in milliseconds between to call of user update(). Definition at line 353 of file service.h. Referenced by main(), and setUpdateTimeout().

NLMISC::CLog NLNET::IService::CommandLog

Definition at line 273 of file service.h. Referenced by main().

NLMISC::CVariable<std::string> NLNET::IService::ConfigDirectory [private]

The directory where the configfile is. Definition at line 365 of file service.h. Referenced by main().

NLMISC::CConfigFile NLNET::IService::ConfigFile

Definition at line 270 of file service.h. Referenced by main().

NLMISC::CVariable<uint16> NLNET::IService::ListeningPort [private]

Listening port of this service. Definition at line 339 of file service.h. Referenced by getPort(), and main().

NLMISC::CVariable<std::string> NLNET::IService::LogDirectory [private]

The directory where the logfiles are. Definition at line 368 of file service.h. Referenced by main().

NLMISC::CVariable<std::string> NLNET::IService::RunningDirectory [private]

The directory where the service is running. Definition at line 371 of file service.h. Referenced by main().

NLMISC::CVariable<std::string> NLNET::IService::SaveFilesDirectory

Directory where to store files that the services will write during the exploitation of the game (for example: player backup, string cache) Use .toString() to access to the value Definition at line 313 of file service.h. Referenced by main().

NLMISC::CVariable<std::string> NLNET::IService::Version [private]

Definition at line 373 of file service.h.

NLMISC::CWindowDisplayer* NLNET::IService::WindowDisplayer

The window displayer instance. Definition at line 305 of file service.h. Referenced by main().

NLMISC::CVariable<std::string> NLNET::IService::WriteFilesDirectory

Directory where to store files that the services will write but are the same for all shard instance (for example: packet_sheets) Use .toString() to access to the value Definition at line 309 of file service.h.

---

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

• service.h
• service.cpp

---