.. index:: pair: namespace; EE::Network
.. _doxid-namespace_e_e_1_1_network:

namespace EE::Network
=====================

.. toctree::
	:hidden:

	namespace_EE_Network_SSL.rst
	class_EE_Network_Ftp.rst
	class_EE_Network_Http.rst
	class_EE_Network_IpAddress.rst
	class_EE_Network_Packet.rst
	class_EE_Network_Socket.rst
	class_EE_Network_SocketSelector.rst
	class_EE_Network_TcpListener.rst
	class_EE_Network_TcpSocket.rst
	class_EE_Network_URI.rst
	class_EE_Network_UdpSocket.rst

Overview
~~~~~~~~




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

	
	namespace Network {

	// namespaces

	namespace :ref:`EE::Network::SSL<doxid-namespace_e_e_1_1_network_1_1_s_s_l>`;

	// typedefs

	typedef UINT_PTR :ref:`SocketHandle<doxid-namespace_e_e_1_1_network_1a8a509d8095f453463cefd7709f3509f3>`;

	// classes

	class :ref:`Ftp<doxid-class_e_e_1_1_network_1_1_ftp>`;
	class :ref:`Http<doxid-class_e_e_1_1_network_1_1_http>`;
	class :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`;
	class :ref:`Packet<doxid-class_e_e_1_1_network_1_1_packet>`;
	class :ref:`Socket<doxid-class_e_e_1_1_network_1_1_socket>`;
	class :ref:`SocketSelector<doxid-class_e_e_1_1_network_1_1_socket_selector>`;
	class :ref:`TcpListener<doxid-class_e_e_1_1_network_1_1_tcp_listener>`;
	class :ref:`TcpSocket<doxid-class_e_e_1_1_network_1_1_tcp_socket>`;
	class :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`;
	class :ref:`UdpSocket<doxid-class_e_e_1_1_network_1_1_udp_socket>`;

	// global functions

	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool :ref:`operator==<doxid-namespace_e_e_1_1_network_1abb936db8f990c19daadb44406a754367>`(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right);
	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool :ref:`operator!=<doxid-namespace_e_e_1_1_network_1a55c3af46947fbbe24c3aa7abadc85220>`(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right);
	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool :ref:`operator<<doxid-namespace_e_e_1_1_network_1a3ce6ee8e9db6052b05851045d686b72c>`(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right);
	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool :ref:`operator><doxid-namespace_e_e_1_1_network_1acfb339b7eabe86684cc3fb1f137bcec2>`(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right);
	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool :ref:`operator<=<doxid-namespace_e_e_1_1_network_1a20ef9efdb7faee41ddead1f9cb754eac>`(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right);
	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool :ref:`operator>=<doxid-namespace_e_e_1_1_network_1a7f9413a0f64b6b2404c7de6eea9de5f8>`(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right);
	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` std::istream& :ref:`operator>><doxid-namespace_e_e_1_1_network_1a0196b0ea780c2870305e491300ae5943>`(std::istream& stream, :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& address);
	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` std::ostream& :ref:`operator<<<doxid-namespace_e_e_1_1_network_1af989bd669090f66e14b18650252b775b>`(std::ostream& stream, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& address);

	} // namespace Network
.. _details-namespace_e_e_1_1_network:

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



Typedefs
--------

.. index:: pair: typedef; SocketHandle
.. _doxid-namespace_e_e_1_1_network_1a8a509d8095f453463cefd7709f3509f3:

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

	typedef UINT_PTR SocketHandle

Define the low-level socket handle type, specific to each platform

Global Functions
----------------

.. index:: pair: function; operator==
.. _doxid-namespace_e_e_1_1_network_1abb936db8f990c19daadb44406a754367:

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

	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool operator==(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right)

Overload of == operator to compare two IP addresses.



.. rubric:: Parameters:

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

	*
		- left

		- Left operand (a IP address)

	*
		- right

		- Right operand (a IP address)



.. rubric:: Returns:

True if both addresses are equal

.. index:: pair: function; operator!=
.. _doxid-namespace_e_e_1_1_network_1a55c3af46947fbbe24c3aa7abadc85220:

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

	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool operator!=(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right)

Overload of != operator to compare two IP addresses.



.. rubric:: Parameters:

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

	*
		- left

		- Left operand (a IP address)

	*
		- right

		- Right operand (a IP address)



.. rubric:: Returns:

True if both addresses are different

.. index:: pair: function; operator<
.. _doxid-namespace_e_e_1_1_network_1a3ce6ee8e9db6052b05851045d686b72c:

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

	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool operator<(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right)

Overload of < operator to compare two IP addresses.



.. rubric:: Parameters:

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

	*
		- left

		- Left operand (a IP address)

	*
		- right

		- Right operand (a IP address)



.. rubric:: Returns:

True if *left* is lesser than *right*

.. index:: pair: function; operator>
.. _doxid-namespace_e_e_1_1_network_1acfb339b7eabe86684cc3fb1f137bcec2:

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

	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool operator>(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right)

Overload of > operator to compare two IP addresses.



.. rubric:: Parameters:

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

	*
		- left

		- Left operand (a IP address)

	*
		- right

		- Right operand (a IP address)



.. rubric:: Returns:

True if *left* is greater than *right*

.. index:: pair: function; operator<=
.. _doxid-namespace_e_e_1_1_network_1a20ef9efdb7faee41ddead1f9cb754eac:

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

	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool operator<=(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right)

Overload of <= operator to compare two IP addresses.



.. rubric:: Parameters:

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

	*
		- left

		- Left operand (a IP address)

	*
		- right

		- Right operand (a IP address)



.. rubric:: Returns:

True if *left* is lesser or equal than *right*

.. index:: pair: function; operator>=
.. _doxid-namespace_e_e_1_1_network_1a7f9413a0f64b6b2404c7de6eea9de5f8:

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

	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` bool operator>=(const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& left, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& right)

Overload of >= operator to compare two IP addresses.



.. rubric:: Parameters:

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

	*
		- left

		- Left operand (a IP address)

	*
		- right

		- Right operand (a IP address)



.. rubric:: Returns:

True if *left* is greater or equal than *right*

.. index:: pair: function; operator>>
.. _doxid-namespace_e_e_1_1_network_1a0196b0ea780c2870305e491300ae5943:

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

	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` std::istream& operator>>(std::istream& stream, :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& address)

Overload of >> operator to extract an IP address from an input stream.



.. rubric:: Parameters:

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

	*
		- stream

		- Input stream

	*
		- address

		- IP address to extract



.. rubric:: Returns:

Reference to the input stream

.. index:: pair: function; operator<<
.. _doxid-namespace_e_e_1_1_network_1af989bd669090f66e14b18650252b775b:

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

	:ref:`EE_API<doxid-config_8hpp_1a705e4ce005f895b4953ab2b8f440e171>` std::ostream& operator<<(std::ostream& stream, const :ref:`IpAddress<doxid-class_e_e_1_1_network_1_1_ip_address>`& address)

Overload of << operator to print an IP address to an output stream.



.. rubric:: Parameters:

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

	*
		- stream

		- Output stream

	*
		- address

		- IP address to print



.. rubric:: Returns:

Reference to the output stream