RTC Toolkit  0.1.0-alpha
Public Types | Public Member Functions | List of all members
rtctk::componentFramework::Subscription Class Reference

#include <runtimeRepoApiIf.hpp>

Public Types

enum  Mode { INVOKE_ON_ALL = 0, INVOKE_ON_EACH = 1 }
 
using BufferList = std::vector< std::pair< std::string, void * > >
 

Public Member Functions

void OnNewValues (const BufferList &buffers, bool multiple_updates)
 
void OnTimeout (const BufferList &buffers, bool multiple_updates)
 
void OnDpRemoved (const std::vector< std::string > &path)
 
void AddPath (const std::string &path)
 
void SetMaxWaitTime (std::chrono::seconds timeout)
 
void SetMode (Mode mode)
 
void AddAllocator (const std::string &path, std::function< void *(size_t)> allocator)
 

Detailed Description

Todo:
This class is not implemented yet and needs to be completed for the next release.

Member Typedef Documentation

◆ BufferList

using rtctk::componentFramework::Subscription::BufferList = std::vector<std::pair<std::string, void*> >

Member Enumeration Documentation

◆ Mode

Enumerator
INVOKE_ON_ALL 
INVOKE_ON_EACH 

Member Function Documentation

◆ AddAllocator()

void rtctk::componentFramework::Subscription::AddAllocator ( const std::string &  path,
std::function< void *(size_t)>  allocator 
)
inline

◆ AddPath()

void rtctk::componentFramework::Subscription::AddPath ( const std::string &  path)
inline

◆ OnDpRemoved()

void rtctk::componentFramework::Subscription::OnDpRemoved ( const std::vector< std::string > &  path)
inline

◆ OnNewValues()

void rtctk::componentFramework::Subscription::OnNewValues ( const BufferList buffers,
bool  multiple_updates 
)
inline

◆ OnTimeout()

void rtctk::componentFramework::Subscription::OnTimeout ( const BufferList buffers,
bool  multiple_updates 
)
inline

◆ SetMaxWaitTime()

void rtctk::componentFramework::Subscription::SetMaxWaitTime ( std::chrono::seconds  timeout)
inline

◆ SetMode()

void rtctk::componentFramework::Subscription::SetMode ( Mode  mode)
inline

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