diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/new_service_howto.html | 127 |
1 files changed, 127 insertions, 0 deletions
diff --git a/docs/doxygen/nel/new_service_howto.html b/docs/doxygen/nel/new_service_howto.html new file mode 100644 index 00000000..d74d1f56 --- /dev/null +++ b/docs/doxygen/nel/new_service_howto.html @@ -0,0 +1,127 @@ +<!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 Tue May 29 22:38:19 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><a name="new_service_howto"><h2>How to create a new service ?</h2></a> + <dl compact><dt> +<b>Author(s): </b><dd> + Olivier Cado +<p> +</dl><dl compact><dt> +<b>Date: </b><dd> + Updated May 4, 2001 +<p> +</dl><a name="new_service_intro"><h3>Introduction</h3></a> + +<p> +A service is set of functionnalities provided by a server. The class <a class="el" href="class_NLNET__IService.html">NLNET::IService</a> is the base class of all services. +<p> +<a class="el" href="class_NLNET__IService.html">NLNET::IService</a> performs automatically the basic functionnalities of any service, such as registration to the Naming Service, server start-up and shutdown. +<p> +<a class="el" href="class_NLNET__IService.html">NLNET::IService</a> is located in NeL, but user-defined services are located in /code/nelns. +<p> +<a name="new_service"><h3>How to create a user-defined service ?</h3></a> + +<p> +<ol> +<li>Create a class inherited from <a class="el" href="class_NLNET__IService.html">NLNET::IService</a> (optional).<li>Create an array of callbacks, called <em><a class="el" href="net_layer3_client_cpp.html#a0">CallbackArray</a></em>. Example : <div class="fragment"><pre><font class="keywordtype">void</font> cbProcessConnection( CMessage& message, TSockId from, CCallbackNetBase& nb )<font class="keyword"> +</font><font class="keyword"></font>{ + <font class="comment">// Process here</font> +} + +<font class="keywordtype">void</font> cbProcessReceivedMsg( CMessage& message, TSockId from, CCallbackNetBase& nb )<font class="keyword"> +</font><font class="keyword"></font>{ + <font class="comment">// Process incoming message here</font> +} + +TCallbackItem CallbackArray[] = +{ + { <font class="stringliteral">"LOG"</font>, cbProcessReceivedMsg }, + { <font class="stringliteral">"C"</font>, cbProcessConnection } +};</div></pre><li>Reimplement the methods <a class="el" href="nel_3dsmax_shared_cpp.html#a2">init</a>(), update() and release() if you need to (optional). After each call to update(), CNetManager::update() is automatically called, so that the server can handle incoming messages (by calling the callbacks) and flush buffers of outgoing data.<li>Add in your source file the NLNET_SERVICE_MAIN line, with the following arguments :</ol> +<ul> +<li>The name of your class (or <a class="el" href="class_NLNET__IService.html">NLNET::IService</a> if you do not inherit from it (*))<li>The short name of your service<li>Its long name<li>The chosen port number (set it to 0 for "auto-assigned by the naming service")<li>The callback array</ul> +Example: <div class="fragment"><pre><a class="code" href="service_h.html#a0">NLNET_SERVICE_MAIN</a>( CMyService, <font class="stringliteral">"MS"</font>, <font class="stringliteral">"my_service"</font>, 0, CallbackArray );</div></pre> +<p> +(*) Note: if your service does nothing else calling your callbacks, i.e. <a class="el" href="nel_3dsmax_shared_cpp.html#a2">init</a>(), update() and release() are empty, you don't need to create a new class : you can use IService directly and write IService instead of CMyService. +<p> +To run your service, create a file "<service_long_name>.cfg" in the working directory, containing the location of your naming service. +<p> +Example: my_service.cfg: <div class="fragment"><pre>NSHost = <font class="stringliteral">"itsalive.nevrax.org"</font>; +NSPort = 50000;</div></pre> +<p> +<a name="new_services_examples"><h3>Examples</h3></a> + +<p> +See the nelns services source code for examples on how to create a class inherited from IService. +<p> + + +<!-- 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> |