Interface of the data client plugin. More...

#include <south_api.h>

Data Fields
void *	plugin_context
	The (private) plugin context. Must be freed using free_context on unloading the plugin. More...

TEK_SA_RESULT(*	data_client_new )(void plugin_context, const struct tek_sa_data_client_configuration config, struct tek_sa_data_client created_client, struct tek_sa_data_client_capabilities capabilities)
	Allocates and initializes the data client with a configuration. Prepare callbacks in data_client. More...

void(*	free_context )(void *plugin_context)
	Frees the private context of the plugin. More...

Detailed Description

Interface of the data client plugin.

The data client plugin is created once as result of a call to the load_plugin method();

Definition at line 1393 of file south_api.h.

Field Documentation

void* tek_sa_data_client_plugin::plugin_context

The (private) plugin context. Must be freed using free_context on unloading the plugin.

Definition at line 1398 of file south_api.h.

TEK_SA_RESULT(* tek_sa_data_client_plugin::data_client_new) (void *plugin_context, const struct tek_sa_data_client_configuration *config, struct tek_sa_data_client *created_client, struct tek_sa_data_client_capabilities *capabilities)

Allocates and initializes the data client with a configuration. Prepare callbacks in data_client.

Does not perform any actions like connecting to the data source or register information at the TEK.

Parameters

plugin_context
config
created_client
capabilities	The data client capabilities (known before connect), e.g. the threading model of the data client. Capabilities can be updated by the client using the TEK API, if additional information are retrieved later in the lifecycle of the data client.

Definition at line 1416 of file south_api.h.

void(* tek_sa_data_client_plugin::free_context) (void *plugin_context)

Frees the private context of the plugin.

Definition at line 1424 of file south_api.h.

The documentation for this struct was generated from the following file: