ED247 Library  VA2.3.0
Implementation of ED247-A standard
Read configuration

Detailed Description

Functions

LIBED247_EXPORT ed247_status_t ed247_get_channel_list (ed247_context_t context, ed247_channel_list_t *channels)
 Retrieve all the channels of the component. More...
 
LIBED247_EXPORT ed247_status_t ed247_find_channels (ed247_context_t context, const char *regex_name, ed247_channel_list_t *channels)
 Find all channels of the component whose names match regex_name. More...
 
LIBED247_EXPORT ed247_status_t ed247_get_channel (ed247_context_t context, const char *name, ed247_channel_t *channel)
 Get a channel of the component. More...
 
LIBED247_EXPORT ed247_status_t ed247_get_stream_list (ed247_context_t context, ed247_stream_list_t *streams)
 Retrieve all the streams of the component. More...
 
LIBED247_EXPORT ed247_status_t ed247_find_streams (ed247_context_t context, const char *regex_name, ed247_stream_list_t *streams)
 Find all streams of the component whose names match regex_name. More...
 
LIBED247_EXPORT ed247_status_t ed247_get_stream (ed247_context_t context, const char *name, ed247_stream_t *stream)
 Get a stream of the component. More...
 
LIBED247_EXPORT ed247_status_t ed247_find_signals (ed247_context_t context, const char *regex_name, ed247_signal_list_t *signals)
 Find all signals of the component whose names match regex_name. More...
 
LIBED247_EXPORT ed247_status_t ed247_get_signal (ed247_context_t context, const char *name, ed247_signal_t *signal)
 Get a signal of the component. More...
 

Function Documentation

LIBED247_EXPORT ed247_status_t ed247_get_channel_list ( ed247_context_t  context,
ed247_channel_list_t channels 
)

Retrieve all the channels of the component.

The lifespan of returned channels is the same as the context, but you can safely call ed247_channel_list_free().

Parameters
[in]contextThe context identifier
[out]channelsList of the channels
Return values
ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE

Here is the caller graph for this function:

LIBED247_EXPORT ed247_status_t ed247_find_channels ( ed247_context_t  context,
const char *  regex_name,
ed247_channel_list_t channels 
)

Find all channels of the component whose names match regex_name.

regex_name shall follow the ECMAScript grammar.
This function allocates channels. It has to be freed with ed247_channel_list_free().
If you know exact channel names, use ed247_get_channel() instead which is really faster and malloc-free.
If you want all channels, use ed247_get_channel_list() instead which is really faster and malloc-free.

Parameters
[in]contextThe context identifier.
[in]regex_nameThe regular expression for name matching. If null, assume '.*'.
[out]channelsThe list of the channels. If no value, set to null.
Return values
ED247_STATUS_SUCCESS
ED247_STATUS_FAILUREThe channel list is empty
Note
The regular expressions are not implemented in gcc4.8.x (default linux), do not use complex requests.
LIBED247_EXPORT ed247_status_t ed247_get_channel ( ed247_context_t  context,
const char *  name,
ed247_channel_t channel 
)

Get a channel of the component.

Parameters
[in]contextThe context identifier.
[in]nameThe name of the channel.
[out]channelThe channel identifier
Return values
ED247_STATUS_SUCCESS
ED247_STATUS_FAILUREThe channel list is empty
LIBED247_EXPORT ed247_status_t ed247_get_stream_list ( ed247_context_t  context,
ed247_stream_list_t streams 
)

Retrieve all the streams of the component.

The lifespan of returned streams is the same as the context, but you can safely call ed247_stream_list_free().

Parameters
[in]contextThe context identifier
[out]streamsList of the streams
Return values
ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE

Here is the caller graph for this function:

LIBED247_EXPORT ed247_status_t ed247_find_streams ( ed247_context_t  context,
const char *  regex_name,
ed247_stream_list_t streams 
)

Find all streams of the component whose names match regex_name.

regex_name shall follow the ECMAScript grammar.
This function allocates streams. It has to be freed with ed247_stream_list_free().
If you know exact stream names, use ed247_get_stream() instead which is really faster and malloc-free.
If you want all streams, use ed247_get_stream_list() instead which is really faster and malloc-free.

Parameters
[in]contextThe context identifier
[in]regex_nameThe regular expression for name matching. If null, assume '.*'.
[out]streamsThe list of the streams. If no value, set to null.
Return values
ED247_STATUS_SUCCESS
ED247_STATUS_FAILUREThe stream list is empty
Note
The regular expressions are not implemented in gcc4.8.x (default linux), do not use complex requests.
LIBED247_EXPORT ed247_status_t ed247_get_stream ( ed247_context_t  context,
const char *  name,
ed247_stream_t stream 
)

Get a stream of the component.

Parameters
[in]contextThe context identifier
[in]nameThe name of the stream.
[out]streamThe stream identifier
Return values
ED247_STATUS_SUCCESS
ED247_STATUS_FAILUREThe stream list is empty
LIBED247_EXPORT ed247_status_t ed247_find_signals ( ed247_context_t  context,
const char *  regex_name,
ed247_signal_list_t signals 
)

Find all signals of the component whose names match regex_name.

regex_name shall follow the ECMAScript grammar.
This function allocates signals. It has to be freed with ed247_signal_list_free().
If you know exact signal names, use ed247_get_signal() instead which is really faster and malloc-free.

Parameters
[in]contextThe context identifier
[in]regex_nameThe regular expression for name matching. If null, assume '.*'.
[out]signalsThe list of the signals. If no value, set to null.
Return values
ED247_STATUS_SUCCESS
ED247_STATUS_FAILUREThe stream list is empty
Note
The regular expressions are not implemented in gcc4.8.x (default linux), do not use complex requests.
LIBED247_EXPORT ed247_status_t ed247_get_signal ( ed247_context_t  context,
const char *  name,
ed247_signal_t signal 
)

Get a signal of the component.

Parameters
[in]contextThe context identifier
[in]nameThe signal name.
[out]signalThe signal identifier.
Return values
ED247_STATUS_SUCCESS
ED247_STATUS_FAILUREThe stream list is empty