Configures the TokenEndpoint instance. More...

Collaboration diagram for olp::authentication::AuthenticationSettings:

Public Attributes
boost::optional< http::NetworkProxySettings >	network_proxy_settings {}
	The configuration settings for the network layer. More...

std::shared_ptr< http::Network >	network_request_handler {nullptr}
	The network instance that is used to internally operate with the HERE platform Services.

std::shared_ptr< thread::TaskScheduler >	task_scheduler {nullptr}
	The `TaskScheduler` class that is used to manage the callbacks enqueue. More...

std::string	token_endpoint_url {kHereAccountProductionUrl}
	The server URL of the token endpoint.

size_t	token_cache_limit {100u}
	The maximum number of tokens that can be stored in LRU memory cache.

bool	use_system_time {true}
	Uses system system time in authentication requests rather than requesting time from authentication server. More...

client::RetrySettings	retry_settings
	A collection of settings that controls how failed requests should be treated.

Detailed Description

Configures the TokenEndpoint instance.

Contains settings that customize the TokenEndpoint class.

Member Data Documentation

boost::optional<http::NetworkProxySettings> olp::authentication::AuthenticationSettings::network_proxy_settings {}

The configuration settings for the network layer.

To remove any existing proxy settings, set to boost::none.

std::shared_ptr<thread::TaskScheduler> olp::authentication::AuthenticationSettings::task_scheduler {nullptr}

The TaskScheduler class that is used to manage the callbacks enqueue.

If nullptr, all request calls are performed synchronously.

bool olp::authentication::AuthenticationSettings::use_system_time {true}

Uses system system time in authentication requests rather than requesting time from authentication server.

Default is true, which means that system time is used.

Note: Please make sure that the system time does not deviate from the official UTC time as it might result in error responses from the authentication server.

The documentation for this struct was generated from the following file: