QueryCtrl allows a query to be cancelled.
More...
#include <unity/scopes/QueryCtrl.h>
|
virtual void | cancel ()=0 |
| Cancels an executing query. More...
|
|
virtual | ~QueryCtrl () |
| Destroys a QueryCtrl. More...
|
|
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 | 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...
|
|
QueryCtrl allows a query to be cancelled.
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().
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.
The documentation for this class was generated from the following file: