diff options
Diffstat (limited to 'docs/doxygen/nel/class_NLNET__IService.html')
| -rw-r--r-- | docs/doxygen/nel/class_NLNET__IService.html | 1169 |
1 files changed, 1169 insertions, 0 deletions
diff --git a/docs/doxygen/nel/class_NLNET__IService.html b/docs/doxygen/nel/class_NLNET__IService.html new file mode 100644 index 00000000..0032badb --- /dev/null +++ b/docs/doxygen/nel/class_NLNET__IService.html @@ -0,0 +1,1169 @@ +<!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.2 on Sat May 26 22:35:05 2001 --> +<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_h-source.html">service.h</a>></code> +<p> +Inheritance diagram for NLNET::IService<p><center><img src="class_NLNET__IService_inherit_graph.gif" border="0" usemap="#NLNET::IService_inherit_map" alt="Inheritance graph"></center> +<map name="NLNET::IService_inherit_map"> +<area href="class_CChatService.html" shape="rect" coords="0,67,85,86"> +<area href="class_CFrontEndService.html" shape="rect" coords="109,67,221,86"> +</map> +<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for NLNET::IService:<p><center><img src="class_NLNET__IService_coll_graph.gif" border="0" usemap="#NLNET::IService_coll_map" alt="Collaboration graph"></center> +<map name="NLNET::IService_coll_map"> +<area href="class_NLMISC__CConfigFile.html" shape="rect" coords="19,83,155,101"> +<area href="class_NLMISC__CConfigFile__CVar.html" shape="rect" coords="0,0,173,19"> +<area href="class_NLNET__TCallbackItem.html" shape="rect" coords="285,83,429,101"> +</map> +<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_NLNET__IService-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#a0">IService</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#a0">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="class_NLNET__IService.html#a1">~IService</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#a2">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="class_NLNET__IService.html#a3">update</a>()).</em> <a href="#a2">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="class_NLNET__IService.html#a3">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="class_NLNET__IService.html#a2">init</a>() before). It returns false if the service is stopped.</em> <a href="#a3">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="class_NLNET__IService.html#a4">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="class_NLNET__IService.html#a2">init</a>() function.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespace_NLNET.html#a10">NLNET::TServiceId</a> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#a5">serviceId</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the service identifier.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="types_nl_h.html#a12">sint</a> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#a6">getStatus</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the status.</em> <a href="#a6">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="class_NLNET__IService.html#a7">setStatus</a> (<a class="el" href="types_nl_h.html#a12">sint</a> status)</td></tr> +<tr><td> </td><td><font size=-1><em>Set 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.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="types_nl_h.html#a12">sint</a> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#a8">main</a> (int argc, char **argv)</td></tr> +<tr><td> </td><td><font size=-1><em>User must just have to call this function in his main C function.</em> <a href="#a8">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="class_NLNET__IService.html#a9">setCallbackArray</a> (<a class="el" href="class_NLNET__TCallbackItem.html">TCallbackItem</a> *callbackArray, <a class="el" href="types_nl_h.html#a7">uint16</a> callbackArraySize)</td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#d0">serviceName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the current service name.</em> <a href="#d0">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="class_NLNET__IService.html#d1">setServiceName</a> (const char *shortName, const char *longName)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#d2">setPort</a> (<a class="el" href="types_nl_h.html#a7">uint16</a> Port)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#d3">setUpdateTimeout</a> (<a class="el" href="types_nl_h.html#a9">uint32</a> timeout)</td></tr> +<tr><td> </td><td><font size=-1><em>Select timeout value in milliseconds for each update.</em> <a href="#d3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="class_NLNET__CCallbackServer.html">CCallbackServer</a>* </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#d4">getServer</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns a pointer to the <a class="el" href="class_NLNET__CCallbackServer.html">CCallbackServer</a> object.</em> <a href="#d4">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="class_NLMISC__CConfigFile.html">NLMISC::CConfigFile</a> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#p0">ConfigFile</a></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#b0">getCustomParams</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Process command line arguments for port and timeout.</em> <a href="#b0">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="class_NLNET__IService.html#b1">setServiceId</a> (<a class="el" href="namespace_NLNET.html#a10">NLNET::TServiceId</a> sid)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the service identifier.</em> <a href="#b1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>std::vector<std::string> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#n0">_Args</a></td></tr> +<tr><td> </td><td><font size=-1><em>Array of arguments.</em> <a href="#n0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="types_nl_h.html#a7">uint16</a> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#n1">_Port</a></td></tr> +<tr><td> </td><td><font size=-1><em>Port for listening.</em> <a href="#n1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>IService* </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#q3">Instance</a> = NULL</td></tr> +<tr><td> </td><td><font size=-1><em>Singleton.</em> <a href="#q3">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Static members that must be defined by the deriver class</div></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#q0">_ShortName</a> = ""</td></tr> +<tr><td> </td><td><font size=-1><em>Current service name. Is set by the actual service when declaring NLNET_SERVICE_MAIN.</em> <a href="#q0">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="class_NLNET__IService.html#q1">_LongName</a> = ""</td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="types_nl_h.html#a7">uint16</a> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#q2">_DefaultPort</a> = 0</td></tr> +<tr><td> </td><td><font size=-1><em>Current service default port. Must be set by the deriver class.</em> <a href="#q2">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespace_NLNET.html#a10">TServiceId</a> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#o0">_SId</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="types_nl_h.html#a12">sint</a> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#o1">_Status</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#o2">_Initialized</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="class_NLNET__TCallbackItem.html">TCallbackItem</a>* </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#o3">_CallbackArray</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="types_nl_h.html#a7">uint16</a> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#o4">_CallbackArraySize</a></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="types_nl_h.html#a9">uint32</a> </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#r0">_UpdateTimeout</a> = 1</td></tr> +<tr><td> </td><td><font size=-1><em>Select timeout value in milliseconds.</em> <a href="#r0">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>void </td><td valign=bottom><a class="el" href="class_NLNET__IService.html#l0">AESConnection</a> (const std::string &serviceName, <a class="el" href="namespace_NLNET.html#a0">TSockId</a> <a class="el" href="ytable_cpp.html#a128">from</a>, 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="class_NLNET__IService.html#a2">init</a>() and <a class="el" href="class_NLNET__IService.html#a4">release</a>() methods. You have to create a global callback array called CallbackArray. +<p> +service_howto +<p> +Temporary command line arguments : <ul> +<li> Arg 1 : port number for listening <li> Arg 2 : (optional) timeout for select in millisecond </ul> +<dl compact><dt> +<b>Author(s): </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_h-source.html#l00101">101</a> of file <a class="el" href="service_h-source.html">service.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" 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 nowrap valign="top"><b> +NLNET::IService::IService ( + </b></td> + <td valign="bottom"><b> +) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="service_cpp-source.html#l00168">168</a> of file <a class="el" href="service_cpp-source.html">service.cpp</a>. </td> + </tr> +</table> +<a name="a1" 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 nowrap valign="top"><b> +NLNET::IService::~IService ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></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_h-source.html#l00108">108</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="b0" doxytag="NLNET::IService::getCustomParams"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void NLNET::IService::getCustomParams ( + </b></td> + <td valign="bottom"><b> +)<code> [protected]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Process command line arguments for port and timeout. +<p> + +<p> +Definition at line <a class="el" href="service_cpp-source.html#l00180">180</a> of file <a class="el" href="service_cpp-source.html">service.cpp</a>. </td> + </tr> +</table> +<a name="d4" 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 nowrap valign="top"><b> +<a class="el" href="class_NLNET__CCallbackServer.html">CCallbackServer</a> * NLNET::IService::getServer ( + </b></td> + <td valign="bottom"><b> +)<code> [static]</code> + </b></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="class_NLNET__CCallbackServer.html">CCallbackServer</a> object. +<p> + +<p> +Definition at line <a class="el" href="service_cpp-source.html#l00265">265</a> of file <a class="el" href="service_cpp-source.html">service.cpp</a>. </td> + </tr> +</table> +<a name="a6" 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 nowrap valign="top"><b> +<a class="el" href="types_nl_h.html#a12">sint</a> NLNET::IService::getStatus ( + </b></td> + <td valign="bottom"><b> +)<code> [inline]</code> + </b></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_h-source.html#l00126">126</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="a2" 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 nowrap valign="top"><b> +void NLNET::IService::init ( + </b></td> + <td valign="bottom"><b> +void )<code> [inline, virtual]</code> + </b></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="class_NLNET__IService.html#a3">update</a>()). +<p> + +<p> +Reimplemented in <a class="el" href="class_CFrontEndService.html#a0">CFrontEndService</a>, <a class="el" href="class_CFrontEndService.html#a3">CFrontEndService</a>, and <a class="el" href="class_CChatService.html#a0">CChatService</a>. +<p> +Definition at line <a class="el" href="service_h-source.html#l00111">111</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="a8" 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 nowrap valign="top"><b> +<a class="el" href="types_nl_h.html#a12">sint</a> NLNET::IService::main ( + </b></td> + <td valign="bottom"><b> +int <em>argc</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char ** <em>argv</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +User must just have to call this function in his main C function. +<p> + +<p> +Definition at line <a class="el" href="service_cpp-source.html#l00272">272</a> of file <a class="el" href="service_cpp-source.html">service.cpp</a>. </td> + </tr> +</table> +<a name="a4" 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 nowrap valign="top"><b> +void NLNET::IService::release ( + </b></td> + <td valign="bottom"><b> +void )<code> [inline, virtual]</code> + </b></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="class_NLNET__IService.html#a2">init</a>() function. +<p> + +<p> +Reimplemented in <a class="el" href="class_CFrontEndService.html#a2">CFrontEndService</a>, and <a class="el" href="class_CChatService.html#a2">CChatService</a>. +<p> +Definition at line <a class="el" href="service_h-source.html#l00117">117</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLNET::IService::serviceId"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="namespace_NLNET.html#a10">NLNET::TServiceId</a> NLNET::IService::serviceId ( + </b></td> + <td valign="bottom"><b> +) const<code> [inline]</code> + </b></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_h-source.html#l00123">123</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="d0" doxytag="NLNET::IService::serviceName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +std::string NLNET::IService::serviceName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the current service name. +<p> + +<p> +Definition at line <a class="el" href="service_h-source.html#l00120">120</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="a9" 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 nowrap valign="top"><b> +void NLNET::IService::setCallbackArray ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_NLNET__TCallbackItem.html">TCallbackItem</a> * <em>callbackArray</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="types_nl_h.html#a7">uint16</a> <em>callbackArraySize</em> )<code> [inline]</code> + </b></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_h-source.html#l00145">145</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="d2" doxytag="NLNET::IService::setPort"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void NLNET::IService::setPort ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="types_nl_h.html#a7">uint16</a> <em>Port</em> )<code> [inline, static]</code> + </b></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_h-source.html#l00138">138</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="b1" doxytag="NLNET::IService::setServiceId"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void NLNET::IService::setServiceId ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="namespace_NLNET.html#a10">NLNET::TServiceId</a> <em>sid</em> )<code> [inline, protected]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the service identifier. +<p> + +<p> +Definition at line <a class="el" href="service_h-source.html#l00177">177</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="d1" doxytag="NLNET::IService::setServiceName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void NLNET::IService::setServiceName ( + </b></td> + <td valign="bottom"><b> +const char * <em>shortName</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const char * <em>longName</em> )<code> [inline, static]</code> + </b></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_h-source.html#l00136">136</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="a7" 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 nowrap valign="top"><b> +void NLNET::IService::setStatus ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="types_nl_h.html#a12">sint</a> <em>status</em> )<code> [inline]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set 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. +<p> + +<p> +Definition at line <a class="el" href="service_h-source.html#l00131">131</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="d3" 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 nowrap valign="top"><b> +void NLNET::IService::setUpdateTimeout ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="types_nl_h.html#a9">uint32</a> <em>timeout</em> )<code> [inline, static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Select timeout value in milliseconds for each update. +<p> +If you set the value to 1000, the user update function will be call every second. By default the value is 1 +<p> +Definition at line <a class="el" href="service_h-source.html#l00143">143</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="a3" 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 nowrap valign="top"><b> +bool NLNET::IService::update ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></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="class_NLNET__IService.html#a2">init</a>() before). It returns false if the service is stopped. +<p> + +<p> +Reimplemented in <a class="el" href="class_CFrontEndService.html#a1">CFrontEndService</a>, and <a class="el" href="class_CChatService.html#a1">CChatService</a>. +<p> +Definition at line <a class="el" href="service_h-source.html#l00114">114</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<hr><h2>Friends And Related Function Documentation</h2> +<a name="l0" 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 nowrap valign="top"><b> +void AESConnection ( + </b></td> + <td valign="bottom"><b> +const std::string & <em>serviceName</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="namespace_NLNET.html#a0">TSockId</a> <em>from</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +void * <em>arg</em> )<code> [friend]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="p0" 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 nowrap valign="top"><b> +CConfigFile NLNET::IService::ConfigFile<code> [static]</code> + </b></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_cpp-source.html#l00081">81</a> of file <a class="el" href="service_cpp-source.html">service.cpp</a>. </td> + </tr> +</table> +<a name="q3" 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 nowrap valign="top"><b> +IService * NLNET::IService::Instance = NULL<code> [static, protected]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Singleton. +<p> + +<p> +Definition at line <a class="el" href="service_cpp-source.html#l00083">83</a> of file <a class="el" href="service_cpp-source.html">service.cpp</a>. </td> + </tr> +</table> +<a name="n0" 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 nowrap valign="top"><b> +std::vector< std::string > NLNET::IService::_Args<code> [protected]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Array of arguments. +<p> + +<p> +Definition at line <a class="el" href="service_h-source.html#l00155">155</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="o3" 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 nowrap valign="top"><b> +<a class="el" href="class_NLNET__TCallbackItem.html">TCallbackItem</a> * NLNET::IService::_CallbackArray<code> [private]</code> + </b></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_h-source.html#l00195">195</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="o4" 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 nowrap valign="top"><b> +<a class="el" href="types_nl_h.html#a7">uint16</a> NLNET::IService::_CallbackArraySize<code> [private]</code> + </b></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_h-source.html#l00196">196</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="q2" doxytag="NLNET::IService::_DefaultPort"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="types_nl_h.html#a7">uint16</a> NLNET::IService::_DefaultPort = 0<code> [static, protected]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Current service default port. Must be set by the deriver class. +<p> + +<p> +Definition at line <a class="el" href="service_cpp-source.html#l00076">76</a> of file <a class="el" href="service_cpp-source.html">service.cpp</a>. </td> + </tr> +</table> +<a name="o2" 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 nowrap valign="top"><b> +bool NLNET::IService::_Initialized<code> [private]</code> + </b></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_h-source.html#l00193">193</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="q1" 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 nowrap valign="top"><b> +string NLNET::IService::_LongName = ""<code> [static, protected]</code> + </b></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_cpp-source.html#l00075">75</a> of file <a class="el" href="service_cpp-source.html">service.cpp</a>. </td> + </tr> +</table> +<a name="n1" 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 nowrap valign="top"><b> +<a class="el" href="types_nl_h.html#a7">uint16</a> NLNET::IService::_Port<code> [protected]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Port for listening. +<p> + +<p> +Definition at line <a class="el" href="service_h-source.html#l00158">158</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="o0" 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 nowrap valign="top"><b> +<a class="el" href="namespace_NLNET.html#a10">TServiceId</a> NLNET::IService::_SId<code> [private]</code> + </b></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_h-source.html#l00189">189</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="q0" 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 nowrap valign="top"><b> +string NLNET::IService::_ShortName = ""<code> [static, protected]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Current service name. Is set by the actual service when declaring NLNET_SERVICE_MAIN. +<p> + +<p> +Definition at line <a class="el" href="service_cpp-source.html#l00074">74</a> of file <a class="el" href="service_cpp-source.html">service.cpp</a>. </td> + </tr> +</table> +<a name="o1" 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 nowrap valign="top"><b> +<a class="el" href="types_nl_h.html#a12">sint</a> NLNET::IService::_Status<code> [private]</code> + </b></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_h-source.html#l00191">191</a> of file <a class="el" href="service_h-source.html">service.h</a>. </td> + </tr> +</table> +<a name="r0" 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 nowrap valign="top"><b> +<a class="el" href="types_nl_h.html#a9">uint32</a> NLNET::IService::_UpdateTimeout = 1<code> [static, private]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Select timeout value in milliseconds. +<p> + +<p> +Definition at line <a class="el" href="service_cpp-source.html#l00078">78</a> of file <a class="el" href="service_cpp-source.html">service.cpp</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="service_h-source.html">service.h</a><li><a class="el" href="service_cpp-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> |