Macros
#define	SRP_CLEANUP_CB "sr_plugin_cleanup_cb"
	sysrepo-plugind plugin cleanup callback name that must exist in every plugin. More...

#define	SRP_INIT_CB "sr_plugin_init_cb"
	sysrepo-plugind plugin initialization callback name that must exist in every plugin. More...

#define	SRPLG_LOG_DBG(plg_name,...) srplg_log(plg_name, SR_LL_DBG, __VA_ARGS__)
	Log a plugin debug message with format arguments. More...

#define	SRPLG_LOG_ERR(plg_name,...) srplg_log(plg_name, SR_LL_ERR, __VA_ARGS__)
	Log a plugin error message with format arguments. Datastore and notification plugins should use srplg_log_errinfo() instead. More...

#define	SRPLG_LOG_INF(plg_name,...) srplg_log(plg_name, SR_LL_INF, __VA_ARGS__)
	Log a plugin info message with format arguments. More...

#define	SRPLG_LOG_WRN(plg_name,...) srplg_log(plg_name, SR_LL_WRN, __VA_ARGS__)
	Log a plugin warning message with format arguments. More...

Functions
void	srplg_errinfo_free (sr_error_info_t **err_info)
	Free a superfluous error info. More...

void int	srplg_errinfo_push_error_data (sr_error_info_t err_info, uint32_t size, const void data)
	Push (add) another chunk of error data for a failed plugin callback. Its meaning is specific to the error data format name (which must be set prior to calling this function) identifier and can be read from the error structure by the originator using sr_get_error_data(). More...

void	srplg_log_errinfo (sr_error_info_t *err_info, const char plg_name, const char err_format_name, sr_error_t err_code, const char format,...) _FORMAT_PRINTF(5
	Log a plugin error message and add the error into an error info structure. More...

typedef int(*	srp_init_cb_t )(sr_session_ctx_t session, void *private_data)
	Sysrepo plugin initialization callback. More...

typedef void(*	srp_cleanup_cb_t )(sr_session_ctx_t session, void private_data)
	Sysrepo plugin cleanup callback. More...

Detailed Description

Macro Definition Documentation

#define SRP_CLEANUP_CB "sr_plugin_cleanup_cb"

sysrepo-plugind plugin cleanup callback name that must exist in every plugin.

The callback must be of srp_cleanup_cb_t type.

Definition at line 1853 of file sysrepo.h.

#define SRP_INIT_CB "sr_plugin_init_cb"

sysrepo-plugind plugin initialization callback name that must exist in every plugin.

The callback must be of srp_init_cb_t type.

Definition at line 1846 of file sysrepo.h.

#define SRPLG_LOG_DBG	(	plg_name,
		...
	)	srplg_log(plg_name, SR_LL_DBG, __VA_ARGS__)

Log a plugin debug message with format arguments.

Parameters

[in]	plg_name	Plugin name to print.
[in]	...	Format string and arguments.

Definition at line 1917 of file sysrepo.h.

#define SRPLG_LOG_ERR	(	plg_name,
		...
	)	srplg_log(plg_name, SR_LL_ERR, __VA_ARGS__)

Log a plugin error message with format arguments. Datastore and notification plugins should use srplg_log_errinfo() instead.

Definition at line 1893 of file sysrepo.h.

#define SRPLG_LOG_INF	(	plg_name,
		...
	)	srplg_log(plg_name, SR_LL_INF, __VA_ARGS__)

Log a plugin info message with format arguments.

Parameters

[in]	plg_name	Plugin name to print.
[in]	...	Format string and arguments.

Definition at line 1909 of file sysrepo.h.

#define SRPLG_LOG_WRN	(	plg_name,
		...
	)	srplg_log(plg_name, SR_LL_WRN, __VA_ARGS__)

Log a plugin warning message with format arguments.

Parameters

[in]	plg_name	Plugin name to print.
[in]	...	Format string and arguments.

Definition at line 1901 of file sysrepo.h.

Typedef Documentation

typedef void(* srp_cleanup_cb_t)(sr_session_ctx_t *session, void *private_data)

Sysrepo plugin cleanup callback.

Parameters

[in]	session	Sysrepo session that can be used for any API calls needed for plugin cleanup (mainly for unsubscribing of subscriptions initialized in srp_init_cb_t).
[in]	private_data	Private context as passed in srp_init_cb_t.

Definition at line 721 of file sysrepo_types.h.

typedef int(* srp_init_cb_t)(sr_session_ctx_t *session, void **private_data)

Sysrepo plugin initialization callback.

Parameters

[in]	session	Sysrepo session that can be used for any API calls needed for plugin initialization (mainly for reading of startup configuration and subscribing for notifications).
[out]	private_data	Private context (opaque to sysrepo) that will be passed to srp_cleanup_cb_t when plugin cleanup is requested.

Returns: Error code (SR_ERR_OK on success).

Definition at line 711 of file sysrepo_types.h.

Function Documentation

void srplg_errinfo_free ( sr_error_info_t ** err_info )

Free a superfluous error info.

Parameters

[in,out] err_info Error info to free, is set to NULL.

void int srplg_errinfo_push_error_data	(	sr_error_info_t *	err_info,
		uint32_t	size,
		const void *	data
	)

Push (add) another chunk of error data for a failed plugin callback. Its meaning is specific to the error data format name (which must be set prior to calling this function) identifier and can be read from the error structure by the originator using sr_get_error_data().

Parameters

[in]	err_info	Error info created by srplg_log_errinfo() with a specific error format name set. The last created error is being modified.
[in]	size	Size of the error `data` chunk.
[in]	data	Pointer to an opaque error data chunk.

Returns: Error code (SR_ERR_OK on success).

void srplg_log_errinfo	(	sr_error_info_t **	err_info,
		const char *	plg_name,
		const char *	err_format_name,
		sr_error_t	err_code,
		const char *	format,
			...
	)

Log a plugin error message and add the error into an error info structure.

Parameters

[in,out]	err_info	Empty or an exisiting error info to add to.
[in]	plg_name	Plugin name to print.
[in]	err_format_name	Optional arbitrary error format identifier, set its error data using srplg_errinfo_push_error_data(). More details in sr_session_set_error_format().
[in]	err_code	Error code of the error.
[in]	format	Error message format.
[in]	...	Error message format arguments.

Macros

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation