Edgaru089/SFML
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added missing documentation about TcpListener::listen and Socket::AnyPort.

Browse Source
This commit is contained in:
Quentin Bazin 2020-05-11 15:01:26 +02:00 committed by Lukas Dürrenberger
parent f57d4620ab
commit f93372f98a
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/SFML/Network/TcpListener.hpp
View File

@ -74,6 +74,10 @@ public:
/// function is called, it will stop listening on the old /// function is called, it will stop listening on the old
/// port before starting to listen on the new port. /// port before starting to listen on the new port.
/// ///
/// When providing sf::Socket::AnyPort as port, the listener
/// will request an available port from the system.
/// The chosen port can be retrieved by calling getLocalPort().
///
/// \param port Port to listen on for incoming connection attempts /// \param port Port to listen on for incoming connection attempts
/// \param address Address of the interface to listen on /// \param address Address of the interface to listen on
/// ///

7
include/SFML/Network/UdpSocket.hpp
View File

@ -78,9 +78,10 @@ public:
/// ///
/// Binding the socket to a port is necessary for being /// Binding the socket to a port is necessary for being
/// able to receive data on that port. /// able to receive data on that port.
/// You can use the special value Socket::AnyPort to tell the ///
/// system to automatically pick an available port, and then /// When providing sf::Socket::AnyPort as port, the listener
/// call getLocalPort to retrieve the chosen port. /// will request an available port from the system.
/// The chosen port can be retrieved by calling getLocalPort().
/// ///
/// Since the socket can only be bound to a single port at /// Since the socket can only be bound to a single port at
/// any given moment, if it is already bound when this /// any given moment, if it is already bound when this