diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/service_8h.html | 184 |
1 files changed, 184 insertions, 0 deletions
diff --git a/docs/doxygen/nel/service_8h.html b/docs/doxygen/nel/service_8h.html new file mode 100644 index 00000000..a0954a54 --- /dev/null +++ b/docs/doxygen/nel/service_8h.html @@ -0,0 +1,184 @@ +<!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>service.h File Reference</h1>Base class for all network services. +<a href="#_details">More...</a> +<p> +<code>#include "<a class="el" href="types__nl_8h-source.html">nel/misc/types_nl.h</a>"</code><br> +<code>#include "<a class="el" href="config__file_8h-source.html">nel/misc/config_file.h</a>"</code><br> +<code>#include "<a class="el" href="entity__id_8h-source.html">nel/misc/entity_id.h</a>"</code><br> +<code>#include "<a class="el" href="unified__network_8h-source.html">nel/net/unified_network.h</a>"</code><br> +<code>#include <string></code><br> +<code>#include <vector></code><br> + +<p> +<a href="service_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Namespaces</h2></td></tr> +<tr><td nowrap align=right valign=top>namespace </td><td valign=bottom><a class="el" href="namespaceNLMISC.html">NLMISC</a></td></tr> +<tr><td nowrap align=right valign=top>namespace </td><td valign=bottom><a class="el" href="namespaceNLNET.html">NLNET</a></td></tr> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="service_8h.html#a0">NLNET_SERVICE_MAIN</a>(__ServiceClassName, __ServiceShortName, __ServiceLongName, __ServicePort, __ServiceCallbackArray, __ConfigDir, __LogDir)</td></tr> +<tr><td> </td><td><font size=-1><em>The goal of this macro is to simplify the service creation, it creates the main body function.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Base class for all network services. +<p> + <dl compact><dt><b> +Id: </b><dd> + service.h,v 1.59 2002/11/08 13:28:40 lecroart Exp </dl> +<p> + +<p> +Definition in file <a class="el" href="service_8h-source.html">service.h</a>.<hr><h2>Define Documentation</h2> +<a name="a0" doxytag="service.h::NLNET_SERVICE_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"> #define NLNET_SERVICE_MAIN</td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">__ServiceClassName, <tr> + <td></td> + <td></td> + <td class="md" nowrap>__ServiceShortName, <tr> + <td></td> + <td></td> + <td class="md" nowrap>__ServiceLongName, <tr> + <td></td> + <td></td> + <td class="md" nowrap>__ServicePort, <tr> + <td></td> + <td></td> + <td class="md" nowrap>__ServiceCallbackArray, <tr> + <td></td> + <td></td> + <td class="md" nowrap>__ConfigDir, <tr> + <td></td> + <td></td> + <td class="md" nowrap>__LogDir </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<b>Value:</b><div class="fragment"><pre>\ +<font class="keywordtype">int</font> main(<font class="keywordtype">int</font> argc, <font class="keyword">const</font> <font class="keywordtype">char</font> **argv) \ +{ \ + __ServiceClassName *scn = <font class="keyword">new</font> __ServiceClassName; \ + scn->setArgs (argc, argv); \ + scn->setCallbackArray (__ServiceCallbackArray, <font class="keyword">sizeof</font>(__ServiceCallbackArray)/<font class="keyword">sizeof</font>(__ServiceCallbackArray[0])); \ + sint retval = scn->main (__ServiceShortName, __ServiceLongName, __ServicePort, __ConfigDir, __LogDir); \ + <font class="keyword">delete</font> scn; \ + <font class="keywordflow">return</font> retval; \ +}</pre></div>The goal of this macro is to simplify the service creation, it creates the main body function. +<p> +If you don't want to give a callback array, just put EmptyCallbackArray in the last argument +<p> +Example: <div class="fragment"><pre> <font class="comment">// Create the Test Service class</font> + <font class="keyword">class </font>CTestService : <font class="keyword">public</font> IService + { + <font class="keyword">public</font>: + <font class="keywordtype">void</font> init () { <a class="code" href="debug_8h.html#a1">nlinfo</a>(<font class="stringliteral">"init()"</font>); } + <font class="keywordtype">bool</font> update () { <a class="code" href="debug_8h.html#a1">nlinfo</a> (<font class="stringliteral">"update();"</font>); <font class="keywordflow">return</font> <font class="keyword">true</font>; } + <font class="keywordtype">void</font> release () { <a class="code" href="debug_8h.html#a1">nlinfo</a>(<font class="stringliteral">"release()"</font>); } + }; + <font class="comment">// Create the main() function that create a test service instance and execute it.</font> + <font class="comment">// "TS" is the short service name and "test_service" is the long one.</font> + <font class="comment">// The name of the config file is based on the long name!</font> + <font class="comment">// EmptyCallbackArray means that you don't provide right now the callback</font> + <font class="comment">// the last 2 path are where is the config file is (directory) and where to log info (directory)</font> + <a class="code" href="service_8h.html#a0">NLNET_SERVICE_MAIN</a>(CTestService, <font class="stringliteral">"TS"</font>, <font class="stringliteral">"test_service"</font>, 0, EmptyCallbackArray, <font class="stringliteral">""</font>, <font class="stringliteral">""</font>); + * +</pre></div> +<p> +If you want the port to not be auto-assigned by the naming service, set the port to a number different than 0. +<p> +Args used by service are always in lower case: +<p> +-C followed by the directory where we can find the config file -L followed by the directory where we have to log -N followed by the alias name (used by the admin system) -P followed by the listen port -A followed by the path where to execute the service (it uses chdir()) -I to start the service iconified +<p> +Definition at line <a class="el" href="service_8h-source.html#l00119">119</a> of file <a class="el" href="service_8h-source.html">service.h</a>. </td> + </tr> +</table> + + +<!-- 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> |