diff options
Diffstat (limited to 'docs/doxygen/nel/classNLNET_1_1IService.html')
| -rw-r--r-- | docs/doxygen/nel/classNLNET_1_1IService.html | 2015 |
1 files changed, 2015 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLNET_1_1IService.html b/docs/doxygen/nel/classNLNET_1_1IService.html new file mode 100644 index 00000000..ba039773 --- /dev/null +++ b/docs/doxygen/nel/classNLNET_1_1IService.html @@ -0,0 +1,2015 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>NLNET::IService Class Reference</h1>Base class for all network services. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="service_8h-source.html">service.h</a>></code> +<p> +<a href="classNLNET_1_1IService-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>get methods. These methods provide a way to read internal service variables.</h2></td></tr> +<tr><td nowrap align=right valign=top>const std::string & </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_0">getServiceShortName</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the current service short name (ie: TS).</em> <a href="#z350_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>const std::string & </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_1">getServiceLongName</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the current service long name (ie: test_serivce).</em> <a href="#z350_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>const std::string & </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_2">getServiceAliasName</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the current service alias name setted by AES.</em> <a href="#z350_2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_3">getServiceUnifiedName</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the current service unified name that is alias/short-id or short-id if alias is empty.</em> <a href="#z350_3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLNET.html#a19">TServiceId</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_4">getServiceId</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the service identifier.</em> <a href="#z350_4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a14">sint</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_5">getStatus</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the status.</em> <a href="#z350_5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>const std::vector< std::string > & </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_6">getArgs</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns arguments of the program pass from the user to the program using parameters (ie: "myprog param1 param2").</em> <a href="#z350_6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_7">haveArg</a> (char argName)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns true if the argument if present in the command line (ie: haveArg('p') will return true if -p is in the command line).</em> <a href="#z350_7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_8">getArg</a> (char argName)</td></tr> +<tr><td> </td><td><font size=-1><em>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.</em> <a href="#z350_8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a13">uint64</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_9">getEntityId</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> Type)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns an uniq id for an entities on this service.</em> <a href="#z350_9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLNET_1_1CCallbackServer.html">CCallbackServer</a> * </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_10">getServer</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns a pointer to the <a class="el" href="classNLNET_1_1CCallbackServer.html">CCallbackServer</a> object.</em> <a href="#z350_10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3">CCallbackNetBase::TRecordingState</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_11">getRecordingState</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the recording state (don't needed if you use layer5).</em> <a href="#z350_11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>IService * </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z350_12">IService::getInstance</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the instance of the service to access to methods/variables class.</em> <a href="#z350_12">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>variables. These variables can be read/modified by the user.</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z351_0">setStatus</a> (<a class="el" href="memory__common_8h.html#a14">sint</a> status)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the status of the service, this status is return to the application.</em> <a href="#z351_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z351_1">exit</a> (<a class="el" href="memory__common_8h.html#a14">sint</a> code=0x10)</td></tr> +<tr><td> </td><td><font size=-1><em>Call this function if you want the service quits next loop.</em> <a href="#z351_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z351_2">setUpdateTimeout</a> (<a class="el" href="namespaceNLMISC.html#a183">NLMISC::TTime</a> timeout)</td></tr> +<tr><td> </td><td><font size=-1><em>Selects timeout value in seconds for each update.</em> <a href="#z351_2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLMISC_1_1CConfigFile.html">NLMISC::CConfigFile</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z351_3">ConfigFile</a></td></tr> +<tr><td colspan=2><br><h2>variables. These variables are used by the internal system.</h2></td></tr> +<tr><td nowrap align=right valign=top>std::vector< std::string > </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_0">_Args</a></td></tr> +<tr><td> </td><td><font size=-1><em>Array of arguments pass from the command line.</em> <a href="#z354_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a9">uint16</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_1">_Port</a></td></tr> +<tr><td> </td><td><font size=-1><em>Listening port of this service.</em> <a href="#z354_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3">CCallbackNetBase::TRecordingState</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_2">_RecordingState</a></td></tr> +<tr><td> </td><td><font size=-1><em>Recording state.</em> <a href="#z354_2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_3">_ShortName</a></td></tr> +<tr><td> </td><td><font size=-1><em>Current service name sets by the actual service when declaring NLNET_SERVICE_MAIN.</em> <a href="#z354_3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_4">_LongName</a></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_5">_AliasName</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLMISC.html#a183">NLMISC::TTime</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_6">_UpdateTimeout</a></td></tr> +<tr><td> </td><td><font size=-1><em>Select timeout value in milliseconds between to call of user <a class="el" href="classNLNET_1_1IService.html#z349_1">update</a>().</em> <a href="#z354_6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLNET.html#a19">TServiceId</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_7">_SId</a></td></tr> +<tr><td> </td><td><font size=-1><em>the service id of this sevice.</em> <a href="#z354_7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a14">sint</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_8">_Status</a></td></tr> +<tr><td> </td><td><font size=-1><em>the status of this service (the status is give to the at the release time).</em> <a href="#z354_8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_9">_Initialized</a></td></tr> +<tr><td> </td><td><font size=-1><em>true if the service initialisation is passed.</em> <a href="#z354_9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="structNLMISC_1_1CEntityId.html">NLMISC::CEntityId</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_10">_NextEntityId</a></td></tr> +<tr><td> </td><td><font size=-1><em>This variable is used to generate uniq id for entities on this service.</em> <a href="#z354_10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_11">_ConfigDir</a></td></tr> +<tr><td> </td><td><font size=-1><em>The directory where the configfile is.</em> <a href="#z354_11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_12">_LogDir</a></td></tr> +<tr><td> </td><td><font size=-1><em>The directory where the logfiles are.</em> <a href="#z354_12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_13">_RunningPath</a></td></tr> +<tr><td> </td><td><font size=-1><em>The directory where the service is running.</em> <a href="#z354_13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_14">_Version</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="structNLNET_1_1TUnifiedCallbackItem.html">TUnifiedCallbackItem</a> * </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_15">_CallbackArray</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a15">uint</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_16">_CallbackArraySize</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_17">_DontUseNS</a></td></tr> +<tr><td> </td><td><font size=-1><em>true if the service don't use the naming service.</em> <a href="#z354_17">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_18">_DontUseAES</a></td></tr> +<tr><td> </td><td><font size=-1><em>true if the service don't use the admin executor service.</em> <a href="#z354_18">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_19">_ResetMeasures</a></td></tr> +<tr><td> </td><td><font size=-1><em>Require to reset the hierarchical timer.</em> <a href="#z354_19">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>IService * </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z354_20">_Instance</a> = NULL</td></tr> +<tr><td> </td><td><font size=-1><em>Instance of this service (singleton).</em> <a href="#z354_20">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#a0">setVersion</a> (const std::string &version)</td></tr> +<tr><td colspan="2"><div class="groupHeader">User overload methods. These methods can be overload by the user do handle init, update and release operation.</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z349_0">init</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Initializes the service (must be called before the first call to <a class="el" href="classNLNET_1_1IService.html#z349_1">update</a>()).</em> <a href="#z349_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z349_1">update</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>This function is called every "frame" (you must call <a class="el" href="classNLNET_1_1IService.html#z349_0">init</a>() before). It returns false if the service is stopped.</em> <a href="#z349_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z349_2">release</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Finalization. Release the service. For example, this founction free all allocation made in the <a class="el" href="classNLNET_1_1IService.html#z349_0">init</a>() function.</em> <a href="#z349_2">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">private methods. These methods are used by internal system but can't be put in private, don't use them.</div></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a14">sint</a> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z352_0">main</a> (const char *serviceShortName, const char *serviceLongName, <a class="el" href="memory__common_8h.html#a9">uint16</a> servicePort, const char *configDir, const char *logDir)</td></tr> +<tr><td> </td><td><font size=-1><em>This main is called by the macro (service5 says if we have to use layer5 or not).</em> <a href="#z352_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z352_1">setArgs</a> (int argc, const char **argv)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the command line and init _Args variable. You must call this before calling <a class="el" href="classNLNET_1_1IService.html#z352_0">main</a>().</em> <a href="#z352_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z352_2">setArgs</a> (const char *args)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the command line and init _Args variable. You must call this before calling <a class="el" href="classNLNET_1_1IService.html#z352_0">main</a>().</em> <a href="#z352_2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z352_3">setCallbackArray</a> (<a class="el" href="structNLNET_1_1TUnifiedCallbackItem.html">TUnifiedCallbackItem</a> *array, <a class="el" href="memory__common_8h.html#a15">uint</a> nbelem)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the default callback array given from the macro.</em> <a href="#z352_3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z352_4">requireResetMeasures</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Require to reset the hierarchical timer.</em> <a href="#z352_4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z352_5">IService</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Ctor. You must not inherit ctor but overload <a class="el" href="classNLNET_1_1IService.html#z349_0">init</a>() function.</em> <a href="#z352_5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z352_6">~IService</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Dtor. You must not inherit dtor but overload <a class="el" href="classNLNET_1_1IService.html#z349_2">release</a>() function.</em> <a href="#z352_6">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLMISC_1_1CWindowDisplayer.html">NLMISC::CWindowDisplayer</a> * </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#m0">WindowDisplayer</a></td></tr> +<tr><td> </td><td><font size=-1><em>The window displayer instance.</em> <a href="#m0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#m1">WriteFilesDirectory</a></td></tr> +<tr><td> </td><td><font size=-1><em>Directory where to store files that the services will write (for example, packet_sheets).</em> <a href="#m1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td colspan="2"><div class="groupHeader">methods. These methods are used by internal system.</div></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#z353_0">setRecordingState</a> (<a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3">CCallbackNetBase::TRecordingState</a> rec)</td></tr> +<tr><td> </td><td><font size=-1><em>Changes the recording state (use if you know what you are doing).</em> <a href="#z353_0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Friends</h2></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#l0">serviceInfoClass</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#l1">getWinDisplayerInfoClass</a></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#l2">serviceGetView</a> (<a class="el" href="memory__common_8h.html#a11">uint32</a> rid, const std::string &rawvarpath, std::vector< std::string > &vara, std::vector< std::string > &vala)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLNET_1_1IService.html#l3">AESConnection</a> (const std::string &serviceName, <a class="el" href="memory__common_8h.html#a9">uint16</a> sid, void *arg)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Base class for all network services. +<p> +You must inherite from this class to create your own service. You must not create ctor and dtor but implement <a class="el" href="classNLNET_1_1IService.html#z349_0">init</a>() and <a class="el" href="classNLNET_1_1IService.html#z349_2">release</a>() methods. You have to create a global callback array called CallbackArray. +<p> +<a href="service_howto.html#service_howto">How to create a service ?</a> +<p> +Temporary command line arguments : <ul> +<li> -n<AliasName></ul> +<dl compact><dt><b> +Author: </b><dd> +Vianney Lecroart , Olivier Cado , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2000 </dl> +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00168">168</a> of file <a class="el" href="service_8h-source.html">service.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="z352_5" doxytag="NLNET::IService::IService"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLNET::IService::IService </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Ctor. You must not inherit ctor but overload <a class="el" href="classNLNET_1_1IService.html#z349_0">init</a>() function. +<p> + +<p> +Definition at line <a class="el" href="service_8cpp-source.html#l00346">346</a> of file <a class="el" href="service_8cpp-source.html">service.cpp</a>. +<p> +References <a class="el" href="service_8cpp-source.html#l00105">_Instance</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. +<p> +Referenced by <a class="el" href="service_8h-source.html#l00191">IService::getInstance</a>. </td> + </tr> +</table> +<a name="z352_6" doxytag="NLNET::IService::~IService"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual NLNET::IService::~IService </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Dtor. You must not inherit dtor but overload <a class="el" href="classNLNET_1_1IService.html#z349_2">release</a>() function. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00293">293</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="z351_1" doxytag="NLNET::IService::exit"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::IService::exit </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a14">sint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>code</em> = 0x10 </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Call this function if you want the service quits next loop. +<p> +The code will be returned outside of the application. <dl compact><dt><b> +Warning: </b><dd> +If you set the code to 0, it ll NOT exit the service </dl> +<p> +Definition at line <a class="el" href="service_8cpp-source.html#l01301">1301</a> of file <a class="el" href="service_8cpp-source.html">service.cpp</a>. +<p> +References <a class="el" href="service_8cpp-source.html#l00107">NLNET::ExitSignalAsked</a>, and <a class="el" href="debug_8h-source.html#l00094">nlinfo</a>. </td> + </tr> +</table> +<a name="z350_8" doxytag="NLNET::IService::getArg"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> string NLNET::IService::getArg </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">char </td> + <td class="mdname1" valign="top" nowrap> <em>argName</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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. +<p> + +<p> +Definition at line <a class="el" href="service_8cpp-source.html#l00379">379</a> of file <a class="el" href="service_8cpp-source.html">service.cpp</a>. +<p> +References <a class="el" href="service_8h-source.html#l00320">_Args</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z350_6" doxytag="NLNET::IService::getArgs"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> const std::vector<std::string>& NLNET::IService::getArgs </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns arguments of the program pass from the user to the program using parameters (ie: "myprog param1 param2"). +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00212">212</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="z350_9" doxytag="NLNET::IService::getEntityId"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a13">uint64</a> NLNET::IService::getEntityId </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname1" valign="top" nowrap> <em>Type</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns an uniq id for an entities on this service. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00223">223</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +References <a class="el" href="entity__id_8h-source.html#l00195">NLMISC::CEntityId::getRawId</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00218">id</a>, and <a class="el" href="entity__id_8h-source.html#l00238">NLMISC::CEntityId::setType</a>. </td> + </tr> +</table> +<a name="z350_11" doxytag="NLNET::IService::getRecordingState"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3">CCallbackNetBase::TRecordingState</a> NLNET::IService::getRecordingState </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the recording state (don't needed if you use layer5). +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00234">234</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="z350_10" doxytag="NLNET::IService::getServer"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLNET_1_1CCallbackServer.html">CCallbackServer</a> * NLNET::IService::getServer </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns a pointer to the <a class="el" href="classNLNET_1_1CCallbackServer.html">CCallbackServer</a> object. +<p> + +<p> +Definition at line <a class="el" href="service_8cpp-source.html#l00423">423</a> of file <a class="el" href="service_8cpp-source.html">service.cpp</a>. </td> + </tr> +</table> +<a name="z350_2" doxytag="NLNET::IService::getServiceAliasName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> const std::string& NLNET::IService::getServiceAliasName </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the current service alias name setted by AES. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00200">200</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="z350_4" doxytag="NLNET::IService::getServiceId"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="namespaceNLNET.html#a19">TServiceId</a> NLNET::IService::getServiceId </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the service identifier. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00206">206</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +References <a class="el" href="naming__client_8h-source.html#l00042">NLNET::TServiceId</a>. </td> + </tr> +</table> +<a name="z350_1" doxytag="NLNET::IService::getServiceLongName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> const std::string& NLNET::IService::getServiceLongName </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the current service long name (ie: test_serivce). +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00197">197</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="z350_0" doxytag="NLNET::IService::getServiceShortName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> const std::string& NLNET::IService::getServiceShortName </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the current service short name (ie: TS). +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00194">194</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="z350_3" doxytag="NLNET::IService::getServiceUnifiedName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLNET::IService::getServiceUnifiedName </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const</td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the current service unified name that is alias/short-id or short-id if alias is empty. +<p> + +<p> +Definition at line <a class="el" href="service_8cpp-source.html#l01316">1316</a> of file <a class="el" href="service_8cpp-source.html">service.cpp</a>. +<p> +References <a class="el" href="service_8h-source.html#l00331">_AliasName</a>, <a class="el" href="service_8h-source.html#l00329">_ShortName</a>, <a class="el" href="service_8h-source.html#l00340">_SId</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00815">res</a>. </td> + </tr> +</table> +<a name="z350_5" doxytag="NLNET::IService::getStatus"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a14">sint</a> NLNET::IService::getStatus </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the status. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00209">209</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z350_7" doxytag="NLNET::IService::haveArg"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLNET::IService::haveArg </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">char </td> + <td class="mdname1" valign="top" nowrap> <em>argName</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns true if the argument if present in the command line (ie: haveArg('p') will return true if -p is in the command line). +<p> + +<p> +Definition at line <a class="el" href="service_8cpp-source.html#l00364">364</a> of file <a class="el" href="service_8cpp-source.html">service.cpp</a>. +<p> +References <a class="el" href="service_8h-source.html#l00320">_Args</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z349_0" doxytag="NLNET::IService::init"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLNET::IService::init </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Initializes the service (must be called before the first call to <a class="el" href="classNLNET_1_1IService.html#z349_1">update</a>()). +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00176">176</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z350_12" doxytag="NLNET::IService::IService::getInstance"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> IService* NLNET::IService::IService::getInstance </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the instance of the service to access to methods/variables class. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00191">191</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +References <a class="el" href="service_8cpp-source.html#l00105">_Instance</a>, <a class="el" href="service_8cpp-source.html#l00346">IService</a>, <a class="el" href="service_8h-source.html#l00191">IService::getInstance</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. +<p> +Referenced by <a class="el" href="service_8h-source.html#l00191">IService::getInstance</a>. </td> + </tr> +</table> +<a name="z352_0" doxytag="NLNET::IService::main"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a14">sint</a> NLNET::IService::main </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname" nowrap> <em>serviceShortName</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>serviceLongName</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a9">uint16</a> </td> + <td class="mdname" nowrap> <em>servicePort</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>configDir</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>logDir</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This main is called by the macro (service5 says if we have to use layer5 or not). +<p> + +<p> +Definition at line <a class="el" href="service_8cpp-source.html#l00473">473</a> of file <a class="el" href="service_8cpp-source.html">service.cpp</a>. +<p> +References <a class="el" href="service_8h-source.html#l00331">_AliasName</a>, <a class="el" href="service_8h-source.html#l00362">_CallbackArray</a>, <a class="el" href="service_8h-source.html#l00363">_CallbackArraySize</a>, <a class="el" href="service_8h-source.html#l00352">_ConfigDir</a>, <a class="el" href="service_8h-source.html#l00368">_DontUseAES</a>, <a class="el" href="service_8h-source.html#l00366">_DontUseNS</a>, <a class="el" href="service_8h-source.html#l00346">_Initialized</a>, <a class="el" href="service_8h-source.html#l00355">_LogDir</a>, <a class="el" href="service_8h-source.html#l00330">_LongName</a>, <a class="el" href="service_8h-source.html#l00349">_NextEntityId</a>, <a class="el" href="service_8h-source.html#l00323">_Port</a>, <a class="el" href="service_8h-source.html#l00326">_RecordingState</a>, <a class="el" href="service_8h-source.html#l00371">_ResetMeasures</a>, <a class="el" href="service_8h-source.html#l00358">_RunningPath</a>, <a class="el" href="service_8h-source.html#l00329">_ShortName</a>, <a class="el" href="service_8h-source.html#l00340">_SId</a>, <a class="el" href="service_8h-source.html#l00337">_UpdateTimeout</a>, <a class="el" href="service_8h-source.html#l00360">_Version</a>, <a class="el" href="service_8cpp-source.html#l00263">NLNET::AESCallbackArray</a>, <a class="el" href="classNLNET_1_1IService.html#l3">AESConnection</a>, <a class="el" href="service_8cpp-source.html#l00237">NLNET::AESDisconnection</a>, <a class="el" href="debug_8cpp-source.html#l00090">NLMISC::AssertLog</a>, <a class="el" href="service_8cpp-source.html#l00430">NLNET::cbLogFilter</a>, <a class="el" href="service_8h-source.html#l00266">ConfigFile</a>, <a class="el" href="window__displayer_8cpp-source.html#l00118">NLMISC::CWindowDisplayer::create</a>, <a class="el" href="debug_8cpp-source.html#l00774">NLMISC::createDebug</a>, <a class="el" href="window__displayer_8cpp-source.html#l00094">NLMISC::CWindowDisplayer::createLabel</a>, <a class="el" href="debug_8cpp-source.html#l00089">NLMISC::DebugLog</a>, <a class="el" href="debug_8cpp-source.html#l00086">NLMISC::ErrorLog</a>, <a class="el" href="service_8cpp-source.html#l00107">NLNET::ExitSignalAsked</a>, <a class="el" href="service_8cpp-source.html#l00379">getArg</a>, <a class="el" href="unified__network_8cpp-source.html#l01397">NLNET::CUnifiedNetwork::getInstance</a>, <a class="el" href="service_8h-source.html#l00209">getStatus</a>, <a class="el" href="config__file_8cpp-source.html#l00364">NLMISC::CConfigFile::getVar</a>, <a class="el" href="config__file_8cpp-source.html#l00388">NLMISC::CConfigFile::getVarPtr</a>, <a class="el" href="service_8cpp-source.html#l00364">haveArg</a>, <a class="el" href="debug_8cpp-source.html#l00088">NLMISC::InfoLog</a>, <a class="el" href="service_8h-source.html#l00176">init</a>, <a class="el" href="service_8cpp-source.html#l00322">NLNET::initSignal</a>, <a class="el" href="displayer_8cpp-source.html#l00059">IsDebuggerPresent</a>, <a class="el" href="config__file_8cpp-source.html#l00226">NLMISC::CConfigFile::load</a>, <a class="el" href="service_8cpp-source.html#l00110">NLNET::NetSpeedLoop</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="debug_8h-source.html#l00087">nldebug</a>, <a class="el" href="debug_8h-source.html#l00094">nlinfo</a>, <a class="el" href="common_8cpp-source.html#l00065">NLMISC::nlSleep</a>, <a class="el" href="debug_8h-source.html#l00114">nlwarning</a>, <a class="el" href="service_8h-source.html#l00182">release</a>, <a class="el" href="config__file_8cpp-source.html#l00570">NLMISC::CConfigFile::setCallback</a>, <a class="el" href="email_8cpp-source.html#l00310">NLNET::setDefaultEmailParams</a>, <a class="el" href="window__displayer_8cpp-source.html#l00105">NLMISC::CWindowDisplayer::setLabel</a>, <a class="el" href="report_8cpp-source.html#l00065">NLMISC::setReportEmailFunction</a>, <a class="el" href="entity__id_8h-source.html#l00387">NLMISC::CEntityId::setServiceId</a>, <a class="el" href="service_8h-source.html#l00247">setStatus</a>, <a class="el" href="window__displayer_8h-source.html#l00071">NLMISC::CWindowDisplayer::setTitleBar</a>, <a class="el" href="time__nl_8h-source.html#l00047">NLMISC::TTime</a>, <a class="el" href="window__displayer_8cpp-source.html#l00076">NLMISC::CWindowDisplayer::update</a>, <a class="el" href="service_8h-source.html#l00179">update</a>, <a class="el" href="service_8cpp-source.html#l00110">NLNET::UserSpeedLoop</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00234">v</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00233">w</a>, <a class="el" href="debug_8cpp-source.html#l00087">NLMISC::WarningLog</a>, <a class="el" href="service_8h-source.html#l00298">WindowDisplayer</a>, <a class="el" href="service_8h-source.html#l00301">WriteFilesDirectory</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00233">x</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00233">y</a>. </td> + </tr> +</table> +<a name="z349_2" doxytag="NLNET::IService::release"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLNET::IService::release </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Finalization. Release the service. For example, this founction free all allocation made in the <a class="el" href="classNLNET_1_1IService.html#z349_0">init</a>() function. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00182">182</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z352_4" doxytag="NLNET::IService::requireResetMeasures"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::IService::requireResetMeasures </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Require to reset the hierarchical timer. +<p> + +<p> +Definition at line <a class="el" href="service_8cpp-source.html#l01310">1310</a> of file <a class="el" href="service_8cpp-source.html">service.cpp</a>. +<p> +References <a class="el" href="service_8h-source.html#l00371">_ResetMeasures</a>. </td> + </tr> +</table> +<a name="z352_2" doxytag="NLNET::IService::setArgs"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::IService::setArgs </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname1" valign="top" nowrap> <em>args</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the command line and init _Args variable. You must call this before calling <a class="el" href="classNLNET_1_1IService.html#z352_0">main</a>(). +<p> + +<p> +Definition at line <a class="el" href="service_8cpp-source.html#l00395">395</a> of file <a class="el" href="service_8cpp-source.html">service.cpp</a>. +<p> +References <a class="el" href="service_8h-source.html#l00320">_Args</a>. </td> + </tr> +</table> +<a name="z352_1" doxytag="NLNET::IService::setArgs"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::IService::setArgs </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname" nowrap> <em>argc</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const char ** </td> + <td class="mdname" nowrap> <em>argv</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the command line and init _Args variable. You must call this before calling <a class="el" href="classNLNET_1_1IService.html#z352_0">main</a>(). +<p> + +<p> +Definition at line <a class="el" href="service_8cpp-source.html#l00412">412</a> of file <a class="el" href="service_8cpp-source.html">service.cpp</a>. +<p> +References <a class="el" href="service_8h-source.html#l00320">_Args</a>. </td> + </tr> +</table> +<a name="z352_3" doxytag="NLNET::IService::setCallbackArray"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::IService::setCallbackArray </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="structNLNET_1_1TUnifiedCallbackItem.html">TUnifiedCallbackItem</a> * </td> + <td class="mdname" nowrap> <em>array</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>nbelem</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the default callback array given from the macro. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00284">284</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="z353_0" doxytag="NLNET::IService::setRecordingState"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::IService::setRecordingState </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3">CCallbackNetBase::TRecordingState</a> </td> + <td class="mdname1" valign="top" nowrap> <em>rec</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, private]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Changes the recording state (use if you know what you are doing). +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00311">311</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="z351_0" doxytag="NLNET::IService::setStatus"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::IService::setStatus </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a14">sint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>status</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the status of the service, this status is return to the application. +<p> +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. +<p> +Definition at line <a class="el" href="service_8h-source.html#l00247">247</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z351_2" doxytag="NLNET::IService::setUpdateTimeout"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::IService::setUpdateTimeout </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLMISC.html#a183">NLMISC::TTime</a> </td> + <td class="mdname1" valign="top" nowrap> <em>timeout</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Selects timeout value in seconds for each update. +<p> +You are absolutely certain that your <a class="el" href="classNLNET_1_1IService.html#z349_1">update</a>() 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 <a class="el" href="classNLNET_1_1IService.html#z349_1">update</a>(). If you set the update timeout value to 0, all messages in queues will be process one time before calling the user <a class="el" href="classNLNET_1_1IService.html#z349_1">update</a>(). +<p> +The default value is 100 (100ms) +<p> +Definition at line <a class="el" href="service_8h-source.html#l00260">260</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="a0" doxytag="NLNET::IService::setVersion"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::IService::setVersion </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>version</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00303">303</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="z349_1" doxytag="NLNET::IService::update"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool NLNET::IService::update </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This function is called every "frame" (you must call <a class="el" href="classNLNET_1_1IService.html#z349_0">init</a>() before). It returns false if the service is stopped. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00179">179</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<hr><h2>Friends And Related Function Documentation</h2> +<a name="l3" doxytag="NLNET::IService::AESConnection"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void AESConnection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname" nowrap> <em>serviceName</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a9">uint16</a> </td> + <td class="mdname" nowrap> <em>sid</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>arg</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [friend]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="l1" doxytag="NLNET::IService::getWinDisplayerInfoClass"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> friend struct getWinDisplayerInfoClass<code> [friend]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00378">378</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="l2" doxytag="NLNET::IService::serviceGetView"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void serviceGetView </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a11">uint32</a> </td> + <td class="mdname" nowrap> <em>rid</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const std::string & </td> + <td class="mdname" nowrap> <em>rawvarpath</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>std::vector< std::string > & </td> + <td class="mdname" nowrap> <em>vara</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>std::vector< std::string > & </td> + <td class="mdname" nowrap> <em>vala</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [friend]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a name="l0" doxytag="NLNET::IService::serviceInfoClass"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> friend struct serviceInfoClass<code> [friend]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00377">377</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="z354_5" doxytag="NLNET::IService::_AliasName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLNET::IService::_AliasName<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00331">331</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l01316">getServiceUnifiedName</a>, and <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_0" doxytag="NLNET::IService::_Args"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::vector<std::string> NLNET::IService::_Args<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Array of arguments pass from the command line. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00320">320</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00379">getArg</a>, <a class="el" href="service_8cpp-source.html#l00364">haveArg</a>, and <a class="el" href="service_8cpp-source.html#l00395">setArgs</a>. </td> + </tr> +</table> +<a name="z354_15" doxytag="NLNET::IService::_CallbackArray"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="structNLNET_1_1TUnifiedCallbackItem.html">TUnifiedCallbackItem</a>* NLNET::IService::_CallbackArray<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00362">362</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_16" doxytag="NLNET::IService::_CallbackArraySize"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a15">uint</a> NLNET::IService::_CallbackArraySize<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00363">363</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_11" doxytag="NLNET::IService::_ConfigDir"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLNET::IService::_ConfigDir<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The directory where the configfile is. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00352">352</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_18" doxytag="NLNET::IService::_DontUseAES"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLNET::IService::_DontUseAES<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +true if the service don't use the admin executor service. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00368">368</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_17" doxytag="NLNET::IService::_DontUseNS"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLNET::IService::_DontUseNS<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +true if the service don't use the naming service. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00366">366</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_9" doxytag="NLNET::IService::_Initialized"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLNET::IService::_Initialized<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +true if the service initialisation is passed. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00346">346</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_20" doxytag="NLNET::IService::_Instance"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> IService * NLNET::IService::_Instance = NULL<code> [static, private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Instance of this service (singleton). +<p> + +<p> +Definition at line <a class="el" href="service_8cpp-source.html#l00105">105</a> of file <a class="el" href="service_8cpp-source.html">service.cpp</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00346">IService</a>, and <a class="el" href="service_8h-source.html#l00191">IService::getInstance</a>. </td> + </tr> +</table> +<a name="z354_12" doxytag="NLNET::IService::_LogDir"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLNET::IService::_LogDir<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The directory where the logfiles are. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00355">355</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_4" doxytag="NLNET::IService::_LongName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLNET::IService::_LongName<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00330">330</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_10" doxytag="NLNET::IService::_NextEntityId"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="structNLMISC_1_1CEntityId.html">NLMISC::CEntityId</a> NLNET::IService::_NextEntityId<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This variable is used to generate uniq id for entities on this service. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00349">349</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_1" doxytag="NLNET::IService::_Port"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a9">uint16</a> NLNET::IService::_Port<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Listening port of this service. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00323">323</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_2" doxytag="NLNET::IService::_RecordingState"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLNET_1_1CCallbackNetBase.html#s3">CCallbackNetBase::TRecordingState</a> NLNET::IService::_RecordingState<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Recording state. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00326">326</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_19" doxytag="NLNET::IService::_ResetMeasures"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLNET::IService::_ResetMeasures<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Require to reset the hierarchical timer. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00371">371</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>, and <a class="el" href="service_8cpp-source.html#l01310">requireResetMeasures</a>. </td> + </tr> +</table> +<a name="z354_13" doxytag="NLNET::IService::_RunningPath"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLNET::IService::_RunningPath<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The directory where the service is running. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00358">358</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_3" doxytag="NLNET::IService::_ShortName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLNET::IService::_ShortName<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Current service name sets by the actual service when declaring NLNET_SERVICE_MAIN. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00329">329</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l01316">getServiceUnifiedName</a>, and <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_7" doxytag="NLNET::IService::_SId"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="namespaceNLNET.html#a19">TServiceId</a> NLNET::IService::_SId<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +the service id of this sevice. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00340">340</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l01316">getServiceUnifiedName</a>, and <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_8" doxytag="NLNET::IService::_Status"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a14">sint</a> NLNET::IService::_Status<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +the status of this service (the status is give to the at the release time). +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00343">343</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="z354_6" doxytag="NLNET::IService::_UpdateTimeout"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="namespaceNLMISC.html#a183">NLMISC::TTime</a> NLNET::IService::_UpdateTimeout<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Select timeout value in milliseconds between to call of user <a class="el" href="classNLNET_1_1IService.html#z349_1">update</a>(). +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00337">337</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z354_14" doxytag="NLNET::IService::_Version"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLNET::IService::_Version<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00360">360</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="z351_3" doxytag="NLNET::IService::ConfigFile"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLMISC_1_1CConfigFile.html">NLMISC::CConfigFile</a> NLNET::IService::ConfigFile + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00266">266</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="m0" doxytag="NLNET::IService::WindowDisplayer"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLMISC_1_1CWindowDisplayer.html">NLMISC::CWindowDisplayer</a>* NLNET::IService::WindowDisplayer + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The window displayer instance. +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00298">298</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<a name="m1" doxytag="NLNET::IService::WriteFilesDirectory"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string NLNET::IService::WriteFilesDirectory + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Directory where to store files that the services will write (for example, packet_sheets). +<p> + +<p> +Definition at line <a class="el" href="service_8h-source.html#l00301">301</a> of file <a class="el" href="service_8h-source.html">service.h</a>. +<p> +Referenced by <a class="el" href="service_8cpp-source.html#l00473">main</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="service_8h-source.html">service.h</a><li><a class="el" href="service_8cpp-source.html">service.cpp</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |