Diffusion C API  6.7.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
topic-selector.h File Reference

Topic Selector A topic selector identifies one or more topics and are created from a pattern expression. More...

Typedefs

typedef struct
DIFFUSION_TOPIC_SELECTOR_T 
DIFFUSION_TOPIC_SELECTOR_T
 Opaque Topic Selector struct.
 

Functions

DIFFUSION_TOPIC_SELECTOR_Tdiffusion_topic_selector_create (char *expression, DIFFUSION_API_ERROR *error)
 Return a DIFFUSION_TOPIC_SELECTOR_T struct for the given expression. More...
 
bool diffusion_topic_selector_selects (DIFFUSION_TOPIC_SELECTOR_T *topic_selector, char *topic_path)
 Evaluate a topic selector against a topic path. More...
 
void diffusion_topic_selector_free (DIFFUSION_TOPIC_SELECTOR_T *topic_selector)
 Free a topic selector. More...
 

Detailed Description

Topic Selector A topic selector identifies one or more topics and are created from a pattern expression.

Since
6.7

Function Documentation

DIFFUSION_TOPIC_SELECTOR_T* diffusion_topic_selector_create ( char *  expression,
DIFFUSION_API_ERROR error 
)

Return a DIFFUSION_TOPIC_SELECTOR_T struct for the given expression.

Parameters
expressionThe expression to be used for evaluating topic paths.
errorPopulated on API error. Can be NULL.
Returns
The topic selector struct for the given expression if the operation was successful, NULL otherwise. In this case, if a non-NULL error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.
Since
6.7
void diffusion_topic_selector_free ( DIFFUSION_TOPIC_SELECTOR_T topic_selector)

Free a topic selector.

Parameters
topic_selectorThe topic selector.
Since
6.7
bool diffusion_topic_selector_selects ( DIFFUSION_TOPIC_SELECTOR_T topic_selector,
char *  topic_path 
)

Evaluate a topic selector against a topic path.

Parameters
topic_selectorThe topic selector.
topic_pathThe topic path to evaluate against.
Returns
true is the topic selector selects the topic path, false otherwise.
Since
6.7