.. index:: pair: class; EE::Network::TcpListener
.. _doxid-class_e_e_1_1_network_1_1_tcp_listener:

class EE::Network::TcpListener
==============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

:ref:`Socket <doxid-class_e_e_1_1_network_1_1_socket>` that listens to new TCP connections. :ref:`More...<details-class_e_e_1_1_network_1_1_tcp_listener>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <tcplistener.hpp>
	
	class TcpListener: public :ref:`EE::Network::Socket<doxid-class_e_e_1_1_network_1_1_socket>` {
	public:
		// methods
	
		unsigned short :ref:`getLocalPort<doxid-class_e_e_1_1_network_1_1_tcp_listener_1a4a4e047aba5d087506ca5cbc6307e88d>`() const;
		:ref:`Status<doxid-class_e_e_1_1_network_1_1_socket_1a1773a763f187293346c3efe073d6d4a9>` :ref:`listen<doxid-class_e_e_1_1_network_1_1_tcp_listener_1ae9f8ceb8b11399fc77cc8a3cec8c3df4>`(unsigned short port, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& address = :ref:`IpAddress::Any<doxid-class_e_e_1_1_network_1_1_ip_address_1af86fbb465852602e7f307b55591fbfc5>`);
		void :ref:`close<doxid-class_e_e_1_1_network_1_1_tcp_listener_1a0bba6c01a50f45f993ac22ad7a230085>`();
		:ref:`Status<doxid-class_e_e_1_1_network_1_1_socket_1a1773a763f187293346c3efe073d6d4a9>` :ref:`accept<doxid-class_e_e_1_1_network_1_1_tcp_listener_1aab5e5241bb8bea716d90f991cf93deb7>`(:ref:`TcpSocket<doxid-class_e_e_1_1_network_1_1_tcp_socket>`& socket);
	};

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// enums
	
		enum {
		    :ref:`AnyPort<doxid-class_e_e_1_1_network_1_1_socket_1aef2c62da180f35c2929b74232065cd07a471e0ea3d91d6c8710afe793686a42dd>` = 0,
		};
	
		enum :ref:`Status<doxid-class_e_e_1_1_network_1_1_socket_1a1773a763f187293346c3efe073d6d4a9>`;

		// methods
	
		void :ref:`setBlocking<doxid-class_e_e_1_1_network_1_1_socket_1a2c93eb187c95d7ef9948cb51b79f8943>`(bool blocking);
		bool :ref:`isBlocking<doxid-class_e_e_1_1_network_1_1_socket_1aae9c7f6550d1eea38a12839fbea3d356>`() const;

.. _details-class_e_e_1_1_network_1_1_tcp_listener:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

:ref:`Socket <doxid-class_e_e_1_1_network_1_1_socket>` that listens to new TCP connections.

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 :ref:`TcpSocket <doxid-class_e_e_1_1_network_1_1_tcp_socket>` 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 :ref:`TcpSocket <doxid-class_e_e_1_1_network_1_1_tcp_socket>` 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 :ref:`close() <doxid-class_e_e_1_1_network_1_1_tcp_listener_1a0bba6c01a50f45f993ac22ad7a230085>` function.

Usage example:

.. ref-code-block:: cpp

	// Create a listener socket and make it wait for new
	// connections on port 55001
	TcpListener listener;
	listener.listen(55001);
	
	// Endless loop that waits for new connections
	while (running) {
	     TcpSocket client;
	     if (listener.accept(client) == Socket::Done) {
	         // A new client just connected!
	         std::cout << "New connection received from " << client.getRemoteAddress() << std::endl;
	         doSomethingWith(client);
	     }
	}



.. rubric:: See also:

:ref:`EE::Network::TcpSocket <doxid-class_e_e_1_1_network_1_1_tcp_socket>`, :ref:`EE::Network::Socket <doxid-class_e_e_1_1_network_1_1_socket>`

Methods
-------

.. index:: pair: function; getLocalPort
.. _doxid-class_e_e_1_1_network_1_1_tcp_listener_1a4a4e047aba5d087506ca5cbc6307e88d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned short getLocalPort() const

Get the port to which the socket is bound locally If the socket is not listening to a port, this function returns 0.



.. rubric:: Returns:

Port to which the socket is bound



.. rubric:: See also:

Listen

.. index:: pair: function; listen
.. _doxid-class_e_e_1_1_network_1_1_tcp_listener_1ae9f8ceb8b11399fc77cc8a3cec8c3df4:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Status<doxid-class_e_e_1_1_network_1_1_socket_1a1773a763f187293346c3efe073d6d4a9>` listen(unsigned short port, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& address = :ref:`IpAddress::Any<doxid-class_e_e_1_1_network_1_1_ip_address_1af86fbb465852602e7f307b55591fbfc5>`)

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.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- port

		- Port to listen for new connections

	*
		- address

		- Address of the interface to listen on



.. rubric:: Returns:

Status code



.. rubric:: See also:

Accept, Close

.. index:: pair: function; close
.. _doxid-class_e_e_1_1_network_1_1_tcp_listener_1a0bba6c01a50f45f993ac22ad7a230085:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void close()

Stop listening and close the socket This function gracefully stops the listener. If the socket is not listening, this function has no effect.



.. rubric:: See also:

Listen

.. index:: pair: function; accept
.. _doxid-class_e_e_1_1_network_1_1_tcp_listener_1aab5e5241bb8bea716d90f991cf93deb7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Status<doxid-class_e_e_1_1_network_1_1_socket_1a1773a763f187293346c3efe073d6d4a9>` accept(:ref:`TcpSocket<doxid-class_e_e_1_1_network_1_1_tcp_socket>`& socket)

Accept a new connection If the socket is in blocking mode, this function will not return until a connection is actually received.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- socket

		- :ref:`Socket <doxid-class_e_e_1_1_network_1_1_socket>` that will hold the new connection



.. rubric:: Returns:

Status code



.. rubric:: See also:

Listen