<html> <head><title>ClanLib Reference: CL_NetSession</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_NetSession</h1><p> <b> Net session class.</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 (NetSessions) <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_NetSession.html#1416"><tt><font color=blue><b>CL_NetSession</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>app_id</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_NetSession.html#1417"><tt><font color=blue><b>CL_NetSession</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_NetSession.html#1430"><tt><font color=blue><b>CL_NetSession</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_NetSession.html#1418"><tt><font color=blue><b>~CL_NetSession</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><a href="CL_NetGroup.html"><tt><font color=navy><b>CL_NetGroup</b></font></tt></a>&</tt> </td><td align=right><a href="CL_NetSession.html#1419"><tt><font color=blue><b>get_all</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetSession.html#1420"><tt><font color=blue><b>start_listen</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>listen_port</font></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_NetSession.html#1421"><tt><font color=blue><b>stop_listen</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a></tt> </td><td align=right><a href="CL_NetSession.html#1422"><tt><font color=blue><b>connect</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_IPAddress.html"><tt><font color=navy><b>CL_IPAddress</b></font></tt></a>& <tt><font color=blue>address</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a></tt> </td><td align=right><a href="CL_NetSession.html#1423"><tt><font color=blue><b>connect_async</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>hostname</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>port</font></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_NetSession.html#1424"><tt><font color=blue><b>show_debug</b></font></tt></a></td><td><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>enable</font></tt> = true)</tt>;</td> <tr valign=top><td align=left><h3>Signals:</h3></td> <tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a>& >&</tt> </td><td align=right><a href="CL_NetSession.html#1425"><tt><font color=blue><b>sig_computer_connected</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a>& >&</tt> </td><td align=right><a href="CL_NetSession.html#1426"><tt><font color=blue><b>sig_computer_reconnected</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a>& >&</tt> </td><td align=right><a href="CL_NetSession.html#1427"><tt><font color=blue><b>sig_computer_disconnected</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_NetStream.html"><tt><font color=navy><b>CL_NetStream</b></font></tt></a>& >&</tt> </td><td align=right><a href="CL_NetSession.html#1428"><tt><font color=blue><b>sig_netstream_connect</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>netstream</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v2</font></tt><<a href="CL_NetPacket.html"><tt><font color=navy><b>CL_NetPacket</b></font></tt></a>& , <a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a>& >&</tt> </td><td align=right><a href="CL_NetSession.html#1429"><tt><font color=blue><b>sig_netpacket_receive</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>packet_channel</font></tt>)</tt>;</td> <tr valign=top><td align=left><h3>Implementation:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_NetSession.html#1430"><tt><font color=blue><b>CL_NetSession</b></font></tt></a></td><td><tt>(<tt><font color=navy>CL_NetSession_Generic</font></tt>* <tt><font color=blue>impl</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="1416"><font size=+1><b>CL_NetSession::CL_NetSession</b></font></a> - Constructs a netsession.<br><tt></tt> <a href="CL_NetSession.html#1416"><tt><font color=blue><b>CL_NetSession</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>app_id</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1422"><font size=+1><b>CL_NetSession::connect</b></font></a> - Connect to remote netsession.<br><tt><a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a></tt> <a href="CL_NetSession.html#1422"><tt><font color=blue><b>connect</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_IPAddress.html"><tt><font color=navy><b>CL_IPAddress</b></font></tt></a>& <tt><font color=blue>address</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1423"><font size=+1><b>CL_NetSession::connect_async</b></font></a> - Connect to remote netsession asyncronously.<br><tt><a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a></tt> <a href="CL_NetSession.html#1423"><tt><font color=blue><b>connect_async</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>hostname</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>port</font></tt>)</tt>;<br><blockquote> <p>The DNS lookup and connect is done in a worker thread, thus not<br> blocking the calling thread. If the connection fails,<br> CL_NetSession::sig_disconnected() is emitted.</p></blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1419"><font size=+1><b>CL_NetSession::get_all</b></font></a> - Returns a list of all computers connected.<br><tt><a href="CL_NetGroup.html"><tt><font color=navy><b>CL_NetGroup</b></font></tt></a>&</tt> <a href="CL_NetSession.html#1419"><tt><font color=blue><b>get_all</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1424"><font size=+1><b>CL_NetSession::show_debug</b></font></a> - Enable or disable debug output.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetSession.html#1424"><tt><font color=blue><b>show_debug</b></font></tt></a><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>enable</font></tt> = true)</tt>;<br><blockquote> <p>This will output the netchannels each netpacket arrive in.</p></blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1425"><font size=+1><b>CL_NetSession::sig_computer_connected</b></font></a> - Signal invoked when a computer connects to the netsession server.<br><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a>& >&</tt> <a href="CL_NetSession.html#1425"><tt><font color=blue><b>sig_computer_connected</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1427"><font size=+1><b>CL_NetSession::sig_computer_disconnected</b></font></a> - Signal invoked when a computer disconnects from the netsession server.<br><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a>& >&</tt> <a href="CL_NetSession.html#1427"><tt><font color=blue><b>sig_computer_disconnected</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1426"><font size=+1><b>CL_NetSession::sig_computer_reconnected</b></font></a> - Signal invoked when a computer re-connects to the netsession server.<br><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a>& >&</tt> <a href="CL_NetSession.html#1426"><tt><font color=blue><b>sig_computer_reconnected</b></font></tt></a><tt>()</tt>;<br><blockquote> <p>This happens when a CL_NetComputer instance has still not been destroyed<br> since its last connect (allows you to recognize players dropping out, so<br> they dont loose their score when they reconnect).</p></blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1429"><font size=+1><b>CL_NetSession::sig_netpacket_receive</b></font></a> - Signal invoked when someone sends a netpacket to the specified packet channel.<br><tt><tt><font color=navy>CL_Signal_v2</font></tt><<a href="CL_NetPacket.html"><tt><font color=navy><b>CL_NetPacket</b></font></tt></a>& , <a href="CL_NetComputer.html"><tt><font color=navy><b>CL_NetComputer</b></font></tt></a>& >&</tt> <a href="CL_NetSession.html#1429"><tt><font color=blue><b>sig_netpacket_receive</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>packet_channel</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1428"><font size=+1><b>CL_NetSession::sig_netstream_connect</b></font></a> - Signal invoked when someone makes a connection to the specified<br> netstream.<br><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_NetStream.html"><tt><font color=navy><b>CL_NetStream</b></font></tt></a>& >&</tt> <a href="CL_NetSession.html#1428"><tt><font color=blue><b>sig_netstream_connect</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>netstream</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1420"><font size=+1><b>CL_NetSession::start_listen</b></font></a> - Start listening for connections.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetSession.html#1420"><tt><font color=blue><b>start_listen</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>listen_port</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1421"><font size=+1><b>CL_NetSession::stop_listen</b></font></a> - Stop listening for connections and disconnect everyone.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetSession.html#1421"><tt><font color=blue><b>stop_listen</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <hr noshade> </body> </html>
