PicoScenes API Docs
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
AsyncPipeline< ObjectType > Class Template Reference

#include <AsyncPipeline.hxx>

Public Member Functions

AsyncPipeline & startService ()
 
void stopService ()
 
template<typename T >
uint64_t send (T &&object)
 
template<typename T >
uint64_t sendSync (T &&object)
 
int pause ()
 
int resume ()
 
AsyncPipeline< ObjectType > & registerAsyncHandler (std::string handlerName, std::function< void(const ObjectType &object)> handler)
 
std::optional< ObjectType > selectDataByCondition (const std::function< bool(const ObjectType &)> &condition, const std::chrono::milliseconds &maxWait_ms, std::optional< std::string > conditionName)
 
AsyncPipeline< ObjectType > & unregisterHandler (const std::string &handlerName)
 
bool hasHandler (const std::string &handlerName)
 
bool isPipelineRunning () const
 
bool isPipelinePaused () const
 

Detailed Description

template<typename ObjectType>
class AsyncPipeline< ObjectType >

Definition at line 14 of file AsyncPipeline.hxx.

Member Function Documentation

◆ hasHandler()

template<typename ObjectType >
bool AsyncPipeline< ObjectType >::hasHandler ( const std::string &  handlerName)
inline

Definition at line 123 of file AsyncPipeline.hxx.

◆ isPipelinePaused()

template<typename ObjectType >
bool AsyncPipeline< ObjectType >::isPipelinePaused ( ) const
inline

Definition at line 131 of file AsyncPipeline.hxx.

◆ isPipelineRunning()

template<typename ObjectType >
bool AsyncPipeline< ObjectType >::isPipelineRunning ( ) const
inline

Definition at line 127 of file AsyncPipeline.hxx.

◆ pause()

template<typename ObjectType >
int AsyncPipeline< ObjectType >::pause ( )
inline

Definition at line 70 of file AsyncPipeline.hxx.

◆ registerAsyncHandler()

template<typename ObjectType >
AsyncPipeline< ObjectType > & AsyncPipeline< ObjectType >::registerAsyncHandler ( std::string  handlerName,
std::function< void(const ObjectType &object)>  handler 
)
inline

Definition at line 82 of file AsyncPipeline.hxx.

Referenced by AsyncPipeline< ObjectType >::selectDataByCondition().

◆ resume()

template<typename ObjectType >
int AsyncPipeline< ObjectType >::resume ( )
inline

Definition at line 76 of file AsyncPipeline.hxx.

◆ selectDataByCondition()

template<typename ObjectType >
std::optional< ObjectType > AsyncPipeline< ObjectType >::selectDataByCondition ( const std::function< bool(const ObjectType &)> &  condition,
const std::chrono::milliseconds &  maxWait_ms,
std::optional< std::string >  conditionName 
)
inline

Definition at line 89 of file AsyncPipeline.hxx.

References AsyncPipeline< ObjectType >::registerAsyncHandler(), and AsyncPipeline< ObjectType >::unregisterHandler().

◆ send()

template<typename ObjectType >
template<typename T >
uint64_t AsyncPipeline< ObjectType >::send ( T &&  object)
inline

Definition at line 45 of file AsyncPipeline.hxx.

Referenced by AsyncPipeline< ObjectType >::sendSync().

◆ sendSync()

template<typename ObjectType >
template<typename T >
uint64_t AsyncPipeline< ObjectType >::sendSync ( T &&  object)
inline

Definition at line 56 of file AsyncPipeline.hxx.

References AsyncPipeline< ObjectType >::send().

◆ startService()

template<typename ObjectType >
AsyncPipeline & AsyncPipeline< ObjectType >::startService ( )
inline

Definition at line 17 of file AsyncPipeline.hxx.

References Singleton< T >::getInstance().

◆ stopService()

template<typename ObjectType >
void AsyncPipeline< ObjectType >::stopService ( )
inline

Definition at line 27 of file AsyncPipeline.hxx.

◆ unregisterHandler()

template<typename ObjectType >
AsyncPipeline< ObjectType > & AsyncPipeline< ObjectType >::unregisterHandler ( const std::string &  handlerName)
inline

Definition at line 114 of file AsyncPipeline.hxx.

Referenced by AsyncPipeline< ObjectType >::selectDataByCondition().

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