.. index:: pair: struct; EE::UI::WebResourceRequest
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request:

struct EE::UI::WebResourceRequest
=================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Complete input required to identify and fetch one web resource variant. :ref:`More...<details-struct_e_e_1_1_u_i_1_1_web_resource_request>`


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

	#include <webresourcecache.hpp>
	
	struct WebResourceRequest {
		// typedefs
	
		typedef std::function<void(std::function<void()>)> :ref:`CompletionDispatcher<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1ae47d838841e93f7a4f326ea2affcd43d>`;

		// fields
	
		:ref:`Network::URI<doxid-class_e_e_1_1_network_1_1_u_r_i>` :ref:`uri<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a39afcd7467e9bbafa75a012ade053ec3>`;
		:ref:`WebResourceKind<doxid-namespace_e_e_1_1_u_i_1ae8b5588e201679d96c58379e6168f59e>` :ref:`kind<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1ae2f98ef76a54c4fa179e5e2be9dca02b>` { :ref:`WebResourceKind::Document<doxid-namespace_e_e_1_1_u_i_1ae8b5588e201679d96c58379e6168f59ea0945359809dad1fbf3dea1c95a0da951>` };
		:ref:`Network::Http::Request::Method<doxid-class_e_e_1_1_network_1_1_http_1_1_request_1aec60c31c99ba94fcf071b57bca91250e>` :ref:`method<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a8c9a3fe77c62ab961cddd470ea7bbf91>` { Network::Http::Request::Method::Get };
		:ref:`Network::Http::Request::FieldTable<doxid-class_e_e_1_1_network_1_1_http_1_1_request_1acf7009e91e4ae9d13aaff8eaa1560814>` :ref:`headers<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a61793bcb3c559effbffda05c4245bef3>`;
		std::string :ref:`body<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1abd9304a6af81ca11d8617abe39017f66>`;
		:ref:`System::Time<doxid-class_e_e_1_1_system_1_1_time>` :ref:`timeout<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a85ba97c5a807db4a0ee7d3b388ff81b6>` { :ref:`System::Seconds<doxid-namespace_e_e_1_1_system_1a988f24c1246bc0cca3950c428780d01a>`(5) };
		bool :ref:`validateCertificate<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a0a1a958d17b9bc30b0ae2cd06bb2cd2e>` { true };
		:ref:`Network::URI<doxid-class_e_e_1_1_network_1_1_u_r_i>` :ref:`proxy<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1ab087db100beb6cf8ed6eb833a7471107>`;
		bool :ref:`followRedirect<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a99e3cb6444fc70028bf694ebb59f2ad6>` { true };
		bool :ref:`clampToEdge<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a9989ea19c5d5a4146e5492b0e47d888a>` { true };
		bool :ref:`mipmaps<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a9c79400331789a45cf85b715ec1011d0>` { false };
		bool :ref:`compressTexture<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a8e9c76547b48df5cc0f989c4804de2af>` { false };
		:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :ref:`svgScale<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a4b761a974094d589bc5d6b86b1c256cb>` { 1.f };
		:ref:`CompletionDispatcher<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1ae47d838841e93f7a4f326ea2affcd43d>` :ref:`completionDispatcher<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1aaeef020bc271b3de53319dc5fa7459c0>`;
	};
.. _details-struct_e_e_1_1_u_i_1_1_web_resource_request:

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

Complete input required to identify and fetch one web resource variant.

Cache identity includes the partition, canonical URI, resource kind, method, non-navigation headers, body, and image decode options. Cookie and Referer are deliberately excluded from entry identity: the partition isolates cookie contexts, while these two values naturally change during navigation. They are still sent with the HTTP request.

Transport policy such as timeout, proxy, and completionDispatcher controls a fetch but does not describe the resulting resource and is therefore not part of cache identity.

Typedefs
--------

.. index:: pair: typedef; CompletionDispatcher
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1ae47d838841e93f7a4f326ea2affcd43d:

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

	typedef std::function<void(std::function<void()>)> CompletionDispatcher

