Documentation of SFML 2.6.0

Warning: this page refers to an old version of SFML. Click here to switch to the latest version.
Loading...
Searching...
No Matches
TcpListener.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2023 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_TCPLISTENER_HPP
26#define SFML_TCPLISTENER_HPP
27
29// Headers
31#include <SFML/Network/Export.hpp>
32#include <SFML/Network/Socket.hpp>
33#include <SFML/Network/IpAddress.hpp>
34
35
36namespace sf
37{
38class TcpSocket;
39
44class SFML_NETWORK_API TcpListener : public Socket
45{
46public:
47
53
65 unsigned short getLocalPort() const;
66
89 Status listen(unsigned short port, const IpAddress& address = IpAddress::Any);
90
100 void close();
101
116};
117
118
119} // namespace sf
120
121
122#endif // SFML_TCPLISTENER_HPP
123
124
Encapsulate an IPv4 network address.
Definition: IpAddress.hpp:45
Base class for all the socket types.
Definition: Socket.hpp:46
Status
Status codes that may be returned by socket functions.
Definition: Socket.hpp:54
Socket that listens to new TCP connections.
Definition: TcpListener.hpp:45
void close()
Stop listening and close the socket.
TcpListener()
Default constructor.
unsigned short getLocalPort() const
Get the port to which the socket is bound locally.
Status listen(unsigned short port, const IpAddress &address=IpAddress::Any)
Start listening for incoming connection attempts.
Status accept(TcpSocket &socket)
Accept a new connection.
Specialized socket using the TCP protocol.
Definition: TcpSocket.hpp:47