Diffusion C API 6.12.0
Loading...
Searching...
No Matches
Management and configuration of metric collectors.

Data Structures

struct  diffusion_metrics_put_session_metric_collector_params_s
 Structure supplied when issuing a diffusion_metrics_put_session_metric_collector call. More...
struct  diffusion_metrics_put_topic_metric_collector_params_s
 Structure supplied when issuing a diffusion_metrics_put_topic_metric_collector call. More...
struct  diffusion_metrics_remove_session_metric_collector_params_s
 Structure supplied when issuing a diffusion_metrics_remove_session_metric_collector call. More...
struct  diffusion_metrics_remove_topic_metric_collector_params_s
 Structure supplied when issuing a diffusion_metrics_remove_topic_metric_collector call. More...
struct  diffusion_metrics_list_session_metric_collectors_params_s
 Structure supplied when issuing a diffusion_metrics_list_session_metric_collectors call. More...
struct  diffusion_metrics_list_topic_metric_collectors_params_s
 Structure supplied when issuing a diffusion_metrics_list_topic_metric_collectors call. More...

Typedefs

typedef struct DIFFUSION_SESSION_METRIC_COLLECTOR_BUILDER_T DIFFUSION_SESSION_METRIC_COLLECTOR_BUILDER_T
 Opaque Session Metric Collector Builder struct.
typedef struct DIFFUSION_SESSION_METRIC_COLLECTOR_T DIFFUSION_SESSION_METRIC_COLLECTOR_T
 Opaque Session Metric Collector struct.
typedef struct DIFFUSION_TOPIC_METRIC_COLLECTOR_BUILDER_T DIFFUSION_TOPIC_METRIC_COLLECTOR_BUILDER_T
 Opaque Topic Metric Collector Builder struct.
typedef struct DIFFUSION_TOPIC_METRIC_COLLECTOR_T DIFFUSION_TOPIC_METRIC_COLLECTOR_T
 Opaque Topic Metric Collector struct.
typedef int(* session_metric_collector_put_cb) (void *context)
 callback when a session metric collector has been set on the server.
typedef int(* session_metric_collector_remove_cb) (void *context)
 callback when a session metric collector has been removed from the server.
typedef int(* session_metric_collector_list_cb) (const LIST_T *session_metric_collectors, void *context)
 callback when the list of session metric collectors has been retrieved from the server.
typedef int(* topic_metric_collector_put_cb) (void *context)
 callback when a topic metric collector has been set on the server.
typedef int(* topic_metric_collector_remove_cb) (void *context)
 callback when a topic metric collector has been removed from the server.
typedef int(* topic_metric_collector_list_cb) (const LIST_T *topic_metric_collectors, void *context)
 callback when the list of topic metric collectors has been retrieved from the server.
typedef struct diffusion_metrics_put_session_metric_collector_params_s DIFFUSION_METRICS_PUT_SESSION_METRIC_COLLECTOR_PARAMS_T
 Structure supplied when issuing a diffusion_metrics_put_session_metric_collector call.
typedef struct diffusion_metrics_put_topic_metric_collector_params_s DIFFUSION_METRICS_PUT_TOPIC_METRIC_COLLECTOR_PARAMS_T
 Structure supplied when issuing a diffusion_metrics_put_topic_metric_collector call.
typedef struct diffusion_metrics_remove_session_metric_collector_params_s DIFFUSION_METRICS_REMOVE_SESSION_METRIC_COLLECTOR_PARAMS_T
 Structure supplied when issuing a diffusion_metrics_remove_session_metric_collector call.
typedef struct diffusion_metrics_remove_topic_metric_collector_params_s DIFFUSION_METRICS_REMOVE_TOPIC_METRIC_COLLECTOR_PARAMS_T
 Structure supplied when issuing a diffusion_metrics_remove_topic_metric_collector call.
typedef struct diffusion_metrics_list_session_metric_collectors_params_s DIFFUSION_METRICS_LIST_SESSION_METRIC_COLLECTORS_PARAMS_T
 Structure supplied when issuing a diffusion_metrics_list_session_metric_collectors call.
typedef struct diffusion_metrics_list_topic_metric_collectors_params_s DIFFUSION_METRICS_LIST_TOPIC_METRIC_COLLECTORS_PARAMS_T
 Structure supplied when issuing a diffusion_metrics_list_topic_metric_collectors call.

Functions

bool diffusion_metrics_put_session_metric_collector (SESSION_T *session, const DIFFUSION_METRICS_PUT_SESSION_METRIC_COLLECTOR_PARAMS_T params, DIFFUSION_API_ERROR *api_error)
 Add a session metric collector, replacing any with the same name.
bool diffusion_metrics_list_session_metric_collectors (SESSION_T *session, const DIFFUSION_METRICS_LIST_SESSION_METRIC_COLLECTORS_PARAMS_T params, DIFFUSION_API_ERROR *api_error)
 Retrieves the current session metric collectors.
bool diffusion_metrics_remove_session_metric_collector (SESSION_T *session, const DIFFUSION_METRICS_REMOVE_SESSION_METRIC_COLLECTOR_PARAMS_T params, DIFFUSION_API_ERROR *api_error)
 Removes any session metric collector with the given name, if it exists.
