Diffusion C API  6.10.2
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
streams.h File Reference

Functions for adding value streams to a session. More...

Typedefs

typedef struct
VALUE_STREAM_HANDLE_T 
VALUE_STREAM_HANDLE_T
 Token returned when a value stream is added. More...
 

Functions

VALUE_STREAM_HANDLE_Tadd_stream (SESSION_T *session, const char *topic_selector, const VALUE_STREAM_T *value_stream)
 Add a value stream. More...
 
VALUE_STREAM_HANDLE_Tadd_time_series_stream (SESSION_T *session, const char *topic_selector, const VALUE_STREAM_T *value_stream)
 Add a time series stream. More...
 
VALUE_STREAM_HANDLE_Tadd_fallback_stream (SESSION_T *session, const VALUE_STREAM_T *value_stream)
 Add a fallback value stream. More...
 
VALUE_STREAM_HANDLE_Tadd_time_series_fallback_stream (SESSION_T *session, const VALUE_STREAM_T *value_stream)
 Add a time series fallback value stream. More...
 
void remove_stream (SESSION_T *session, const VALUE_STREAM_HANDLE_T *handle)
 Remove a value stream. More...
 

Detailed Description

Functions for adding value streams to a session.

Typedef Documentation

Token returned when a value stream is added.

This token is then required when removing the value stream.

Function Documentation

VALUE_STREAM_HANDLE_T* add_fallback_stream ( SESSION_T session,
const VALUE_STREAM_T value_stream 
)

Add a fallback value stream.

Parameters
sessionThe current active session
value_streamvalue stream to add
Returns
a unique value stream handle required when the value stream is removed. If this function is unable to add the fallback value stream NULL will be returned.
VALUE_STREAM_HANDLE_T* add_stream ( SESSION_T session,
const char *  topic_selector,
const VALUE_STREAM_T value_stream 
)

Add a value stream.

Parameters
sessionthe current active session
topic_selectortopic selector to register the stream for
value_streamvalue stream to add
Returns
a unique value stream handle required when the value stream is removed. If this function is unable to add the value stream, NULL will be returned.
VALUE_STREAM_HANDLE_T* add_time_series_fallback_stream ( SESSION_T session,
const VALUE_STREAM_T value_stream 
)

Add a time series fallback value stream.

Parameters
sessionThe current active session
value_streamtime series value stream to add
Returns
a unique value stream handle required when the value stream is removed. If this function is unable to add the fallback value stream NULL will be returned.
VALUE_STREAM_HANDLE_T* add_time_series_stream ( SESSION_T session,
const char *  topic_selector,
const VALUE_STREAM_T value_stream 
)

Add a time series stream.

Parameters
sessionthe current active session
topic_selectortopic selector to register the stream for
value_streamtime series stream to add
Returns
a unique value stream handle required when the value stream is removed. If this function is unable to add the value stream, NULL will be returned.
void remove_stream ( SESSION_T session,
const VALUE_STREAM_HANDLE_T handle 
)

Remove a value stream.

The handle provided to this function will be freed when the function completes.

Parameters
sessionThe current active session
handlevalue stream handle returned from an add_stream call