Unity Scopes API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
unity::scopes::ActivationListenerBase Class Reference

Base class to receive a response to a result activation request. More...

#include <unity/scopes/ActivationListenerBase.h>

Inheritance diagram for unity::scopes::ActivationListenerBase:

Public Member Functions

virtual void activated (ActivationResponse const &response)
 Called once by the scopes run time with the activation response. More...
 
virtual void finished (Reason r, std::string const &error_message) override
 Called once by the scopes run time after receiving an activation response. More...
 

Additional Inherited Members

- Public Types inherited from unity::scopes::ListenerBase
enum  Reason { Finished, Cancelled, Error }
 Indicates the cause of a call to finished(). More...
 

Detailed Description

Base class to receive a response to a result activation request.

Member Function Documentation

void unity::scopes::ActivationListenerBase::activated ( ActivationResponse const &  response)
virtual

Called once by the scopes run time with the activation response.

The default implementation does nothing.

Parameters
responseThe response to the activation request, returned by a scope from ActivationQueryBase::activate().
void unity::scopes::ActivationListenerBase::finished ( Reason  r,
std::string const &  error_message 
)
overridevirtual

Called once by the scopes run time after receiving an activation response.

Default implementation does nothing.

Calls to finished() are made by an arbitrary thread.

Exceptions thrown from finished() are ignored.

Parameters
rIndicates the cause for the call to finished().
error_messageIf r is set to Reason::Error, error_message contains further details. Otherwise, error_message is the empty string.

Implements unity::scopes::ListenerBase.


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