bool diffusion_metrics_put_topic_metric_collector (SESSION_T *session, const DIFFUSION_METRICS_PUT_TOPIC_METRIC_COLLECTOR_PARAMS_T params, DIFFUSION_API_ERROR *api_error)
 Add a topic metric collector, replacing any with the same name.
bool diffusion_metrics_list_topic_metric_collectors (SESSION_T *session, const DIFFUSION_METRICS_LIST_TOPIC_METRIC_COLLECTORS_PARAMS_T params, DIFFUSION_API_ERROR *api_error)
 Retrieves the current topic metric collectors.
bool diffusion_metrics_remove_topic_metric_collector (SESSION_T *session, const DIFFUSION_METRICS_REMOVE_TOPIC_METRIC_COLLECTOR_PARAMS_T params, DIFFUSION_API_ERROR *api_error)
 Removes any topic metric collector with the given name, if it exists.

Detailed Description

Typedef Documentation

◆ session_metric_collector_list_cb

typedef int(* session_metric_collector_list_cb) (const LIST_T *session_metric_collectors, void *context)

callback when the list of session metric collectors has been retrieved from the server.

Parameters
contextUser supplied context.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.

◆ session_metric_collector_put_cb

typedef int(* session_metric_collector_put_cb) (void *context)

callback when a session metric collector has been set on the server.

Parameters
contextUser supplied context.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.

◆ session_metric_collector_remove_cb

typedef int(* session_metric_collector_remove_cb) (void *context)

callback when a session metric collector has been removed from the server.

Parameters
contextUser supplied context.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.

◆ topic_metric_collector_list_cb

typedef int(* topic_metric_collector_list_cb) (const LIST_T *topic_metric_collectors, void *context)

callback when the list of topic metric collectors has been retrieved from the server.

Parameters
contextUser supplied context.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.

◆ topic_metric_collector_put_cb

typedef int(* topic_metric_collector_put_cb) (void *context)

callback when a topic metric collector has been set on the server.

Parameters
contextUser supplied context.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.

◆ topic_metric_collector_remove_cb

typedef int(* topic_metric_collector_remove_cb) (void *context)

callback when a topic metric collector has been removed from the server.

Parameters
contextUser supplied context.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.

Function Documentation

◆ diffusion_metrics_list_session_metric_collectors()

bool diffusion_metrics_list_session_metric_collectors ( SESSION_T * session,
const DIFFUSION_METRICS_LIST_SESSION_METRIC_COLLECTORS_PARAMS_T params,
DIFFUSION_API_ERROR * api_error )

Retrieves the current session metric collectors.

Parameters
sessionThe current session. If NULL, this function returns immediately.
paramsParameter structure describing the callbacks to be invoked.
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.

◆ diffusion_metrics_list_topic_metric_collectors()

bool diffusion_metrics_list_topic_metric_collectors ( SESSION_T * session,
const DIFFUSION_METRICS_LIST_TOPIC_METRIC_COLLECTORS_PARAMS_T params,
DIFFUSION_API_ERROR * api_error )

Retrieves the current topic metric collectors.

Parameters
sessionThe current session. If NULL, this function returns immediately.
paramsParameter structure describing the callbacks to be invoked.
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.

◆ diffusion_metrics_put_session_metric_collector()

bool diffusion_metrics_put_session_metric_collector ( SESSION_T * session,
const DIFFUSION_METRICS_PUT_SESSION_METRIC_COLLECTOR_PARAMS_T params,
DIFFUSION_API_ERROR * api_error )

Add a session metric collector, replacing any with the same name.

Parameters
sessionThe current session. If NULL, this function returns immediately.
paramsParameter structure describing the session metric collector and the callbacks to be invoked.
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.

◆ diffusion_metrics_put_topic_metric_collector()

bool diffusion_metrics_put_topic_metric_collector ( SESSION_T * session,
const DIFFUSION_METRICS_PUT_TOPIC_METRIC_COLLECTOR_PARAMS_T params,
DIFFUSION_API_ERROR * api_error )

Add a topic metric collector, replacing any with the same name.

Parameters
sessionThe current session. If NULL, this function returns immediately.
paramsParameter structure describing the topic metric collector and the callbacks to be invoked.
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.

◆ diffusion_metrics_remove_session_metric_collector()

bool diffusion_metrics_remove_session_metric_collector ( SESSION_T * session,
const DIFFUSION_METRICS_REMOVE_SESSION_METRIC_COLLECTOR_PARAMS_T params,
DIFFUSION_API_ERROR * api_error )

Removes any session metric collector with the given name, if it exists.

Parameters
sessionThe current session. If NULL, this function returns immediately.
paramsParameter structure describing the session metric collector name and the callbacks to be invoked.
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.

◆ diffusion_metrics_remove_topic_metric_collector()

bool diffusion_metrics_remove_topic_metric_collector ( SESSION_T * session,
const DIFFUSION_METRICS_REMOVE_TOPIC_METRIC_COLLECTOR_PARAMS_T params,
DIFFUSION_API_ERROR * api_error )

Removes any topic metric collector with the given name, if it exists.

Parameters
sessionThe current session. If NULL, this function returns immediately.
paramsParameter structure describing the topic metric collector name and the callbacks to be invoked.
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.