unity::scopes::QueryBase Class Reference

Abstract server-side base interface for a query that is executed inside a scope. More...

#include <unity/scopes/QueryBase.h>

Inheritance diagram for unity::scopes::QueryBase:

Public Member Functions
virtual void	cancelled ()=0
	Called by the scopes run time when the query originator cancels a query. More...

Detailed Description

Abstract server-side base interface for a query that is executed inside a scope.

See Also

SearchQueryBase, PreviewQueryBase, ActivationQueryBase

Member Function Documentation

virtual void unity::scopes::QueryBase::cancelled ( )

pure virtual

Called by the scopes run time when the query originator cancels a query.

Your implementation of this method should ensure that the scope stops processing the current query as soon as possible. Any calls to a push() method once a query is cancelled are ignored, so continuing to push after cancellation only wastes CPU cycles.

Implemented in unity::scopes::ActivationQueryBase.

---

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

• include/unity/scopes/QueryBase.h
• src/scopes/QueryBase.cpp