FileProfile::Observer Class Reference

Observer interface for clients to get notifications for profile related events. More...

#include <src/api/mip/file/file_profile.h>

Public Member Functions
virtual void	OnAddEngineFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when adding a new engine caused an error.
virtual void	OnAddEngineSuccess (const std::shared_ptr< mip::FileEngine > &engine, const std::shared_ptr< void > &context)
	Called when a new engine was added successfully.
virtual void	OnAddPolicyEngineStarting (bool requiresPolicyFetch)
	Called prior to engine creation to describe whether or not the policy engine's policy data must be fetched from the server or whether it can be created from locally cached data.
virtual void	OnDeleteEngineFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when deleting an engine caused an error.
virtual void	OnDeleteEngineSuccess (const std::shared_ptr< void > &context)
	Called when an engine was deleted successfully.
virtual void	OnListEnginesFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when listing engines caused an error.
virtual void	OnListEnginesSuccess (const std::vector< std::string > &engineIds, const std::shared_ptr< void > &context)
	Called when list of engines was generated successfully.
virtual void	OnLoadFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when loading a profile caused an error.
virtual void	OnLoadSuccess (const std::shared_ptr< mip::FileProfile > &profile, const std::shared_ptr< void > &context)
	Called when profile was loaded successfully.
virtual void	OnPolicyChanged (const std::string &engineId)
	Called when the policy has changed for the engine with the given ID.
virtual void	OnUnloadEngineFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when unloading an engine caused an error.
virtual void	OnUnloadEngineSuccess (const std::shared_ptr< void > &context)
	Called when an engine was unloaded successfully.
virtual	~Observer ()

Protected Member Functions
	Observer ()

Detailed Description

Observer interface for clients to get notifications for profile related events.

Note

All errors inherit from mip::Error.

Client should not call the engine back on the thread that calls the observer.

Definition at line 62 of file file_profile.h.

Constructor & Destructor Documentation

~Observer()

virtual FileProfile::Observer::~Observer ( )

inlinevirtual

Definition at line 64 of file file_profile.h.

{}

Observer()

FileProfile::Observer::Observer ( )

inlineprotected

Definition at line 147 of file file_profile.h.

{}

Member Function Documentation

OnAddEngineFailure()

virtual void FileProfile::Observer::OnAddEngineFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when adding a new engine caused an error.

Definition at line 115 of file file_profile.h.

                                                                                                       { 
        UNUSED(error); UNUSED(context); }

OnAddEngineSuccess()

virtual void FileProfile::Observer::OnAddEngineSuccess ( const std::shared_ptr< mip::FileEngine > & engine, const std::shared_ptr< void > & context )

inlinevirtual

Called when a new engine was added successfully.

Definition at line 108 of file file_profile.h.

                                            { UNUSED(engine); UNUSED(context); }

OnAddPolicyEngineStarting()

virtual void FileProfile::Observer::OnAddPolicyEngineStarting ( bool requiresPolicyFetch )

inlinevirtual

Called prior to engine creation to describe whether or not the policy engine's policy data must be fetched from the server or whether it can be created from locally cached data.

Parameters

requiresPolicyFetch

Describes whether engine data must be fetched via HTTP or if it will be loaded from cache

Note

This optional callback may be used by an application to be informed whether or not an AddEngineAsync operation will require an HTTP operation (with its associated delay) to complete.

Definition at line 144 of file file_profile.h.

{ UNUSED(requiresPolicyFetch); }

OnDeleteEngineFailure()

virtual void FileProfile::Observer::OnDeleteEngineFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when deleting an engine caused an error.

Definition at line 126 of file file_profile.h.

                                            { UNUSED(error); UNUSED(context); }

OnDeleteEngineSuccess()

virtual void FileProfile::Observer::OnDeleteEngineSuccess ( const std::shared_ptr< void > & context )

inlinevirtual

Called when an engine was deleted successfully.

Definition at line 121 of file file_profile.h.

{ UNUSED(context); }

OnListEnginesFailure()

virtual void FileProfile::Observer::OnListEnginesFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when listing engines caused an error.

Definition at line 89 of file file_profile.h.

                                            { UNUSED(error); UNUSED(context); }

OnListEnginesSuccess()

virtual void FileProfile::Observer::OnListEnginesSuccess ( const std::vector< std::string > & engineIds, const std::shared_ptr< void > & context )

inlinevirtual

Called when list of engines was generated successfully.

Definition at line 82 of file file_profile.h.

                                            { UNUSED(engineIds); UNUSED(context); }

OnLoadFailure()

virtual void FileProfile::Observer::OnLoadFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when loading a profile caused an error.

Definition at line 76 of file file_profile.h.

                                                                                                  {
        UNUSED(error); UNUSED(context); }

OnLoadSuccess()

virtual void FileProfile::Observer::OnLoadSuccess ( const std::shared_ptr< mip::FileProfile > & profile, const std::shared_ptr< void > & context )

inlinevirtual

Called when profile was loaded successfully.

Definition at line 69 of file file_profile.h.

                                            { UNUSED(profile); UNUSED(context); }

OnPolicyChanged()

virtual void FileProfile::Observer::OnPolicyChanged ( const std::string & engineId )

inlinevirtual

Called when the policy has changed for the engine with the given ID.

Definition at line 133 of file file_profile.h.

{ UNUSED(engineId); }

OnUnloadEngineFailure()

virtual void FileProfile::Observer::OnUnloadEngineFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when unloading an engine caused an error.

Definition at line 101 of file file_profile.h.

                                            { UNUSED(error); UNUSED(context); }

OnUnloadEngineSuccess()

virtual void FileProfile::Observer::OnUnloadEngineSuccess ( const std::shared_ptr< void > & context )

inlinevirtual

Called when an engine was unloaded successfully.

Definition at line 96 of file file_profile.h.

{ UNUSED(context); }

---

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

• src/api/mip/file/file_profile.h