ProtectionProfile::Observer Class Reference

Interface that receives notifications related to ProtectionProfile. More...

#include <src/api/mip/protection/protection_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 resulted in an error.
virtual void	OnAddEngineSuccess (const std::shared_ptr< ProtectionEngine > &engine, const std::shared_ptr< void > &context)
	Called when a new engine was added successfully.
virtual void	OnDeleteEngineFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when deleting an engine resulted in 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 resulted in 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< ProtectionProfile > &profile, const std::shared_ptr< void > &context)
	Called when profile was loaded successfully.

Detailed Description

Interface that receives notifications related to ProtectionProfile.

Note

This interface must be implemented by applications using the protection SDK

Definition at line 66 of file protection_profile.h.

Member Function Documentation

OnAddEngineFailure()

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

inlinevirtual

Called when adding a new engine resulted in an error.

Parameters

error	the error that caused the add engine operation to fail.
context	The same context that was passed to ProtectionProfile::AddEngineAsync

Definition at line 136 of file protection_profile.h.

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

OnAddEngineSuccess()

virtual void ProtectionProfile::Observer::OnAddEngineSuccess ( const std::shared_ptr< ProtectionEngine > & engine, const std::shared_ptr< void > & context )

inlinevirtual

Called when a new engine was added successfully.

Parameters

engine	Newly created engine
context	The same context that was passed to ProtectionProfile::AddEngineAsync

Definition at line 126 of file protection_profile.h.

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

OnDeleteEngineFailure()

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

inlinevirtual

Called when deleting an engine resulted in an error.

Parameters

error	the error that caused the delete engine operation to fail.
context	The same context that was passed to ProtectionProfile::DeleteEngineAsync

Definition at line 154 of file protection_profile.h.

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

OnDeleteEngineSuccess()

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

inlinevirtual

Called when an engine was deleted successfully.

Parameters

context

The same context that was passed to ProtectionProfile::DeleteEngineAsync

Definition at line 145 of file protection_profile.h.

                                            { UNUSED(context); }

OnListEnginesFailure()

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

inlinevirtual

Called when listing engines resulted in an error.

Parameters

error	the error that caused the list engines operation to fail.
context	The same context that was passed to ProtectionProfile::ListEnginesAsync

Definition at line 116 of file protection_profile.h.

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

OnListEnginesSuccess()

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

inlinevirtual

Called when list of engines was generated successfully.

Parameters

engineIds	a list of engine IDs the are available.
context	The same context that was passed to ProtectionProfile::ListEnginesAsync

Definition at line 106 of file protection_profile.h.

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

OnLoadFailure()

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

inlinevirtual

Called when loading a profile caused an error.

Parameters

error	Error that occurred while loading
context	The same context that was passed to ProtectionProfile::LoadAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionProfile::LoadAsync and that same context will be forwarded as-is to ProtectionProfile::Observer::OnLoadSuccess or ProtectionProfile::Observer::OnLoadFailure

Definition at line 96 of file protection_profile.h.

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

OnLoadSuccess()

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

inlinevirtual

Called when profile was loaded successfully.

Parameters

profile	A reference to the newly created ProtectionProfile
context	The same context that was passed to ProtectionProfile::LoadAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionProfile::LoadAsync and that same context will be forwarded as-is to ProtectionProfile::Observer::OnLoadSuccess or ProtectionProfile::Observer::OnLoadFailure

Definition at line 82 of file protection_profile.h.

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

---

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

• src/api/mip/protection/protection_profile.h