<html> <head><title>ClanLib Reference: CL_NetObjectChannel</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_NetObjectChannel</h1><p> <b> Network object replication channel.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Network (NetObjects) <p> #include <ClanLib/network.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_NetObjectChannel.html#1885"><tt><font color=blue><b>CL_NetObjectChannel</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_NetObjectChannel.html#1886"><tt><font color=blue><b>CL_NetObjectChannel</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_NetObjectChannel.html#1886"><tt><font color=blue><b>CL_NetObjectChannel</b></font></tt></a></td><td><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_NetSession</font></tt>* <tt><font color=blue>netgame</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>channel</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_NetObjectChannel.html#1887"><tt><font color=blue><b>~CL_NetObjectChannel</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v3</font></tt><<tt>const</tt> <tt><font color=navy>class</font></tt> <a href="CL_NetObject.html"><tt><font color=navy><b>CL_NetObject</b></font></tt></a>& , <tt><font color=purple>int</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& >&</tt> </td><td align=right><a href="CL_NetObjectChannel.html#1888"><tt><font color=blue><b>sig_create_object</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetObjectChannel.html#1889"><tt><font color=blue><b>begin_sync</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>class</font></tt> <tt><font color=blue>CL_NetGroup</font></tt>* <tt><font color=blue>group</font></tt> = NULL)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetObjectChannel.html#1890"><tt><font color=blue><b>end_sync</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>class</font></tt> <tt><font color=blue>CL_NetGroup</font></tt>* <tt><font color=blue>group</font></tt> = NULL)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_NetObjectChannel.html#1891"><tt><font color=blue><b>wait_sync</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>timeout</font></tt> = -1)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> Manages a netchannel with netobject replication data. It dispatches incoming messages to the correct netobject.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="1885"><font size=+1><b>CL_NetObjectChannel::CL_NetObjectChannel</b></font></a> - Copy constructor.<br><tt></tt> <a href="CL_NetObjectChannel.html#1885"><tt><font color=blue><b>CL_NetObjectChannel</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_NetObjectChannel.html#1886"><tt><font color=blue><b>CL_NetObjectChannel</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1886"><font size=+1><b>CL_NetObjectChannel::CL_NetObjectChannel</b></font></a> - Constructs a netobject channel.<br><tt></tt> <a href="CL_NetObjectChannel.html#1886"><tt><font color=blue><b>CL_NetObjectChannel</b></font></tt></a><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_NetSession</font></tt>* <tt><font color=blue>netgame</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>channel</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1889"><font size=+1><b>CL_NetObjectChannel::begin_sync</b></font></a> - Sends a begin_sync message to the netchannel. This is used together with end_sync to mark a group of objects. The client can use wait_sync to wait for a full transfer of a list of objects.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetObjectChannel.html#1889"><tt><font color=blue><b>begin_sync</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>class</font></tt> <tt><font color=blue>CL_NetGroup</font></tt>* <tt><font color=blue>group</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1890"><font size=+1><b>CL_NetObjectChannel::end_sync</b></font></a> - Sends a end_sync message to the netchannel. This is used together with end_sync to mark a group of objects. The client can use wait_sync to wait for a full transfer of a list of objects.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetObjectChannel.html#1890"><tt><font color=blue><b>end_sync</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>class</font></tt> <tt><font color=blue>CL_NetGroup</font></tt>* <tt><font color=blue>group</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1888"><font size=+1><b>CL_NetObjectChannel::sig_create_object</b></font></a> - CL_Signal_v3<netobject, msgtype, message>.<br> <br> Signal that is called whenever the netobject channel receives a message for a netobject it doesnt know. The application should hook a slot into this signal and determine what to do with the message.<br><tt><tt><font color=navy>CL_Signal_v3</font></tt><<tt>const</tt> <tt><font color=navy>class</font></tt> <a href="CL_NetObject.html"><tt><font color=navy><b>CL_NetObject</b></font></tt></a>& , <tt><font color=purple>int</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& >&</tt> <a href="CL_NetObjectChannel.html#1888"><tt><font color=blue><b>sig_create_object</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1891"><font size=+1><b>CL_NetObjectChannel::wait_sync</b></font></a> - Waits for a synced group of objects to arrive. If the whole group havnt been received before the timeout, the function will return false.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_NetObjectChannel.html#1891"><tt><font color=blue><b>wait_sync</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>timeout</font></tt> = -1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1887"><font size=+1><b>CL_NetObjectChannel::~CL_NetObjectChannel</b></font></a> - Net Object Channel Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_NetObjectChannel.html#1887"><tt><font color=blue><b>~CL_NetObjectChannel</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <a name="1892"><font size=+1><b>CL_NetObjectChannel::impl</b></font></a> - Net Object Channel Generic Implementation<br> <tt><tt><font color=navy>CL_NetObjectChannel_Generic</font></tt> *</tt> <tt><a href="CL_NetObjectChannel.html#1892"><tt><font color=blue>impl</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br> <hr noshade> </body> </html>
