DUECA/DUSIME
Loading...
Searching...
No Matches
Functions
WrapSendEvent.hxx File Reference

Compatibility header, providing wrapper functions for the older .sendEvent options of event write tokens. More...

Include dependency graph for WrapSendEvent.hxx:

Functions

void dueca::_wrapSendEvent (ChannelWriteToken &t, const void *edata, const DataTimeSpec &tic)
 Internal function for the wrapSendEvent.
 
void dueca::wrapSendEvent (ChannelWriteToken &t, const void *edata, const TimeTickType &tick)
 The "wrapSendEvent" function can be used to send an event with self-allocated event data.
 
template<class T >
void dueca::wrapSendEvent (EventChannelWriteToken< T > &t, const T *edata, const TimeTickType &tick)
 The "wrapSendEvent" function can be used to send an event with self-allocated event data.
 
void dueca::wrapSendData (ChannelWriteToken &t, const void *edata, const DataTimeSpec &tick)
 The "wrapSendData" function can be used to send an event or stream data with self-allocated data.
 

Detailed Description

Compatibility header, providing wrapper functions for the older .sendEvent options of event write tokens.

Function Documentation

◆ _wrapSendEvent()

void dueca::_wrapSendEvent ( ChannelWriteToken & t,
const void * edata,
const DataTimeSpec & tic )
inline

Internal function for the wrapSendEvent.

wrapper for the "old" sendEvent member call

Parameters
tChannel write token
edataPointer to the data; deallocation will be done by the channel
ticTime for the event

◆ wrapSendEvent() [1/2]

void dueca::wrapSendEvent ( ChannelWriteToken & t,
const void * edata,
const TimeTickType & tick )
inline

The "wrapSendEvent" function can be used to send an event with self-allocated event data.

Parameters
tValid channel write token, configured for events.
edataPointer to the object to be written. Must be a valid DCO object, dynamically allocated, and the channel will assume ownership!
tickTime tick for the writing.

Note that the use of this function should be reserved to people who really know what they are doing, and only if there is a real (performance) need, if you are not one of these, inform yourself well or use an DataWriter, which provides a much safer interface to the channel.

◆ wrapSendEvent() [2/2]

template<class T >
void dueca::wrapSendEvent ( EventChannelWriteToken< T > & t,
const T * edata,
const TimeTickType & tick )
inline

The "wrapSendEvent" function can be used to send an event with self-allocated event data.

Note that the use of this function should be reserved to people who really know what they are doing, and only if there is a real (performance) need, if you are not one of these, inform yourself well or use a DataWriter, which provides a much safer interface to the channel.

◆ wrapSendData()

void dueca::wrapSendData ( ChannelWriteToken & t,
const void * edata,
const DataTimeSpec & tick )
inline

The "wrapSendData" function can be used to send an event or stream data with self-allocated data.

Parameters
tValid channel write token, configured for events.
edataPointer to the object to be written. Must be a valid DCO object, dynamically allocated, and the channel will assume ownership!
tickTime spec for the writing.

Note that the use of this function should be reserved to people who really know what they are doing, and only if there is a real (performance) need, if you are not one of these, inform yourself well or use a DataWriter, which provides a much safer interface to the channel.