Dispatches a completion function to the thread on which it is safe to finalize a resource.

Fields
------

.. index:: pair: variable; uri
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a39afcd7467e9bbafa75a012ade053ec3:

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

	:ref:`Network::URI<doxid-class_e_e_1_1_network_1_1_u_r_i>` uri

Absolute URI to fetch. Fragments are removed and the URI is normalized for cache lookup.

.. index:: pair: variable; kind
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1ae2f98ef76a54c4fa179e5e2be9dca02b:

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

	:ref:`WebResourceKind<doxid-namespace_e_e_1_1_u_i_1ae8b5588e201679d96c58379e6168f59e>` kind { :ref:`WebResourceKind::Document<doxid-namespace_e_e_1_1_u_i_1ae8b5588e201679d96c58379e6168f59ea0945359809dad1fbf3dea1c95a0da951>` }

Semantic resource type.

.. index:: pair: variable; method
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a8c9a3fe77c62ab961cddd470ea7bbf91:

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

	:ref:`Network::Http::Request::Method<doxid-class_e_e_1_1_network_1_1_http_1_1_request_1aec60c31c99ba94fcf071b57bca91250e>` method { Network::Http::Request::Method::Get }

HTTP method. The method is part of cache identity.

.. index:: pair: variable; headers
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a61793bcb3c559effbffda05c4245bef3:

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

	:ref:`Network::Http::Request::FieldTable<doxid-class_e_e_1_1_network_1_1_http_1_1_request_1acf7009e91e4ae9d13aaff8eaa1560814>` headers

HTTP request headers. See the type documentation for cache-key rules.

.. index:: pair: variable; body
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1abd9304a6af81ca11d8617abe39017f66:

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

	std::string body

HTTP request body. The complete body is part of cache identity.

.. index:: pair: variable; timeout
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a85ba97c5a807db4a0ee7d3b388ff81b6:

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

	:ref:`System::Time<doxid-class_e_e_1_1_system_1_1_time>` timeout { :ref:`System::Seconds<doxid-namespace_e_e_1_1_system_1a988f24c1246bc0cca3950c428780d01a>`(5) }

Maximum duration allowed for the HTTP request.

.. index:: pair: variable; validateCertificate
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a0a1a958d17b9bc30b0ae2cd06bb2cd2e:

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

	bool validateCertificate { true }

Whether HTTPS certificates must be validated.

.. index:: pair: variable; proxy
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1ab087db100beb6cf8ed6eb833a7471107:

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

	:ref:`Network::URI<doxid-class_e_e_1_1_network_1_1_u_r_i>` proxy

Optional HTTP proxy URI. An empty URI uses a direct connection.

.. index:: pair: variable; followRedirect
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a99e3cb6444fc70028bf694ebb59f2ad6:

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

	bool followRedirect { true }

Whether HTTP redirects should be followed.

.. index:: pair: variable; clampToEdge
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a9989ea19c5d5a4146e5492b0e47d888a:

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

	bool clampToEdge { true }

Image-only texture wrapping policy. True selects ClampToEdge.

.. index:: pair: variable; mipmaps
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a9c79400331789a45cf85b715ec1011d0:

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

	bool mipmaps { false }

Image-only option controlling mipmap generation.

.. index:: pair: variable; compressTexture
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a8e9c76547b48df5cc0f989c4804de2af:

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

	bool compressTexture { false }

Image-only option requesting texture compression.

.. index:: pair: variable; svgScale
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1a4b761a974094d589bc5d6b86b1c256cb:

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

	:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` svgScale { 1.f }

Image-only SVG rasterization scale.

.. index:: pair: variable; completionDispatcher
.. _doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1aaeef020bc271b3de53319dc5fa7459c0:

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

	:ref:`CompletionDispatcher<doxid-struct_e_e_1_1_u_i_1_1_web_resource_request_1ae47d838841e93f7a4f326ea2affcd43d>` completionDispatcher

Image-only completion dispatcher.

Image decode/upload completion must execute where a graphics context is current. This policy is not part of cache identity and only the request that starts a coalesced load supplies it.