Loading...
Searching...
No Matches
TcpSocket.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef SFML_TCPSOCKET_HPP
26#define SFML_TCPSOCKET_HPP
27
29// Headers
33#include <SFML/System/Time.hpp>
34
35
36namespace sf
37{
38class TcpListener;
39class IpAddress;
40class Packet;
41
47{
48public :
49
55
66 unsigned short getLocalPort() const;
67
80
92 unsigned short getRemotePort() const;
93
111 Status connect(const IpAddress& remoteAddress, unsigned short remotePort, Time timeout = Time::Zero);
112
123
137 Status send(const void* data, std::size_t size);
138
155 Status receive(void* data, std::size_t size, std::size_t& received);
156
170
186
187private:
188
189 friend class TcpListener;
190
195 struct PendingPacket
196 {
197 PendingPacket();
198
199 Uint32 Size;
200 std::size_t SizeReceived;
201 std::vector<char> Data;
202 };
203
205 // Member data
207 PendingPacket m_pendingPacket;
208};
209
210} // namespace sf
211
212
213#endif // SFML_TCPSOCKET_HPP
214
215
#define SFML_NETWORK_API
Encapsulate an IPv4 network address.
Definition IpAddress.hpp:45
Utility class to build blocks of data to transfer over the network.
Definition Packet.hpp:48
Status
Status codes that may be returned by socket functions.
Definition Socket.hpp:54
Socket(Type type)
Default constructor.
Socket that listens to new TCP connections.
Status send(Packet &packet)
Send a formatted packet of data to the remote peer.
friend class TcpListener
TcpSocket()
Default constructor.
Status connect(const IpAddress &remoteAddress, unsigned short remotePort, Time timeout=Time::Zero)
Connect the socket to a remote peer.
Status receive(void *data, std::size_t size, std::size_t &received)
Receive raw data from the remote peer.
unsigned short getRemotePort() const
Get the port of the connected peer to which the socket is connected.
unsigned short getLocalPort() const
Get the port to which the socket is bound locally.
Status receive(Packet &packet)
Receive a formatted packet of data from the remote peer.
IpAddress getRemoteAddress() const
Get the address of the connected peer.
void disconnect()
Disconnect the socket from its remote peer.
Status send(const void *data, std::size_t size)
Send raw data to the remote peer.
Represents a time value.
Definition Time.hpp:41
static const Time Zero
Predefined "zero" time value.
Definition Time.hpp:85
unsigned int Uint32
Definition Config.hpp:145