<!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><a href="annotated.htm"><span>Classes</span></a></li>
<li class="current"><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.htm"><span>File List</span></a></li>
</ul>
</div>
<h1>TcpSocket.hpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// SFML - Simple and Fast Multimedia Library</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)</span>
<a name="l00005"></a>00005 <span class="comment">//</span>
<a name="l00006"></a>00006 <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span>
<a name="l00007"></a>00007 <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span>
<a name="l00008"></a>00008 <span class="comment">//</span>
<a name="l00009"></a>00009 <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span>
<a name="l00010"></a>00010 <span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span>
<a name="l00011"></a>00011 <span class="comment">// subject to the following restrictions:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// 1. The origin of this software must not be misrepresented;</span>
<a name="l00014"></a>00014 <span class="comment">// you must not claim that you wrote the original software.</span>
<a name="l00015"></a>00015 <span class="comment">// If you use this software in a product, an acknowledgment</span>
<a name="l00016"></a>00016 <span class="comment">// in the product documentation would be appreciated but is not required.</span>
<a name="l00017"></a>00017 <span class="comment">//</span>
<a name="l00018"></a>00018 <span class="comment">// 2. Altered source versions must be plainly marked as such,</span>
<a name="l00019"></a>00019 <span class="comment">// and must not be misrepresented as being the original software.</span>
<a name="l00020"></a>00020 <span class="comment">//</span>
<a name="l00021"></a>00021 <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span>
<a name="l00022"></a>00022 <span class="comment">//</span>
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef SFML_TCPSOCKET_HPP</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define SFML_TCPSOCKET_HPP</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="comment">// Headers</span>
<a name="l00031"></a>00031 <span class="comment"></span><span class="preprocessor">#include <SFML/Network/Socket.hpp></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">namespace </span>sf
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 <span class="keyword">class </span>TcpListener;
<a name="l00037"></a>00037 <span class="keyword">class </span>IpAddress;
<a name="l00038"></a>00038 <span class="keyword">class </span>Packet;
<a name="l00039"></a>00039
<a name="l00044"></a><a class="code" href="classsf_1_1TcpSocket.htm">00044</a> <span class="keyword">class </span>SFML_API <a class="code" href="classsf_1_1TcpSocket.htm" title="Specialized socket using the TCP protocol.">TcpSocket</a> : <span class="keyword">public</span> <a class="code" href="classsf_1_1Socket.htm" title="Base class for all the socket types.">Socket</a>
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 <span class="keyword">public</span> :
<a name="l00047"></a>00047
<a name="l00052"></a>00052 <a class="code" href="classsf_1_1TcpSocket.htm" title="Specialized socket using the TCP protocol.">TcpSocket</a>();
<a name="l00053"></a>00053
<a name="l00064"></a>00064 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> GetLocalPort() <span class="keyword">const</span>;
<a name="l00065"></a>00065
<a name="l00077"></a>00077 <a class="code" href="classsf_1_1IpAddress.htm" title="Encapsulate an IPv4 network address.">IpAddress</a> GetRemoteAddress() <span class="keyword">const</span>;
<a name="l00078"></a>00078
<a name="l00090"></a>00090 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> GetRemotePort() <span class="keyword">const</span>;
<a name="l00091"></a>00091
<a name="l00109"></a>00109 <a class="code" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc" title="Status codes that may be returned by socket functions.">Status</a> Connect(<span class="keyword">const</span> <a class="code" href="classsf_1_1IpAddress.htm" title="Encapsulate an IPv4 network address.">IpAddress</a>& remoteAddress, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> remotePort, Uint32 timeout = 0);
<a name="l00110"></a>00110
<a name="l00120"></a>00120 <span class="keywordtype">void</span> Disconnect();
<a name="l00121"></a>00121
<a name="l00135"></a>00135 <a class="code" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc" title="Status codes that may be returned by socket functions.">Status</a> Send(<span class="keyword">const</span> <span class="keywordtype">char</span>* data, std::size_t size);
<a name="l00136"></a>00136
<a name="l00153"></a>00153 <a class="code" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc" title="Status codes that may be returned by socket functions.">Status</a> Receive(<span class="keywordtype">char</span>* data, std::size_t size, std::size_t& received);
<a name="l00154"></a>00154
<a name="l00167"></a>00167 <a class="code" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc" title="Status codes that may be returned by socket functions.">Status</a> Send(<a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& packet);
<a name="l00168"></a>00168
<a name="l00183"></a>00183 <a class="code" href="classsf_1_1Socket.htm#a51bf0fd51057b98a10fbb866246176dc" title="Status codes that may be returned by socket functions.">Status</a> Receive(<a class="code" href="classsf_1_1Packet.htm" title="Utility class to build blocks of data to transfer over the network.">Packet</a>& packet);
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="keyword">private</span>:
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classsf_1_1TcpListener.htm" title="Socket that listens to new TCP connections.">TcpListener</a>;
<a name="l00188"></a>00188
<a name="l00193"></a>00193 <span class="keyword">struct </span>PendingPacket
<a name="l00194"></a>00194 {
<a name="l00195"></a>00195 PendingPacket();
<a name="l00196"></a>00196
<a name="l00197"></a>00197 Uint32 Size;
<a name="l00198"></a>00198 std::size_t SizeReceived;
<a name="l00199"></a>00199 std::vector<char> Data;
<a name="l00200"></a>00200 };
<a name="l00201"></a>00201
<a name="l00203"></a>00203 <span class="comment">// Member data</span>
<a name="l00205"></a>00205 <span class="comment"></span> PendingPacket myPendingPacket;
<a name="l00206"></a>00206 };
<a name="l00207"></a>00207
<a name="l00208"></a>00208 } <span class="comment">// namespace sf</span>
<a name="l00209"></a>00209
<a name="l00210"></a>00210
<a name="l00211"></a>00211 <span class="preprocessor">#endif // SFML_TCPSOCKET_HPP</span>
<a name="l00212"></a>00212 <span class="preprocessor"></span>
<a name="l00213"></a>00213
</pre></div></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
>
126
