<!-- clanlib header begin -->
<HTML>
<HEAD>
<TITLE>CL_Socket - ClanLib Game SDK</TITLE>
<STYLE TYPE="text/css"><!--
HTML BODY
{
font-family: verdana, helvetica, sans-serif;
font-size: 12px;
}
H1 { font-size: 22px; }
H2 { font-size: 18px; }
H3 { font-size: 16px; }
H4 { font-size: 14px; }
P { font-size: 12px; }
LI { font-size: 12px; }
--></STYLE>
</HEAD>
<body bgcolor=white text=black link=blue vlink=#800080>
<center>
<img src="http://clanlib.org/gfx/clanlib.png">
</center>
<!-- clanlib header end -->
<center>
<p>
<a href="http://clanlib.org/docs.html">Home</a> |
<a href="classes.html">All Classes</a> |
<a href="modules.html">Grouped Classes</a> |
<a href="index.html">Index</a> |
<a href="search.html">Search</a>
</p>
</center>
<h1>Class CL_Socket</h1>
<p> This is the lowlevel raw socket interface in clanlib. <a href="#description">More...</a></p>
<p>Derived from:
<i>none</i>
<br>
Derived by:
<i>none</i>
<br>Group: Network (Sockets)</p>
<p>
#include <ClanLib/network.h>
<p>
<table border=0 width=100%>
</table>
<p><b>Construction:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_Socket__CL_Socket.html">CL_Socket</a></p></td><td valign=top><p> Constructs a null socket.</p></td></tr></table>
<p><b>Attributes:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_Socket__input.html">input</a></p></td><td valign=top><p> Input source that operates on the socket.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__output.html">output</a></p></td><td valign=top><p> Output source that operates on the socket.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__get_socket.html">get_socket</a></p></td><td valign=top><p> Returns the raw socket handle (for use with the lowlevel socket functions).</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__get_max_msg_size.html">get_max_msg_size</a></p></td><td valign=top><p> Returns the maximum size of a message for message-oriented socket types (CL_Socket::udp).</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__get_read_trigger.html">get_read_trigger</a></p></td><td valign=top><p> Returns an event trigger that triggers when socket has data ready to be read.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__get_write_trigger.html">get_write_trigger</a></p></td><td valign=top><p> Returns an event trigger that triggers when socket is ready for additional data.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__get_exception_trigger.html">get_exception_trigger</a></p></td><td valign=top><p> Returns an event trigger that triggers when an exception occurs on the socket.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__get_source_address.html">get_source_address</a></p></td><td valign=top><p> Returns the socket name.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__get_dest_address.html">get_dest_address</a></p></td><td valign=top><p> Returns the name of the destination socket we are connected to.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__get_broadcast_addresses.html">get_broadcast_addresses</a></p></td><td valign=top><p> Returns the list of broadcast addresses available to this socket. Works for UDP on IPv4 only.</p></td></tr></table>
<p><b>Operations:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_Socket__operator =.html">operator =</a></p></td><td valign=top><p> Copy operator.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__set_nonblocking.html">set_nonblocking</a></p></td><td valign=top><p> Sets the socket blocking mode.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__set_nodelay.html">set_nodelay</a></p></td><td valign=top><p> If enabled, don't delay send to coalesce packets.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__set_broadcasting.html">set_broadcasting</a></p></td><td valign=top><p> If enabled, do broadcasting. Works for UDP on IPv4 only</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__send.html">send</a></p></td><td valign=top><p> Writes data to socket. Returns the amount that was written.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__push.html">push</a></p></td><td valign=top><p> Push data back into the received data buffer.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__recv.html">recv</a></p></td><td valign=top><p> Reads data from the socket. Returns the amount that was read.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__connect.html">connect</a></p></td><td valign=top><p> Initiate a connection on the socket.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__shutdown.html">shutdown</a></p></td><td valign=top><p> Shut down part of full-duplex connection.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__bind.html">bind</a></p></td><td valign=top><p> Bind the socket to the specified address.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__listen.html">listen</a></p></td><td valign=top><p> Listen for connections on the socket.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__accept.html">accept</a></p></td><td valign=top><p> Accept a connection on the socket.</p></td></tr></table>
<p><b>Signals:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_Socket__sig_read_triggered.html">sig_read_triggered</a></p></td><td valign=top><p> This signal is invoked when the socket has data ready to be read.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__sig_write_triggered.html">sig_write_triggered</a></p></td><td valign=top><p> This signal is invoked when the socket has data ready to be written.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__sig_exception_triggered.html">sig_exception_triggered</a></p></td><td valign=top><p> This signal is invoked when an exception occurred on the socket.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__sig_disconnected.html">sig_disconnected</a></p></td><td valign=top><p> This signal is invoked when the remote side drops the connection, either through timeout
or explicit shutdown</p></td></tr></table>
<p><b>Implementation:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_Socket__impl.html">impl</a></p></td><td valign=top><p></p></td></tr><tr><td width=30% valign=top><p><a href="CL_Socket__proto.html">proto</a></p></td><td valign=top><p></p></td></tr></table>
<a name="#description"><p><b>Detailed description:</b></p>
!group=Network/Sockets!
!header=network.h!
<!-- clanlib footer begin -->
<center><br><br><font color="#a0a0a0">
Questions or comments, write to the <a href="http://clanlib.org/contact.html">ClanLib mailing list</a>.
</font></center>
</body>
</html>
<!-- clanlib footer end -->
distrib
>
Mandriva
>
current
>
i586
>
media
>
contrib-release
>
by-pkgid
>
98920281af4e2e96d5ea984cee4f9e2f
>
files
>
3260
