.. index:: pair: class; EE::Network::Http::Pool
.. _doxid-class_e_e_1_1_network_1_1_http_1_1_pool:

class EE::Network::Http::Pool
=============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

HTTP Client :ref:`Pool <doxid-class_e_e_1_1_network_1_1_http_1_1_pool>`. :ref:`More...<details-class_e_e_1_1_network_1_1_http_1_1_pool>`


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

	#include <http.hpp>
	
	class Pool {
	public:
		// construction
	
		:target:`~Pool<doxid-class_e_e_1_1_network_1_1_http_1_1_pool_1a45cfe832e2e7a62809ea9088fe5bdffd>`();

		// methods
	
		static Pool& :ref:`getGlobal<doxid-class_e_e_1_1_network_1_1_http_1_1_pool_1aa890273c47f6c3345dca4f8f0d6e6e0f>`();
		void :ref:`clear<doxid-class_e_e_1_1_network_1_1_http_1_1_pool_1ae152822a48ae6f1eb079306e4db254e5>`();
		bool :ref:`exists<doxid-class_e_e_1_1_network_1_1_http_1_1_pool_1a91ba1c2c69190623cd1107c90d96def1>`(const :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`& host, const :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`& proxy = :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`());
		:ref:`Http<doxid-class_e_e_1_1_network_1_1_http>`* :ref:`get<doxid-class_e_e_1_1_network_1_1_http_1_1_pool_1a363c6ecd3ec1224285a1836233cfbcd1>`(const :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`& host, const :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`& proxy = :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`());
	};
.. _details-class_e_e_1_1_network_1_1_http_1_1_pool:

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

HTTP Client :ref:`Pool <doxid-class_e_e_1_1_network_1_1_http_1_1_pool>`. Will keep the instances of the HTTP clients until the :ref:`Pool <doxid-class_e_e_1_1_network_1_1_http_1_1_pool>` is destroyed. Acts as a host client cache.

Methods
-------

.. index:: pair: function; getGlobal
.. _doxid-class_e_e_1_1_network_1_1_http_1_1_pool_1aa890273c47f6c3345dca4f8f0d6e6e0f:

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

	static Pool& getGlobal()



.. rubric:: Returns:

The reference to the global HTTP :ref:`Pool <doxid-class_e_e_1_1_network_1_1_http_1_1_pool>` A global HTTP :ref:`Pool <doxid-class_e_e_1_1_network_1_1_http_1_1_pool>` is created at the program start

.. index:: pair: function; clear
.. _doxid-class_e_e_1_1_network_1_1_http_1_1_pool_1ae152822a48ae6f1eb079306e4db254e5:

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

	void clear()

Clear all the HTTP Clients

.. index:: pair: function; exists
.. _doxid-class_e_e_1_1_network_1_1_http_1_1_pool_1a91ba1c2c69190623cd1107c90d96def1:

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

	bool exists(const :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`& host, const :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`& proxy = :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`())



.. rubric:: Parameters:

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

	*
		- host

		- The scheme + hostname + port represented as an :ref:`URI <doxid-class_e_e_1_1_network_1_1_u_r_i>`.

	*
		- proxy

		- The client proxy if any, scheme + hostname + post as :ref:`URI <doxid-class_e_e_1_1_network_1_1_u_r_i>`.



.. rubric:: Returns:

True if the client already exists in the pool

.. index:: pair: function; get
.. _doxid-class_e_e_1_1_network_1_1_http_1_1_pool_1a363c6ecd3ec1224285a1836233cfbcd1:

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

	:ref:`Http<doxid-class_e_e_1_1_network_1_1_http>`* get(const :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`& host, const :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`& proxy = :ref:`URI<doxid-class_e_e_1_1_network_1_1_u_r_i>`())



.. rubric:: Parameters:

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

	*
		- host

		- The scheme + hostname + port represented as an :ref:`URI <doxid-class_e_e_1_1_network_1_1_u_r_i>`.

	*
		- proxy

		- The client proxy if any, scheme + hostname + post as :ref:`URI <doxid-class_e_e_1_1_network_1_1_u_r_i>`.



.. rubric:: Returns:

An HTTP Client to the host and proxy ( creates one if no one is found )