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

Abstract base class to be notified of query completion. More...

#include <unity/scopes/ListenerBase.h>

Inheritance diagram for unity::scopes::ListenerBase:

Public Types

enum  Reason { Finished, Cancelled, Error }
 Indicates the cause of a call to finished(). More...
 

Public Member Functions

virtual void finished (Reason r, std::string const &error_message)=0
 Called once by the scopes run time after the final result for a query() was sent. More...
 

Detailed Description

Abstract base class to be notified of query completion.

Once a query is complete, the run time calls the finished() method once, to inform the caller that the query is complete.

Member Enumeration Documentation

Indicates the cause of a call to finished().

The Error enumerator indicates that a query terminated abnormally, for example, because a scope could not be reached over the network or explicitly reported an error.

Member Function Documentation

virtual void unity::scopes::ListenerBase::finished ( Reason  r,
std::string const &  error_message 
)
pure virtual

Called once by the scopes run time after the final result for a query() was sent.

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 Error, error_message contains further details. Otherwise, error_message is the empty string.

Implemented in unity::scopes::ActivationListenerBase.


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