QueryCtrl

QueryCtrl allows a query to be cancelled. More...

#include <unity/scopes/QueryCtrl.h>

Inheritance diagram for unity::scopes::QueryCtrl:
Inheritance graph
[legend]

Public Member Functions

virtual void cancel ()=0
 Cancels an executing query. More...
 
virtual ~QueryCtrl ()
 Destroys a QueryCtrl. More...
 
- Public Member Functions inherited from unity::scopes::Object
virtual std::string endpoint ()=0
 Returns the endpoint this proxy connects to. More...
 
virtual std::string identity ()=0
 Returns the identity of the target object of this proxy. More...
 
virtual std::string target_category ()=0
 Returns the category of the target object of this proxy. More...
 
virtual int64_t timeout ()=0
 Returns the timeout in milliseconds if this proxy is a twoway proxy. More...
 
virtual std::string to_string ()=0
 Converts a proxy into its string representation. More...
 

Detailed Description

QueryCtrl allows a query to be cancelled.

Constructor & Destructor Documentation

virtual unity::scopes::QueryCtrl::~QueryCtrl ( )
virtual

Destroys a QueryCtrl.

Letting a QueryCtrl go out of scope has no effect on the query, that is, the destructor does not implicitly call cancel().

Member Function Documentation

virtual void unity::scopes::QueryCtrl::cancel ( )
pure virtual

Cancels an executing query.

Calling cancel() informs the scope to which a query was sent that the query should be cancelled. Calling cancel() on a query that is complete has no effect. cancel() is guaranteed to not block the caller.