unity.scopes.ListenerBase

Abstract base class to be notified of request completion (such as a query or activation request). More...

#include <unity/scopes/ListenerBase.h>

Inheritance diagram for unity::scopes::ListenerBase: src="https://assets.ubuntu.com/v1/bd2d3276-classunity_1_1scopes_1_1_listener_base__inherit__graph.png" border="0" alt="Inheritance graph"/>

Public Member Functions

virtual void finished (CompletionDetails const &details)=0
 Called once by the scopes runtime after the final result for a request was sent. More...
 
virtual void info (OperationInfo const &op_info)
 Called by the scopes runtime each time a scope reports additional information about the reply to a query. More...
 

Detailed Description

Abstract base class to be notified of request completion (such as a query or activation request).

See also
ActivationListenerBase
PreviewQueryBase
SearchListenerBase

Member Function Documentation

virtual void unity::scopes::ListenerBase::finished ( CompletionDetails const &  details)
pure virtual

Called once by the scopes runtime after the final result for a request was sent.

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

Exceptions thrown from finished() are ignored.

Parameters
detailsContains details about the completion status of a query as well as any additional information regarding the operation of the request.

Implemented in unity::scopes::utility::BufferedResultForwarder, and unity::scopes::ActivationListenerBase.

virtual void unity::scopes::ListenerBase::info ( OperationInfo const &  op_info)
virtual

Called by the scopes runtime each time a scope reports additional information about the reply to a query.

More than one info() call can arrive during processing of a single query.

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

Exceptions thrown from info() are ignored.

Parameters
op_infoContains all details of the information being reported.