streams.h File Reference

Copyright © 2018 Push Technology Ltd., All Rights Reserved. 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_T *	add_stream (SESSION_T *session, const char *topic_selector, const VALUE_STREAM_T *value_stream)
	Add a value stream. More...
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. More...
VALUE_STREAM_HANDLE_T *	add_fallback_stream (SESSION_T *session, const VALUE_STREAM_T *value_stream)
	Add a fallback value stream. More...
void	remove_stream (SESSION_T *session, const VALUE_STREAM_HANDLE_T *handle)
	Remove a value stream. More...

Detailed Description

Copyright © 2018 Push Technology Ltd., All Rights Reserved.

Use is subject to license terms.

NOTICE: All information contained herein is, and remains the property of Push Technology. The intellectual and technical concepts contained herein are proprietary to Push Technology and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law.

Typedef Documentation

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

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.

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.

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.

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