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.

Functions
VALUE_STREAM_HANDLE_T *	add_stream (SESSION_T *session, const char *topic_selector, const VALUE_STREAM_T *value_stream)
	Add a value stream.
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.
VALUE_STREAM_HANDLE_T *	add_fallback_stream (SESSION_T *session, const VALUE_STREAM_T *value_stream)
	Add a fallback value stream.
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.
void	remove_stream (SESSION_T *session, const VALUE_STREAM_HANDLE_T *handle)
	Remove a value stream.

Detailed Description

Functions for adding value streams to a session.

Typedef Documentation

VALUE_STREAM_HANDLE_T

typedef struct VALUE_STREAM_HANDLE_T VALUE_STREAM_HANDLE_T

Token returned when a value stream is added.

This token is then required when removing the value stream.

Function Documentation

add_fallback_stream()

VALUE_STREAM_HANDLE_T * add_fallback_stream	(	SESSION_T *	session,
		const VALUE_STREAM_T *	value_stream
	)

Add a fallback value stream.

Parameters

session	The current active session
value_stream	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.

add_stream()

VALUE_STREAM_HANDLE_T * add_stream	(	SESSION_T *	session,
		const char *	topic_selector,
		const VALUE_STREAM_T *	value_stream
	)

Add a value stream.

Parameters

session	the current active session
topic_selector	topic selector to register the stream for
value_stream	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 value stream, NULL will be returned.

add_time_series_fallback_stream()

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

session	The current active session
value_stream	time 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.

add_time_series_stream()

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

session	the current active session
topic_selector	topic selector to register the stream for
value_stream	time 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.

remove_stream()

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

session	The current active session
handle	value stream handle returned from an add_stream call