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

Abstract base class to represent a particular preview. More...

#include <unity/scopes/PreviewQueryBase.h>

Inheritance diagram for unity::scopes::PreviewQueryBase:

Public Member Functions

virtual void run (PreviewReplyProxy const &reply)=0
 Called by scopes run time to start the preview. More...
 
- Public Member Functions inherited from unity::scopes::QueryBase
virtual void cancelled ()=0
 Called by the scopes run time when the query originator cancels a query. More...
 

Detailed Description

Abstract base class to represent a particular preview.

A scope must return an instance of this class from its implementation of ScopeBase::preview().

Note
The constructor of the instance must complete in a timely manner. Do not perform anything in the constructor that might block.

Member Function Documentation

virtual void unity::scopes::PreviewQueryBase::run ( PreviewReplyProxy const &  reply)
pure virtual

Called by scopes run time to start the preview.

Your implementation of run() can use the reply proxy to push results for the preview. You can push results from within run(), in which case the preview implicitly completes when run() returns. Alternatively, run() can store the reply proxy and return immediately. In this case, you can use the stored proxy to push results from another thread. It is safe to call push() from multiple threads without synchronization.

The preview completes either when run() returns, or when the last stored reply proxy goes out of scope (whichever happens last).

Parameters
replyThe proxy on which to push results for the preview.

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