<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="tabs.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="logo">
<img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" />
</div>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="modules.htm"><span>Modules</span></a></li>
<li class="current"><a href="annotated.htm"><span>Classes</span></a></li>
<li><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.htm"><span>Class List</span></a></li>
<li><a href="classes.htm"><span>Class Index</span></a></li>
<li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li>
<li><a href="functions.htm"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>sf</b>::<a class="el" href="classsf_1_1UdpSocket.htm">UdpSocket</a>
</div>
</div>
<div class="contents">
<h1>sf::UdpSocket Class Reference<br/>
<small>
[<a class="el" href="group__network.htm">Network module</a>]</small>
</h1><!-- doxytag: class="sf::UdpSocket" --><!-- doxytag: inherits="sf::Socket" -->
<p>Specialized socket using the UDP protocol.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="UdpSocket_8hpp_source.htm">UdpSocket.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for sf::UdpSocket:</div>
<div class="dynsection">
<div class="center">
<img src="classsf_1_1UdpSocket.png" usemap="#sf::UdpSocket_map" alt=""/>
<map id="sf::UdpSocket_map" name="sf::UdpSocket_map">
<area href="classsf_1_1Socket.htm" alt="sf::Socket" shape="rect" coords="0,56,105,80"/>
<area href="classsf_1_1NonCopyable.htm" alt="sf::NonCopyable" shape="rect" coords="0,0,105,24"/>
</map>
</div>
</div>
<p><a href="classsf_1_1UdpSocket-members.htm">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="classsf_1_1UdpSocket.htm#a0a8d64f52c57746869b063bcb20674fea728a7d33027bee0d65f70f964dd9c9eb">MaxDatagramSize</a> = 65507
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">Status</a> { <br/>
<a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dca1de3a85bc56d3ae85b3d0f3cfd04ae90">Done</a>,
<br/>
<a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dca8554848daae98f996e131bdeed076c09">NotReady</a>,
<br/>
<a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dcab215141f756acdc23c67fad149710eb1">Disconnected</a>,
<br/>
<a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dca1dc9854433a28c22e192721179a2df5d">Error</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Status codes that may be returned by socket functions. </p>
<a href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="classsf_1_1Socket.htm#ad4c6b76944f72009fef53c8594f1c638a5a3c30fd128895403afc11076f461b19">AnyPort</a> = 0
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Some special values used by sockets. </p>
<a href="classsf_1_1Socket.htm#ad4c6b76944f72009fef53c8594f1c638">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1UdpSocket.htm#abb10725e26dee9d3a8165fe87ffb71bb">UdpSocket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#abb10725e26dee9d3a8165fe87ffb71bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1UdpSocket.htm#afacddd4a2d3ecb54e503f30850cdd64f">GetLocalPort</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the port to which the socket is bound locally. <a href="#afacddd4a2d3ecb54e503f30850cdd64f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1UdpSocket.htm#a32d2945c5c6f9bf26a982a92626b6f21">Bind</a> (unsigned short port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bind the socket to a specific port. <a href="#a32d2945c5c6f9bf26a982a92626b6f21"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1UdpSocket.htm#ad2ab1e3459575749611d8e0dfd806d39">Unbind</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unbind the socket from the local port to which it is bound. <a href="#ad2ab1e3459575749611d8e0dfd806d39"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1UdpSocket.htm#a41b3b5c17e88869dee5d0a31bbb30a0e">Send</a> (const char *data, std::size_t size, const <a class="el" href="classsf_1_1IpAddress.htm">IpAddress</a> &remoteAddress, unsigned short remotePort)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send raw data to a remote peer. <a href="#a41b3b5c17e88869dee5d0a31bbb30a0e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1UdpSocket.htm#a9f55f575443b358e0a5fb8bce50b2eff">Receive</a> (char *data, std::size_t size, std::size_t &received, <a class="el" href="classsf_1_1IpAddress.htm">IpAddress</a> &remoteAddress, unsigned short &remotePort)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive raw data from a remote peer. <a href="#a9f55f575443b358e0a5fb8bce50b2eff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1UdpSocket.htm#a24cf211881167fe525408f67db646553">Send</a> (<a class="el" href="classsf_1_1Packet.htm">Packet</a> &packet, const <a class="el" href="classsf_1_1IpAddress.htm">IpAddress</a> &remoteAddress, unsigned short remotePort)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a formatted packet of data to a remote peer. <a href="#a24cf211881167fe525408f67db646553"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1UdpSocket.htm#ab8ca3a91b8910d9389c0ff7fa8c1d770">Receive</a> (<a class="el" href="classsf_1_1Packet.htm">Packet</a> &packet, <a class="el" href="classsf_1_1IpAddress.htm">IpAddress</a> &remoteAddress, unsigned short &remotePort)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a formatted packet of data from a remote peer. <a href="#ab8ca3a91b8910d9389c0ff7fa8c1d770"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Socket.htm#ac26a66c764fe459e301c49e2fa92f33f">SetBlocking</a> (bool blocking)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the blocking state of the socket. <a href="#ac26a66c764fe459e301c49e2fa92f33f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Socket.htm#a0a1e39eec727677d210ca518aa5fec8f">IsBlocking</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell whether the socket is in blocking or non-blocking mode. <a href="#a0a1e39eec727677d210ca518aa5fec8f"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Socket.htm#a5d3ff44e56e68f02816bb0fabc34adf8">Type</a> { <br/>
<a class="el" href="classsf_1_1Socket.htm#a5d3ff44e56e68f02816bb0fabc34adf8acc02e97e90234b957eaad4dff7f22214">Tcp</a>,
<br/>
<a class="el" href="classsf_1_1Socket.htm#a5d3ff44e56e68f02816bb0fabc34adf8a6ebf3094830db4820191a327f3cc6ce2">Udp</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Types of protocols that the socket can use. </p>
<a href="classsf_1_1Socket.htm#a5d3ff44e56e68f02816bb0fabc34adf8">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SocketHandle </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Socket.htm#a8a7f6b4462352aa42ceea915b5ab46d9">GetHandle</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the internal handle of the socket. <a href="#a8a7f6b4462352aa42ceea915b5ab46d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Socket.htm#acb25ca5677518e871e75b30be377c73a">Create</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the internal representation of the socket. <a href="#acb25ca5677518e871e75b30be377c73a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Socket.htm#a225d6398c641e342c2f57ed9b7a974d4">Create</a> (SocketHandle handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the internal representation of the socket from a socket handle. <a href="#a225d6398c641e342c2f57ed9b7a974d4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Socket.htm#a4c19ac40a7996f51301c618ed12bd4fe">Close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the socket gracefully. <a href="#a4c19ac40a7996f51301c618ed12bd4fe"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Specialized socket using the UDP protocol. </p>
<p>A UDP socket is a connectionless socket.</p>
<p>Instead of connecting once to a remote host, like TCP sockets, it can send to and receive from any host at any time.</p>
<p>It is a datagram protocol: bounded blocks of data (datagrams) are transfered over the network rather than a continuous stream of data (TCP). Therefore, one call to Send will always match one call to Receive (if the datagram is not lost), with the same data that was sent.</p>
<p>The UDP protocol is lightweight but unreliable. Unreliable means that datagrams may be duplicated, be lost or arrive reordered. However, if a datagram arrives, its data is guaranteed to be valid.</p>
<p>UDP is generally used for real-time communication (audio or video streaming, real-time games, etc.) where speed is crucial and lost data doesn't matter much.</p>
<p>Sending and receiving data can use either the low-level or the high-level functions. The low-level functions process a raw sequence of bytes, whereas the high-level interface uses packets (see <a class="el" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">sf::Packet</a>), which are easier to use and provide more safety regarding the data that is exchanged. You can look at the <a class="el" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">sf::Packet</a> class to get more details about how they work.</p>
<p>It is important to note that <a class="el" href="classsf_1_1UdpSocket.htm" title="Specialized socket using the UDP protocol.">UdpSocket</a> is unable to send datagrams bigger than MaxDatagramSize. In this case, it returns an error and doesn't send anything. This applies to both raw data and packets. Indeed, even packets are unable to split and recompose data, due to the unreliability of the protocol (dropped, mixed or duplicated datagrams may lead to a big mess when trying to recompose a packet).</p>
<p>If the socket is bound to a port, it is automatically unbound from it when the socket is destroyed. However, you can unbind the socket explicitely with the Unbind function if necessary, to stop receiving messages or make the port available for other sockets.</p>
<p>Usage example: </p>
<div class="fragment"><pre class="fragment"> <span class="comment">// ----- The client -----</span>
<span class="comment">// Create a socket and bind it to the port 55001</span>
<a class="code" href="classsf_1_1UdpSocket.htm" title="Specialized socket using the UDP protocol.">sf::UdpSocket</a> socket;
socket.<a class="code" href="classsf_1_1UdpSocket.htm#a32d2945c5c6f9bf26a982a92626b6f21" title="Bind the socket to a specific port.">Bind</a>(55001);
<span class="comment">// Send a message to 192.168.1.50 on port 55002</span>
std::string message = <span class="stringliteral">"Hi, I am "</span> + <a class="code" href="classsf_1_1IpAddress.htm#a6ade7ce40c62eba61b5a55a1b68cc5ef" title="Get the computer&#39;s local address.">sf::IpAddress::GetLocalAddress</a>().ToString();
socket.<a class="code" href="classsf_1_1UdpSocket.htm#a41b3b5c17e88869dee5d0a31bbb30a0e" title="Send raw data to a remote peer.">Send</a>(message.c_str(), message.size() + 1, <span class="stringliteral">"192.168.1.50"</span>, 55002);
<span class="comment">// Receive an answer (most likely from 192.168.1.50, but could be anyone else)</span>
<span class="keywordtype">char</span> buffer[1024];
std::size_t received = 0;
<a class="code" href="classsf_1_1IpAddress.htm" title="Encapsulate an IPv4 network address.">sf::IpAddress</a> sender;
<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> port;
socket.<a class="code" href="classsf_1_1UdpSocket.htm#a9f55f575443b358e0a5fb8bce50b2eff" title="Receive raw data from a remote peer.">Receive</a>(buffer, <span class="keyword">sizeof</span>(buffer), received, sender, port);
std::cout << sender.<a class="code" href="classsf_1_1IpAddress.htm#aa218c1280abe9b9b2387f69d2e952c59" title="Get a string representation of the address.">ToString</a>() << <span class="stringliteral">" said: "</span> << buffer << std::endl;
<span class="comment">// ----- The server -----</span>
<span class="comment">// Create a socket and bind it to the port 55002</span>
<a class="code" href="classsf_1_1UdpSocket.htm" title="Specialized socket using the UDP protocol.">sf::UdpSocket</a> socket;
socket.<a class="code" href="classsf_1_1UdpSocket.htm#a32d2945c5c6f9bf26a982a92626b6f21" title="Bind the socket to a specific port.">Bind</a>(55002);
<span class="comment">// Receive a message from anyone</span>
<span class="keywordtype">char</span> buffer[1024];
std::size_t received = 0;
<a class="code" href="classsf_1_1IpAddress.htm" title="Encapsulate an IPv4 network address.">sf::IpAddress</a> sender;
<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> port;
socket.<a class="code" href="classsf_1_1UdpSocket.htm#a9f55f575443b358e0a5fb8bce50b2eff" title="Receive raw data from a remote peer.">Receive</a>(buffer, <span class="keyword">sizeof</span>(buffer), received, sender, port);
std::cout << sender.<a class="code" href="classsf_1_1IpAddress.htm#aa218c1280abe9b9b2387f69d2e952c59" title="Get a string representation of the address.">ToString</a>() << <span class="stringliteral">" said: "</span> << buffer << std::endl;
<span class="comment">// Send an answer</span>
std::string message = <span class="stringliteral">"Welcome "</span> + sender.<a class="code" href="classsf_1_1IpAddress.htm#aa218c1280abe9b9b2387f69d2e952c59" title="Get a string representation of the address.">ToString</a>();
socket.<a class="code" href="classsf_1_1UdpSocket.htm#a41b3b5c17e88869dee5d0a31bbb30a0e" title="Send raw data to a remote peer.">Send</a>(message.c_str(), message.size() + 1, sender, port);
</pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1Socket.htm" title="Base class for all the socket types.">sf::Socket</a>, <a class="el" href="classsf_1_1TcpSocket.htm" title="Specialized socket using the TCP protocol.">sf::TcpSocket</a>, <a class="el" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">sf::Packet</a> </dd></dl>
<p>Definition at line <a class="el" href="UdpSocket_8hpp_source.htm#l00044">44</a> of file <a class="el" href="UdpSocket_8hpp_source.htm">UdpSocket.hpp</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ad4c6b76944f72009fef53c8594f1c638"></a><!-- doxytag: member="sf::UdpSocket::@1" ref="ad4c6b76944f72009fef53c8594f1c638" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum<code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Some special values used by sockets. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ad4c6b76944f72009fef53c8594f1c638a5a3c30fd128895403afc11076f461b19"></a><!-- doxytag: member="AnyPort" ref="ad4c6b76944f72009fef53c8594f1c638a5a3c30fd128895403afc11076f461b19" args="" -->AnyPort</em> </td><td>
<p>Special value that tells the system to pick any available port. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Socket_8hpp_source.htm#l00064">64</a> of file <a class="el" href="Socket_8hpp_source.htm">Socket.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0a8d64f52c57746869b063bcb20674fe"></a><!-- doxytag: member="sf::UdpSocket::@2" ref="a0a8d64f52c57746869b063bcb20674fe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a0a8d64f52c57746869b063bcb20674fea728a7d33027bee0d65f70f964dd9c9eb"></a><!-- doxytag: member="MaxDatagramSize" ref="a0a8d64f52c57746869b063bcb20674fea728a7d33027bee0d65f70f964dd9c9eb" args="" -->MaxDatagramSize</em> </td><td>
<p>The maximum number of bytes that can be sent in a single UDP datagram. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="UdpSocket_8hpp_source.htm#l00051">51</a> of file <a class="el" href="UdpSocket_8hpp_source.htm">UdpSocket.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a51bf0fd51057b98a10fbb866246176dc"></a><!-- doxytag: member="sf::UdpSocket::Status" ref="a51bf0fd51057b98a10fbb866246176dc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">sf::Socket::Status</a><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Status codes that may be returned by socket functions. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a51bf0fd51057b98a10fbb866246176dca1de3a85bc56d3ae85b3d0f3cfd04ae90"></a><!-- doxytag: member="Done" ref="a51bf0fd51057b98a10fbb866246176dca1de3a85bc56d3ae85b3d0f3cfd04ae90" args="" -->Done</em> </td><td>
<p>The socket has sent / received the data. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a51bf0fd51057b98a10fbb866246176dca8554848daae98f996e131bdeed076c09"></a><!-- doxytag: member="NotReady" ref="a51bf0fd51057b98a10fbb866246176dca8554848daae98f996e131bdeed076c09" args="" -->NotReady</em> </td><td>
<p>The socket is not ready to send / receive data yet. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a51bf0fd51057b98a10fbb866246176dcab215141f756acdc23c67fad149710eb1"></a><!-- doxytag: member="Disconnected" ref="a51bf0fd51057b98a10fbb866246176dcab215141f756acdc23c67fad149710eb1" args="" -->Disconnected</em> </td><td>
<p>The TCP socket has been disconnected. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a51bf0fd51057b98a10fbb866246176dca1dc9854433a28c22e192721179a2df5d"></a><!-- doxytag: member="Error" ref="a51bf0fd51057b98a10fbb866246176dca1dc9854433a28c22e192721179a2df5d" args="" -->Error</em> </td><td>
<p>An unexpected error happened. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Socket_8hpp_source.htm#l00052">52</a> of file <a class="el" href="Socket_8hpp_source.htm">Socket.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5d3ff44e56e68f02816bb0fabc34adf8"></a><!-- doxytag: member="sf::UdpSocket::Type" ref="a5d3ff44e56e68f02816bb0fabc34adf8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classsf_1_1Socket.htm#a5d3ff44e56e68f02816bb0fabc34adf8">sf::Socket::Type</a><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Types of protocols that the socket can use. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a5d3ff44e56e68f02816bb0fabc34adf8acc02e97e90234b957eaad4dff7f22214"></a><!-- doxytag: member="Tcp" ref="a5d3ff44e56e68f02816bb0fabc34adf8acc02e97e90234b957eaad4dff7f22214" args="" -->Tcp</em> </td><td>
<p>TCP protocol. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a5d3ff44e56e68f02816bb0fabc34adf8a6ebf3094830db4820191a327f3cc6ce2"></a><!-- doxytag: member="Udp" ref="a5d3ff44e56e68f02816bb0fabc34adf8a6ebf3094830db4820191a327f3cc6ce2" args="" -->Udp</em> </td><td>
<p>UDP protocol. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Socket_8hpp_source.htm#l00112">112</a> of file <a class="el" href="Socket_8hpp_source.htm">Socket.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="abb10725e26dee9d3a8165fe87ffb71bb"></a><!-- doxytag: member="sf::UdpSocket::UdpSocket" ref="abb10725e26dee9d3a8165fe87ffb71bb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::UdpSocket::UdpSocket </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a32d2945c5c6f9bf26a982a92626b6f21"></a><!-- doxytag: member="sf::UdpSocket::Bind" ref="a32d2945c5c6f9bf26a982a92626b6f21" args="(unsigned short port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">Status</a> sf::UdpSocket::Bind </td>
<td>(</td>
<td class="paramtype">unsigned short </td>
<td class="paramname"> <em>port</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Bind the socket to a specific port. </p>
<p>Binding the socket to a port is necessary for being able to receive data on that port. You can use the special value <a class="el" href="classsf_1_1Socket.htm#ad4c6b76944f72009fef53c8594f1c638a5a3c30fd128895403afc11076f461b19" title="Special value that tells the system to pick any available port.">Socket::AnyPort</a> to tell the system to automatically pick an available port, and then call GetLocalPort to retrieve the chosen port.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>Port to bind the socket to</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Status code</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1UdpSocket.htm#ad2ab1e3459575749611d8e0dfd806d39" title="Unbind the socket from the local port to which it is bound.">Unbind</a>, <a class="el" href="classsf_1_1UdpSocket.htm#afacddd4a2d3ecb54e503f30850cdd64f" title="Get the port to which the socket is bound locally.">GetLocalPort</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4c19ac40a7996f51301c618ed12bd4fe"></a><!-- doxytag: member="sf::UdpSocket::Close" ref="a4c19ac40a7996f51301c618ed12bd4fe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Socket::Close </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the socket gracefully. </p>
<p>This function can only be accessed by derived classes. </p>
<p>Reimplemented in <a class="el" href="classsf_1_1TcpListener.htm#af7fea65beac3829920597fedfb42125e">sf::TcpListener</a>.</p>
</div>
</div>
<a class="anchor" id="a225d6398c641e342c2f57ed9b7a974d4"></a><!-- doxytag: member="sf::UdpSocket::Create" ref="a225d6398c641e342c2f57ed9b7a974d4" args="(SocketHandle handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Socket::Create </td>
<td>(</td>
<td class="paramtype">SocketHandle </td>
<td class="paramname"> <em>handle</em></td>
<td> ) </td>
<td><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create the internal representation of the socket from a socket handle. </p>
<p>This function can only be accessed by derived classes.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>OS-specific handle of the socket to wrap </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acb25ca5677518e871e75b30be377c73a"></a><!-- doxytag: member="sf::UdpSocket::Create" ref="acb25ca5677518e871e75b30be377c73a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Socket::Create </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create the internal representation of the socket. </p>
<p>This function can only be accessed by derived classes. </p>
</div>
</div>
<a class="anchor" id="a8a7f6b4462352aa42ceea915b5ab46d9"></a><!-- doxytag: member="sf::UdpSocket::GetHandle" ref="a8a7f6b4462352aa42ceea915b5ab46d9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SocketHandle sf::Socket::GetHandle </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the internal handle of the socket. </p>
<p>The returned handle may be invalid if the socket was not created yet (or already destroyed). This function can only be accessed by derived classes.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The internal (OS-specific) handle of the socket </dd></dl>
</div>
</div>
<a class="anchor" id="afacddd4a2d3ecb54e503f30850cdd64f"></a><!-- doxytag: member="sf::UdpSocket::GetLocalPort" ref="afacddd4a2d3ecb54e503f30850cdd64f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short sf::UdpSocket::GetLocalPort </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the port to which the socket is bound locally. </p>
<p>If the socket is not bound to a port, this function returns 0.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Port to which the socket is bound</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1UdpSocket.htm#a32d2945c5c6f9bf26a982a92626b6f21" title="Bind the socket to a specific port.">Bind</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0a1e39eec727677d210ca518aa5fec8f"></a><!-- doxytag: member="sf::UdpSocket::IsBlocking" ref="a0a1e39eec727677d210ca518aa5fec8f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::Socket::IsBlocking </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tell whether the socket is in blocking or non-blocking mode. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if the socket is blocking, false otherwise</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1Socket.htm#ac26a66c764fe459e301c49e2fa92f33f" title="Set the blocking state of the socket.">SetBlocking</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ab8ca3a91b8910d9389c0ff7fa8c1d770"></a><!-- doxytag: member="sf::UdpSocket::Receive" ref="ab8ca3a91b8910d9389c0ff7fa8c1d770" args="(Packet &packet, IpAddress &remoteAddress, unsigned short &remotePort)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">Status</a> sf::UdpSocket::Receive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td>
<td class="paramname"> <em>packet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classsf_1_1IpAddress.htm">IpAddress</a> & </td>
<td class="paramname"> <em>remoteAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short & </td>
<td class="paramname"> <em>remotePort</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receive a formatted packet of data from a remote peer. </p>
<p>In blocking mode, this function will wait until the whole packet has been received. Warning: this functon doesn't properly handle mixed data received from multiple peers.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td><a class="el" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a> to fill with the received data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remoteAddress</em> </td><td>Address of the peer that sent the data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remotePort</em> </td><td>Port of the peer that sent the data</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Status code</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1UdpSocket.htm#a41b3b5c17e88869dee5d0a31bbb30a0e" title="Send raw data to a remote peer.">Send</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a9f55f575443b358e0a5fb8bce50b2eff"></a><!-- doxytag: member="sf::UdpSocket::Receive" ref="a9f55f575443b358e0a5fb8bce50b2eff" args="(char *data, std::size_t size, std::size_t &received, IpAddress &remoteAddress, unsigned short &remotePort)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">Status</a> sf::UdpSocket::Receive </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t </td>
<td class="paramname"> <em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t & </td>
<td class="paramname"> <em>received</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classsf_1_1IpAddress.htm">IpAddress</a> & </td>
<td class="paramname"> <em>remoteAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short & </td>
<td class="paramname"> <em>remotePort</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receive raw data from a remote peer. </p>
<p>In blocking mode, this function will wait until some bytes are actually received. Be careful to use a buffer which is large enough for the data that you intend to receive, if it is too small then an error will be returned and *all* the data will be lost.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Pointer to the array to fill with the received bytes </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Maximum number of bytes that can be received </td></tr>
<tr><td valign="top"></td><td valign="top"><em>received</em> </td><td>This variable is filled with the actual number of bytes received </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remoteAddress</em> </td><td>Address of the peer that sent the data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remotePort</em> </td><td>Port of the peer that sent the data</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Status code</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1UdpSocket.htm#a41b3b5c17e88869dee5d0a31bbb30a0e" title="Send raw data to a remote peer.">Send</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a24cf211881167fe525408f67db646553"></a><!-- doxytag: member="sf::UdpSocket::Send" ref="a24cf211881167fe525408f67db646553" args="(Packet &packet, const IpAddress &remoteAddress, unsigned short remotePort)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">Status</a> sf::UdpSocket::Send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1Packet.htm">Packet</a> & </td>
<td class="paramname"> <em>packet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1IpAddress.htm">IpAddress</a> & </td>
<td class="paramname"> <em>remoteAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"> <em>remotePort</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send a formatted packet of data to a remote peer. </p>
<p>Make sure that the packet size is not greater than <a class="el" href="classsf_1_1UdpSocket.htm#a0a8d64f52c57746869b063bcb20674fea728a7d33027bee0d65f70f964dd9c9eb" title="The maximum number of bytes that can be sent in a single UDP datagram.">UdpSocket::MaxDatagramSize</a>, otherwise this function will fail and no data will be sent.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td><a class="el" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a> to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remoteAddress</em> </td><td>Address of the receiver </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remotePort</em> </td><td>Port of the receiver to send the data to</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Status code</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1UdpSocket.htm#a9f55f575443b358e0a5fb8bce50b2eff" title="Receive raw data from a remote peer.">Receive</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a41b3b5c17e88869dee5d0a31bbb30a0e"></a><!-- doxytag: member="sf::UdpSocket::Send" ref="a41b3b5c17e88869dee5d0a31bbb30a0e" args="(const char *data, std::size_t size, const IpAddress &remoteAddress, unsigned short remotePort)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc">Status</a> sf::UdpSocket::Send </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t </td>
<td class="paramname"> <em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1IpAddress.htm">IpAddress</a> & </td>
<td class="paramname"> <em>remoteAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"> <em>remotePort</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send raw data to a remote peer. </p>
<p>Make sure that <em>size</em> is not greater than <a class="el" href="classsf_1_1UdpSocket.htm#a0a8d64f52c57746869b063bcb20674fea728a7d33027bee0d65f70f964dd9c9eb" title="The maximum number of bytes that can be sent in a single UDP datagram.">UdpSocket::MaxDatagramSize</a>, otherwise this function will fail and no data will be sent.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Pointer to the sequence of bytes to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Number of bytes to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remoteAddress</em> </td><td>Address of the receiver </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remotePort</em> </td><td>Port of the receiver to send the data to</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Status code</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1UdpSocket.htm#a9f55f575443b358e0a5fb8bce50b2eff" title="Receive raw data from a remote peer.">Receive</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac26a66c764fe459e301c49e2fa92f33f"></a><!-- doxytag: member="sf::UdpSocket::SetBlocking" ref="ac26a66c764fe459e301c49e2fa92f33f" args="(bool blocking)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Socket::SetBlocking </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>blocking</em></td>
<td> ) </td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the blocking state of the socket. </p>
<p>In blocking mode, calls will not return until they have completed their task. For example, a call to Receive in blocking mode won't return until some data was actually received. In non-blocking mode, calls will always return immediately, using the return code to signal whether there was data available or not. By default, all sockets are blocking.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>blocking</em> </td><td>True to set the socket as blocking, false for non-blocking</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1Socket.htm#a0a1e39eec727677d210ca518aa5fec8f" title="Tell whether the socket is in blocking or non-blocking mode.">IsBlocking</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad2ab1e3459575749611d8e0dfd806d39"></a><!-- doxytag: member="sf::UdpSocket::Unbind" ref="ad2ab1e3459575749611d8e0dfd806d39" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::UdpSocket::Unbind </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unbind the socket from the local port to which it is bound. </p>
<p>The port that the socket was previously using is immediately available after this function is called. If the socket is not bound to a port, this function has no effect.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1UdpSocket.htm#a32d2945c5c6f9bf26a982a92626b6f21" title="Bind the socket to a specific port.">Bind</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="UdpSocket_8hpp_source.htm">UdpSocket.hpp</a></li>
</ul>
</div>
<p id="footer">
:: Copyright © 2007-2008 Laurent Gomila, all rights reserved ::
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> ::
</p>
</body>
</html>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
f00c83953c7eb23ee3c18f4f35d8eb6b
>
files
>
293
