You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
162 lines
5.2 KiB
162 lines
5.2 KiB
//////////////////////////////////////////////////////////// |
|
// |
|
// SFML - Simple and Fast Multimedia Library |
|
// Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com) |
|
// |
|
// This software is provided 'as-is', without any express or implied warranty. |
|
// In no event will the authors be held liable for any damages arising from the use of this software. |
|
// |
|
// Permission is granted to anyone to use this software for any purpose, |
|
// including commercial applications, and to alter it and redistribute it freely, |
|
// subject to the following restrictions: |
|
// |
|
// 1. The origin of this software must not be misrepresented; |
|
// you must not claim that you wrote the original software. |
|
// If you use this software in a product, an acknowledgment |
|
// in the product documentation would be appreciated but is not required. |
|
// |
|
// 2. Altered source versions must be plainly marked as such, |
|
// and must not be misrepresented as being the original software. |
|
// |
|
// 3. This notice may not be removed or altered from any source distribution. |
|
// |
|
//////////////////////////////////////////////////////////// |
|
|
|
#ifndef SFML_TCPLISTENER_HPP |
|
#define SFML_TCPLISTENER_HPP |
|
|
|
//////////////////////////////////////////////////////////// |
|
// Headers |
|
//////////////////////////////////////////////////////////// |
|
#include <SFML/Network/Export.hpp> |
|
#include <SFML/Network/Socket.hpp> |
|
|
|
|
|
namespace sf |
|
{ |
|
class TcpSocket; |
|
|
|
//////////////////////////////////////////////////////////// |
|
/// \brief Socket that listens to new TCP connections |
|
/// |
|
//////////////////////////////////////////////////////////// |
|
class SFML_NETWORK_API TcpListener : public Socket |
|
{ |
|
public : |
|
|
|
//////////////////////////////////////////////////////////// |
|
/// \brief Default constructor |
|
/// |
|
//////////////////////////////////////////////////////////// |
|
TcpListener(); |
|
|
|
//////////////////////////////////////////////////////////// |
|
/// \brief Get the port to which the socket is bound locally |
|
/// |
|
/// If the socket is not listening to a port, this function |
|
/// returns 0. |
|
/// |
|
/// \return Port to which the socket is bound |
|
/// |
|
/// \see listen |
|
/// |
|
//////////////////////////////////////////////////////////// |
|
unsigned short getLocalPort() const; |
|
|
|
//////////////////////////////////////////////////////////// |
|
/// \brief Start listening for connections |
|
/// |
|
/// This functions makes the socket listen to the specified |
|
/// port, waiting for new connections. |
|
/// If the socket was previously listening to another port, |
|
/// it will be stopped first and bound to the new port. |
|
/// |
|
/// \param port Port to listen for new connections |
|
/// |
|
/// \return Status code |
|
/// |
|
/// \see accept, close |
|
/// |
|
//////////////////////////////////////////////////////////// |
|
Status listen(unsigned short port); |
|
|
|
//////////////////////////////////////////////////////////// |
|
/// \brief Stop listening and close the socket |
|
/// |
|
/// This function gracefully stops the listener. If the |
|
/// socket is not listening, this function has no effect. |
|
/// |
|
/// \see listen |
|
/// |
|
//////////////////////////////////////////////////////////// |
|
void close(); |
|
|
|
//////////////////////////////////////////////////////////// |
|
/// \brief Accept a new connection |
|
/// |
|
/// If the socket is in blocking mode, this function will |
|
/// not return until a connection is actually received. |
|
/// |
|
/// \param socket Socket that will hold the new connection |
|
/// |
|
/// \return Status code |
|
/// |
|
/// \see listen |
|
/// |
|
//////////////////////////////////////////////////////////// |
|
Status accept(TcpSocket& socket); |
|
}; |
|
|
|
|
|
} // namespace sf |
|
|
|
|
|
#endif // SFML_TCPLISTENER_HPP |
|
|
|
|
|
//////////////////////////////////////////////////////////// |
|
/// \class sf::TcpListener |
|
/// \ingroup network |
|
/// |
|
/// A listener socket is a special type of socket that listens to |
|
/// a given port and waits for connections on that port. |
|
/// This is all it can do. |
|
/// |
|
/// When a new connection is received, you must call accept and |
|
/// the listener returns a new instance of sf::TcpSocket that |
|
/// is properly initialized and can be used to communicate with |
|
/// the new client. |
|
/// |
|
/// Listener sockets are specific to the TCP protocol, |
|
/// UDP sockets are connectionless and can therefore communicate |
|
/// directly. As a consequence, a listener socket will always |
|
/// return the new connections as sf::TcpSocket instances. |
|
/// |
|
/// A listener is automatically closed on destruction, like all |
|
/// other types of socket. However if you want to stop listening |
|
/// before the socket is destroyed, you can call its close() |
|
/// function. |
|
/// |
|
/// Usage example: |
|
/// \code |
|
/// // Create a listener socket and make it wait for new |
|
/// // connections on port 55001 |
|
/// sf::TcpListener listener; |
|
/// listener.listen(55001); |
|
/// |
|
/// // Endless loop that waits for new connections |
|
/// while (running) |
|
/// { |
|
/// sf::TcpSocket client; |
|
/// if (listener.accept(client) == sf::Socket::Done) |
|
/// { |
|
/// // A new client just connected! |
|
/// std::cout << "New connection received from " << client.getRemoteAddress() << std::endl; |
|
/// doSomethingWith(client); |
|
/// } |
|
/// } |
|
/// \endcode |
|
/// |
|
/// \see sf::TcpSocket, sf::Socket |
|
/// |
|
////////////////////////////////////////////////////////////
|
|
|