SFML 2.5.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

TcpSocket.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
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
31#include <SFML/Network/Export.hpp>
32#include <SFML/Network/Socket.hpp>
33#include <SFML/System/Time.hpp>
34
35
36 namespace sf
37{
38 class TcpListener;
39 class IpAddress;
40 class Packet;
41
46 class SFML_NETWORK_API TcpSocket : public Socket
47{
48 public:
49
54 TcpSocket();
55
66 unsigned short getLocalPort() const;
67
79 IpAddress getRemoteAddress() const;
80
92 unsigned short getRemotePort() const;
93
112 Status connect(const IpAddress& remoteAddress, unsigned short remotePort, Time timeout = Time::Zero);
113
123 void disconnect();
124
141 Status send(const void* data, std::size_t size);
142
157 Status send(const void* data, std::size_t size, std::size_t& sent);
158
175 Status receive(void* data, std::size_t size, std::size_t& received);
176
193 Status send(Packet& packet);
194
209 Status receive(Packet& packet);
210
211 private:
212
213 friend class TcpListener;
214
219 struct PendingPacket
220 {
221 PendingPacket();
222
223 Uint32 Size;
224 std::size_t SizeReceived;
225 std::vector<char> Data;
226 };
227
229 // Member data
231 PendingPacket m_pendingPacket;
232};
233
234} // namespace sf
235
236
237#endif // SFML_TCPSOCKET_HPP
238
239
sf::IpAddress
Encapsulate an IPv4 network address.
Definition: IpAddress.hpp:45
sf::Packet
Utility class to build blocks of data to transfer over the network.
Definition: Packet.hpp:48
sf::Socket
Base class for all the socket types.
Definition: Socket.hpp:46
sf::Socket::Status
Status
Status codes that may be returned by socket functions.
Definition: Socket.hpp:54
sf::TcpListener
Socket that listens to new TCP connections.
Definition: TcpListener.hpp:45
sf::TcpSocket
Specialized socket using the TCP protocol.
Definition: TcpSocket.hpp:47
sf::TcpSocket::send
Status send(Packet &packet)
Send a formatted packet of data to the remote peer.
sf::TcpSocket::send
Status send(const void *data, std::size_t size, std::size_t &sent)
Send raw data to the remote peer.
sf::TcpSocket::TcpSocket
TcpSocket()
Default constructor.
sf::TcpSocket::connect
Status connect(const IpAddress &remoteAddress, unsigned short remotePort, Time timeout=Time::Zero)
Connect the socket to a remote peer.
sf::TcpSocket::receive
Status receive(void *data, std::size_t size, std::size_t &received)
Receive raw data from the remote peer.
sf::TcpSocket::getRemotePort
unsigned short getRemotePort() const
Get the port of the connected peer to which the socket is connected.
sf::TcpSocket::getLocalPort
unsigned short getLocalPort() const
Get the port to which the socket is bound locally.
sf::TcpSocket::receive
Status receive(Packet &packet)
Receive a formatted packet of data from the remote peer.
sf::TcpSocket::getRemoteAddress
IpAddress getRemoteAddress() const
Get the address of the connected peer.
sf::TcpSocket::disconnect
void disconnect()
Disconnect the socket from its remote peer.
sf::TcpSocket::send
Status send(const void *data, std::size_t size)
Send raw data to the remote peer.
sf::Time
Represents a time value.
Definition: Time.hpp:41
sf::Time::Zero
static const Time Zero
Predefined "zero" time value.
Definition: Time.hpp:85