class PolicyProfile::Settings

Settings used by PolicyProfile during its creation and throughout its lifetime.

Summary

Members	Descriptions
public Settings(const std::shared_ptr<MipContext>& mipContext, CacheStorageType cacheStorageType, const std::shared_ptr<PolicyProfile::Observer>& observer)	Interface for configuring the profile.
public CacheStorageType GetCacheStorageType() const	Get whether caches are stored in memory or on disk.
public const std::shared_ptr<PolicyProfile::Observer>& GetObserver() const	Get the event observer.
public std::shared_ptr<MipContext> GetMipContext() const	Get MIP context which represents shared state across all profiles.
public std::shared_ptr<HttpDelegate> GetHttpDelegate() const	Get the HTTP delegate (if any) provided by the application.
public void SetHttpDelegate(const std::shared_ptr<HttpDelegate>& httpDelegate)	Override default HTTP stack with client's own.
public std::shared_ptr<StorageDelegate> GetStorageDelegate() const	Get the StorageDelegate (if any) provided by the application.
public void SetStorageDelegate(const std::shared_ptr<StorageDelegate>& storageDelegate)	Override default storage cache with client's own implementation.
public std::shared_ptr<TaskDispatcherDelegate> GetTaskDispatcherDelegate() const	Get the TaskDispatcher delegate (if any) provided by the application.
public void SetTaskDispatcherDelegate(const std::shared_ptr<TaskDispatcherDelegate>& taskDispatcherDelegate)	Override default asynchronous task dispatching handling with client's own.
public void SetSessionId(const std::string& sessionId)	Not yet documented.
public const std::string& GetSessionId() const	Not yet documented.
public void SetCustomSettings(const std::vector<std::pair<std::string, std::string>>& customSettings)	Set the custom settings, used for feature gating and testing.
public const std::vector<std::pair<std::string, std::string>>& GetCustomSettings() const	Get the custom settings, used for feature gating and testing.
public const std::shared_ptr<void>& GetLoggerContext() const	Get logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.
public void SetLoggerContext(const std::shared_ptr<void>& loggerContext)	Sets the logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.
public ~Settings()	Not yet documented.

Members

Settings function

Interface for configuring the profile.

Parameters:

• mipContext: Global context settings

• cacheStorageType: Store any cached state in memory or on disk

• observer: A class implementing the PolicyProfile::Observer interface. Can be nullptr.

GetCacheStorageType function

Get whether caches are stored in memory or on disk.

Returns: Storage type used

GetObserver function

Get the event observer.

Returns: The event observer.

GetMipContext function

Get MIP context which represents shared state across all profiles.

Returns: MIP context

GetHttpDelegate function

Get the HTTP delegate (if any) provided by the application.

Returns: Http delegate to be used for HTTP operations

SetHttpDelegate function

Override default HTTP stack with client's own.

Parameters:

• httpDelegate: Http callback interface implemented by client application

GetStorageDelegate function

Get the StorageDelegate (if any) provided by the application.

Returns: StorageDelegate to be used for cache operations

SetStorageDelegate function

Override default storage cache with client's own implementation.

Parameters:

• storageDelegate: StorageDelegate implemented by client application

GetTaskDispatcherDelegate function

Get the TaskDispatcher delegate (if any) provided by the application.

Returns: TaskDispatcher delegate to be used for executing asynchronous tasks

SetTaskDispatcherDelegate function

Override default asynchronous task dispatching handling with client's own.

Parameters:

• taskDispatcherDelegate: Task dispatching callback interface implemented by client application

tasks can reference profile objects preventing its destruction as a result taskdispatcher queues should not be shared.

SetSessionId function

Not documented yet.

GetSessionId function

Not documented yet.

SetCustomSettings function

Set the custom settings, used for feature gating and testing.

Parameters:

• customSettings: List of name/value pairs.

GetCustomSettings function

Get the custom settings, used for feature gating and testing.

Returns: List of name/value pairs.

GetLoggerContext function

Get logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.

Returns: The logger context

SetLoggerContext function

Sets the logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.

Parameters:

• loggerContext: The logger context

~Settings function

Not documented yet.