Configures the behavior of the OlpClient class.
More...
#include <OlpClientSettings.h>
Public Attributes | |
| RetrySettings | retry_settings |
| The retry settings. | |
| ApiLookupSettings | api_lookup_settings |
| API Lookup settings. | |
| boost::optional< http::NetworkProxySettings > | proxy_settings = boost::none |
| The network proxy settings. More... | |
| boost::optional< AuthenticationSettings > | authentication_settings = boost::none |
| The authentication settings. More... | |
| std::shared_ptr< thread::TaskScheduler > | task_scheduler = nullptr |
The TaskScheduler instance. More... | |
| std::shared_ptr< http::Network > | network_request_handler = nullptr |
The Network instance. More... | |
| std::shared_ptr< cache::KeyValueCache > | cache = nullptr |
| The key-value cache that is used for storing different request results such as metadata, partition data, URLs from the API Lookup Service, and others. More... | |
| std::chrono::seconds | default_cache_expiration = std::chrono::seconds::max() |
| Set default expiration for any cache entry made by the according layer or catalog client. More... | |
| bool | propagate_all_cache_errors = false |
| The flag to enable or disable the propagation of all cache errors. More... | |
Detailed Description
Configures the behavior of the OlpClient class.
Member Data Documentation
◆ authentication_settings
| boost::optional<AuthenticationSettings> olp::client::OlpClientSettings::authentication_settings = boost::none |
The authentication settings.
To remove any existing authentication settings, set to boost::none.
◆ cache
| std::shared_ptr<cache::KeyValueCache> olp::client::OlpClientSettings::cache = nullptr |
The key-value cache that is used for storing different request results such as metadata, partition data, URLs from the API Lookup Service, and others.
To only use the memory LRU cache with limited size, set to nullptr.
◆ default_cache_expiration
| std::chrono::seconds olp::client::OlpClientSettings::default_cache_expiration = std::chrono::seconds::max() |
Set default expiration for any cache entry made by the according layer or catalog client.
This setting only applies to the mutable cache and to the in-memory cache, but should not affect the protected cache as no entries are added to the protected cache in read-only mode. Set to std::chrono::seconds::max() to disable expiration. By default, expiration is disabled.
- Note
- This only makes sense for data that has an expiration limit, e.g. volatile or versioned, and which is stored in cache.
◆ network_request_handler
| std::shared_ptr<http::Network> olp::client::OlpClientSettings::network_request_handler = nullptr |
The Network instance.
Used to internally operate with the HERE platform Services.
◆ propagate_all_cache_errors
| bool olp::client::OlpClientSettings::propagate_all_cache_errors = false |
The flag to enable or disable the propagation of all cache errors.
When set to false only critical cache errors are propagated to the user. By default, this setting is set to false.
◆ proxy_settings
| boost::optional<http::NetworkProxySettings> olp::client::OlpClientSettings::proxy_settings = boost::none |
The network proxy settings.
To remove any existing proxy settings, set to boost::none.
◆ task_scheduler
| std::shared_ptr<thread::TaskScheduler> olp::client::OlpClientSettings::task_scheduler = nullptr |
The TaskScheduler instance.
If nullptr is set, all request calls are performed synchronously.
The documentation for this struct was generated from the following file:
- olp-cpp-sdk-core/include/olp/core/client/OlpClientSettings.h
