<!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_1TcpSocket.htm">TcpSocket</a>
</div>
</div>
<div class="contents">
<h1>sf::TcpSocket Class Reference<br/>
<small>
[<a class="el" href="group__network.htm">Network module</a>]</small>
</h1><!-- doxytag: class="sf::TcpSocket" --><!-- doxytag: inherits="sf::Socket" -->
<p>Specialized socket using the TCP protocol.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="TcpSocket_8hpp_source.htm">TcpSocket.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for sf::TcpSocket:</div>
<div class="dynsection">
<div class="center">
<img src="classsf_1_1TcpSocket.png" usemap="#sf::TcpSocket_map" alt=""/>
<map id="sf::TcpSocket_map" name="sf::TcpSocket_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_1TcpSocket-members.htm">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>PendingPacket</b></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure holding the data of a pending packet. <br/></td></tr>
<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_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_1TcpSocket.htm#a62a9bf81fd7f15fedb29fd1348483236">TcpSocket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a62a9bf81fd7f15fedb29fd1348483236"></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_1TcpSocket.htm#af27ba8e15c5836645eb51ffa66a361fe">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="#af27ba8e15c5836645eb51ffa66a361fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1IpAddress.htm">IpAddress</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1TcpSocket.htm#a1e55a532da4ccf7777f41f76b310eed1">GetRemoteAddress</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the address of the connected peer. <a href="#a1e55a532da4ccf7777f41f76b310eed1"></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_1TcpSocket.htm#a7c977676f7ce48543b4bf3260ed78f77">GetRemotePort</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the port of the connected peer to which the socket is connected. <a href="#a7c977676f7ce48543b4bf3260ed78f77"></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_1TcpSocket.htm#aea95290070ffa4d70cf01aee066227e5">Connect</a> (const <a class="el" href="classsf_1_1IpAddress.htm">IpAddress</a> &remoteAddress, unsigned short remotePort, Uint32 timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect the socket to a remote peer. <a href="#aea95290070ffa4d70cf01aee066227e5"></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_1TcpSocket.htm#ac2506493980bc1cf17d56adc5df145fe">Disconnect</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect the socket from its remote peer. <a href="#ac2506493980bc1cf17d56adc5df145fe"></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_1TcpSocket.htm#a6fb3d5a6884006a14db58ebffe424e1b">Send</a> (const char *data, std::size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send raw data to the remote peer. <a href="#a6fb3d5a6884006a14db58ebffe424e1b"></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_1TcpSocket.htm#a975b0d8f5deb8c27c73e9c0a389c7ddf">Receive</a> (char *data, std::size_t size, std::size_t &received)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive raw data from the remote peer. <a href="#a975b0d8f5deb8c27c73e9c0a389c7ddf"></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_1TcpSocket.htm#a97939a24e6b381ff7feb6807602a6352">Send</a> (<a class="el" href="classsf_1_1Packet.htm">Packet</a> &packet)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a formatted packet of data to the remote peer. <a href="#a97939a24e6b381ff7feb6807602a6352"></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_1TcpSocket.htm#a713d88f9eb117db2a7e6e4002f2043fe">Receive</a> (<a class="el" href="classsf_1_1Packet.htm">Packet</a> &packet)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a formatted packet of data from the remote peer. <a href="#a713d88f9eb117db2a7e6e4002f2043fe"></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>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b2dd140834917bd44b512236bddea7c"></a><!-- doxytag: member="sf::TcpSocket::TcpListener" ref="a2b2dd140834917bd44b512236bddea7c" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>TcpListener</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Specialized socket using the TCP protocol. </p>
<p>TCP is a connected protocol, which means that a TCP socket can only communicate with the host it is connected to.</p>
<p>It can't send or receive anything if it is not connected.</p>
<p>The TCP protocol is reliable but adds a slight overhead. It ensures that your data will always be received in order and without errors (no data corrupted, lost or duplicated).</p>
<p>When a socket is connected to a remote host, you can retrieve informations about this host with the GetRemoteAddress and GetRemotePort functions. You can also get the local port to which the socket is bound (which is automatically chosen when the socket is connected), with the GetLocalPort function.</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, and cannot ensure that one call to Send will exactly match one call to Receive at the other end of the socket.</p>
<p>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>The socket is automatically disconnected when it is destroyed, but if you want to explicitely close the connection while the socket instance is still alive, you can call Disconnect.</p>
<p>Usage example: </p>
<div class="fragment"><pre class="fragment"> <span class="comment">// ----- The client -----</span>
<span class="comment">// Create a socket and connect it to 192.168.1.50 on port 55001</span>
<a class="code" href="classsf_1_1TcpSocket.htm" title="Specialized socket using the TCP protocol.">sf::TcpSocket</a> socket;
socket.<a class="code" href="classsf_1_1TcpSocket.htm#aea95290070ffa4d70cf01aee066227e5" title="Connect the socket to a remote peer.">Connect</a>(<span class="stringliteral">"192.168.1.50"</span>, 55001);
<span class="comment">// Send a message to the connected host</span>
std::string message = <span class="stringliteral">"Hi, I am a client"</span>;
socket.<a class="code" href="classsf_1_1TcpSocket.htm#a6fb3d5a6884006a14db58ebffe424e1b" title="Send raw data to the remote peer.">Send</a>(message.c_str(), message.size() + 1);
<span class="comment">// Receive an answer from the server</span>
<span class="keywordtype">char</span> buffer[1024];
std::size_t received = 0;
socket.<a class="code" href="classsf_1_1TcpSocket.htm#a975b0d8f5deb8c27c73e9c0a389c7ddf" title="Receive raw data from the remote peer.">Receive</a>(buffer, <span class="keyword">sizeof</span>(buffer), received);
std::cout << <span class="stringliteral">"The server said: "</span> << buffer << std::endl;
<span class="comment">// ----- The server -----</span>
<span class="comment">// Create a listener to wait for incoming connections on port 55001</span>
<a class="code" href="classsf_1_1TcpListener.htm" title="Socket that listens to new TCP connections.">sf::TcpListener</a> listener;
listener.<a class="code" href="classsf_1_1TcpListener.htm#abf00e8a1a24515985264f0494912f766" title="Start listening for connections.">Listen</a>(55001);
<span class="comment">// Wait for a connection</span>
<a class="code" href="classsf_1_1TcpSocket.htm" title="Specialized socket using the TCP protocol.">sf::TcpSocket</a> socket;
listener.<a class="code" href="classsf_1_1TcpListener.htm#ae9201b7c687c455f94c1575221bbb27f" title="Accept a new connection.">Accept</a>(socket);
std::cout << <span class="stringliteral">"New client connected: "</span> << socket.<a class="code" href="classsf_1_1TcpSocket.htm#a1e55a532da4ccf7777f41f76b310eed1" title="Get the address of the connected peer.">GetRemoteAddress</a>() << std::endl;
<span class="comment">// Receive a message from the client</span>
<span class="keywordtype">char</span> buffer[1024];
std::size_t received = 0;
socket.<a class="code" href="classsf_1_1TcpSocket.htm#a975b0d8f5deb8c27c73e9c0a389c7ddf" title="Receive raw data from the remote peer.">Receive</a>(buffer, <span class="keyword">sizeof</span>(buffer), received);
std::cout << <span class="stringliteral">"The client said: "</span> << buffer << std::endl;
<span class="comment">// Send an answer</span>
std::string message = <span class="stringliteral">"Welcome, client"</span>;
socket.<a class="code" href="classsf_1_1TcpSocket.htm#a6fb3d5a6884006a14db58ebffe424e1b" title="Send raw data to the remote peer.">Send</a>(message.c_str(), message.size() + 1);
</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_1UdpSocket.htm" title="Specialized socket using the UDP protocol.">sf::UdpSocket</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="TcpSocket_8hpp_source.htm#l00044">44</a> of file <a class="el" href="TcpSocket_8hpp_source.htm">TcpSocket.hpp</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ad4c6b76944f72009fef53c8594f1c638"></a><!-- doxytag: member="sf::TcpSocket::@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="a51bf0fd51057b98a10fbb866246176dc"></a><!-- doxytag: member="sf::TcpSocket::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::TcpSocket::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="a62a9bf81fd7f15fedb29fd1348483236"></a><!-- doxytag: member="sf::TcpSocket::TcpSocket" ref="a62a9bf81fd7f15fedb29fd1348483236" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::TcpSocket::TcpSocket </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="a4c19ac40a7996f51301c618ed12bd4fe"></a><!-- doxytag: member="sf::TcpSocket::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="aea95290070ffa4d70cf01aee066227e5"></a><!-- doxytag: member="sf::TcpSocket::Connect" ref="aea95290070ffa4d70cf01aee066227e5" args="(const IpAddress &remoteAddress, unsigned short remotePort, Uint32 timeout=0)" -->
<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::TcpSocket::Connect </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint32 </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connect the socket to a remote peer. </p>
<p>In blocking mode, this function may take a while, especially if the remote peer is not reachable. The last parameter allows you to stop trying to connect after a given timeout. If the socket was previously connected, it is first disconnected.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>remoteAddress</em> </td><td>Address of the remote peer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remotePort</em> </td><td>Port of the remote peer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>Optional maximum time to wait, in milliseconds</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_1TcpSocket.htm#ac2506493980bc1cf17d56adc5df145fe" title="Disconnect the socket from its remote peer.">Disconnect</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a225d6398c641e342c2f57ed9b7a974d4"></a><!-- doxytag: member="sf::TcpSocket::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::TcpSocket::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="ac2506493980bc1cf17d56adc5df145fe"></a><!-- doxytag: member="sf::TcpSocket::Disconnect" ref="ac2506493980bc1cf17d56adc5df145fe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::TcpSocket::Disconnect </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disconnect the socket from its remote peer. </p>
<p>This function gracefully closes the connection. If the socket is not connected, this function has no effect.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1TcpSocket.htm#aea95290070ffa4d70cf01aee066227e5" title="Connect the socket to a remote peer.">Connect</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a8a7f6b4462352aa42ceea915b5ab46d9"></a><!-- doxytag: member="sf::TcpSocket::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="af27ba8e15c5836645eb51ffa66a361fe"></a><!-- doxytag: member="sf::TcpSocket::GetLocalPort" ref="af27ba8e15c5836645eb51ffa66a361fe" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short sf::TcpSocket::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 connected, 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_1TcpSocket.htm#aea95290070ffa4d70cf01aee066227e5" title="Connect the socket to a remote peer.">Connect</a>, <a class="el" href="classsf_1_1TcpSocket.htm#a7c977676f7ce48543b4bf3260ed78f77" title="Get the port of the connected peer to which the socket is connected.">GetRemotePort</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1e55a532da4ccf7777f41f76b310eed1"></a><!-- doxytag: member="sf::TcpSocket::GetRemoteAddress" ref="a1e55a532da4ccf7777f41f76b310eed1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1IpAddress.htm">IpAddress</a> sf::TcpSocket::GetRemoteAddress </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the address of the connected peer. </p>
<p>It the socket is not connected, this function returns <a class="el" href="classsf_1_1IpAddress.htm#a4619b4abbe3c8fef056e7299db967404" title="Value representing an empty/invalid address.">sf::IpAddress::None</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Address of the remote peer</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1TcpSocket.htm#a7c977676f7ce48543b4bf3260ed78f77" title="Get the port of the connected peer to which the socket is connected.">GetRemotePort</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a7c977676f7ce48543b4bf3260ed78f77"></a><!-- doxytag: member="sf::TcpSocket::GetRemotePort" ref="a7c977676f7ce48543b4bf3260ed78f77" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short sf::TcpSocket::GetRemotePort </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the port of the connected peer to which the socket is connected. </p>
<p>If the socket is not connected, this function returns 0.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Remote port to which the socket is connected</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classsf_1_1TcpSocket.htm#a1e55a532da4ccf7777f41f76b310eed1" title="Get the address of the connected peer.">GetRemoteAddress</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0a1e39eec727677d210ca518aa5fec8f"></a><!-- doxytag: member="sf::TcpSocket::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="a713d88f9eb117db2a7e6e4002f2043fe"></a><!-- doxytag: member="sf::TcpSocket::Receive" ref="a713d88f9eb117db2a7e6e4002f2043fe" args="(Packet &packet)" -->
<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::TcpSocket::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>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receive a formatted packet of data from the remote peer. </p>
<p>In blocking mode, this function will wait until the whole packet has been received. This function will fail if the socket is not connected.</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>
</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_1TcpSocket.htm#a6fb3d5a6884006a14db58ebffe424e1b" title="Send raw data to the remote peer.">Send</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a975b0d8f5deb8c27c73e9c0a389c7ddf"></a><!-- doxytag: member="sf::TcpSocket::Receive" ref="a975b0d8f5deb8c27c73e9c0a389c7ddf" args="(char *data, std::size_t size, std::size_t &received)" -->
<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::TcpSocket::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><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 the remote peer. </p>
<p>In blocking mode, this function will wait until some bytes are actually received. This function will fail if the socket is not connected.</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>
</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_1TcpSocket.htm#a6fb3d5a6884006a14db58ebffe424e1b" title="Send raw data to the remote peer.">Send</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a97939a24e6b381ff7feb6807602a6352"></a><!-- doxytag: member="sf::TcpSocket::Send" ref="a97939a24e6b381ff7feb6807602a6352" args="(Packet &packet)" -->
<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::TcpSocket::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>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send a formatted packet of data to the remote peer. </p>
<p>This function will fail if the socket is not connected.</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>
</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_1TcpSocket.htm#a975b0d8f5deb8c27c73e9c0a389c7ddf" title="Receive raw data from the remote peer.">Receive</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6fb3d5a6884006a14db58ebffe424e1b"></a><!-- doxytag: member="sf::TcpSocket::Send" ref="a6fb3d5a6884006a14db58ebffe424e1b" args="(const char *data, std::size_t size)" -->
<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::TcpSocket::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><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 the remote peer. </p>
<p>This function will fail if the socket is not connected.</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>
</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_1TcpSocket.htm#a975b0d8f5deb8c27c73e9c0a389c7ddf" title="Receive raw data from the remote peer.">Receive</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac26a66c764fe459e301c49e2fa92f33f"></a><!-- doxytag: member="sf::TcpSocket::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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="TcpSocket_8hpp_source.htm">TcpSocket.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
>
275
