libtcspc C++ API
Streaming TCSPC and time tag data processing
Loading...
Searching...
No Matches
tcspc::acquire_access Class Reference

Description

Access for acquire processors.

Public Member Functions

void halt ()
 Halt the acquisition: stop reading further data.

Member Function Documentation

◆ halt()

void tcspc::acquire_access::halt ( )
inline

Halt the acquisition: stop reading further data.

The call to flush() will throw (if it hasn't exited yet) tcspc::acquisition_halted without flushing the downstream.

This is typically used for user-initiated cancellation of the acquisition.

Note
This function does not block; it may return before the acquisition actually stops and the processor's flush() returns (or possibly throws). You should wait for the latter before cleaning up resources needed by the acquisition (such as stopping the acquisition at the driver level).

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