sysrepo  3.0.0
YANG-based system repository for all-around configuration management.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
sysrepo.h
Go to the documentation of this file.
1 
17 #ifndef _SYSREPO_H
18 #define _SYSREPO_H
19 
20 #include <stdint.h>
21 #include <stdlib.h>
22 #include <sys/types.h>
23 #include <time.h>
24 #include <unistd.h>
25 
26 #include <libyang/libyang.h>
27 
28 #include "sysrepo_types.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
35 // Logging API
37 
49 const char *sr_strerror(int err_code);
50 
61 void sr_log_stderr(sr_log_level_t log_level);
62 
69 
86 void sr_log_syslog(const char *app_name, sr_log_level_t log_level);
87 
94 
101 void sr_log_set_cb(sr_log_cb log_callback);
102 
105 // Connection / Session Management
108 
124 int sr_connect(const sr_conn_options_t opts, sr_conn_ctx_t **conn);
125 
137 int sr_disconnect(sr_conn_ctx_t *conn);
138 
150 const struct ly_ctx *sr_acquire_context(sr_conn_ctx_t *conn);
151 
161 const struct ly_ctx *sr_session_acquire_context(sr_session_ctx_t *session);
162 
171 
180 
188 uint32_t sr_get_content_id(sr_conn_ctx_t *conn);
189 
198 int sr_get_plugins(sr_conn_ctx_t *conn, const char ***ds_plugins, const char ***ntf_plugins);
199 
205 uid_t sr_get_su_uid(void);
206 
216 int sr_session_start(sr_conn_ctx_t *conn, const sr_datastore_t datastore, sr_session_ctx_t **session);
217 
230 int sr_session_stop(sr_session_ctx_t *session);
231 
242 
255 
266 
274 
290 int sr_session_set_orig_name(sr_session_ctx_t *session, const char *orig_name);
291 
298 const char *sr_session_get_orig_name(sr_session_ctx_t *session);
299 
311 int sr_session_push_orig_data(sr_session_ctx_t *session, uint32_t size, const void *data);
312 
319 
329 int sr_session_get_orig_data(sr_session_ctx_t *session, uint32_t idx, uint32_t *size, const void **data);
330 
341 int sr_session_get_error(sr_session_ctx_t *session, const sr_error_info_t **error_info);
342 
350 int sr_session_dup_error(sr_session_ctx_t *src_session, sr_session_ctx_t *trg_session);
351 
370 int sr_session_set_error(sr_session_ctx_t *session, const char *err_format_name, sr_error_t err_code,
371  const char *err_msg_format, ...);
372 
376 int sr_session_set_error_message(sr_session_ctx_t *session, const char *format, ...);
377 
381 int sr_session_set_error_format(sr_session_ctx_t *session, const char *error_format);
382 
393 int sr_session_push_error_data(sr_session_ctx_t *session, uint32_t size, const void *data);
394 
407 int sr_get_error_data(const sr_error_info_err_t *err, uint32_t idx, uint32_t *size, const void **data);
408 
415 uint32_t sr_session_get_id(sr_session_ctx_t *session);
416 
426 int sr_session_set_user(sr_session_ctx_t *session, const char *user);
427 
434 const char *sr_session_get_user(sr_session_ctx_t *session);
435 
443 
446 // Schema Manipulation API
449 
463 const char *sr_get_repo_path(void);
464 
470 const char *sr_get_shm_path(void);
471 
477 const char *sr_get_shm_prefix(void);
478 
490 int sr_install_module(sr_conn_ctx_t *conn, const char *schema_path, const char *search_dirs, const char **features);
491 
501 
526 int sr_install_module2(sr_conn_ctx_t *conn, const char *schema_path, const char *search_dirs, const char **features,
527  const sr_module_ds_t *module_ds, const char *owner, const char *group, mode_t perm, const char *data,
528  const char *data_path, LYD_FORMAT format);
529 
543 int sr_install_modules(sr_conn_ctx_t *conn, const char **schema_paths, const char *search_dirs,
544  const char ***features);
545 
561 int sr_install_modules2(sr_conn_ctx_t *conn, const sr_install_mod_t *modules, uint32_t module_count,
562  const char *search_dirs, const char *data, const char *data_path, LYD_FORMAT format);
563 
574 int sr_remove_module(sr_conn_ctx_t *conn, const char *module_name, int force);
575 
586 int sr_remove_modules(sr_conn_ctx_t *conn, const char **module_names, int force);
587 
598 int sr_update_module(sr_conn_ctx_t *conn, const char *schema_path, const char *search_dirs);
599 
610 int sr_update_modules(sr_conn_ctx_t *conn, const char **schema_paths, const char *search_dirs);
611 
620 int sr_set_module_replay_support(sr_conn_ctx_t *conn, const char *module_name, int enable);
621 
632 int sr_get_module_replay_support(sr_conn_ctx_t *conn, const char *module_name, struct timespec *earliest_notif,
633  int *enabled);
634 
646 int sr_set_module_ds_access(sr_conn_ctx_t *conn, const char *module_name, int mod_ds, const char *owner,
647  const char *group, mode_t perm);
648 
660 int sr_get_module_ds_access(sr_conn_ctx_t *conn, const char *module_name, int mod_ds, char **owner, char **group,
661  mode_t *perm);
662 
673 int sr_check_module_ds_access(sr_conn_ctx_t *conn, const char *module_name, int mod_ds, int *read, int *write);
674 
685 int sr_enable_module_feature(sr_conn_ctx_t *conn, const char *module_name, const char *feature_name);
686 
697 int sr_disable_module_feature(sr_conn_ctx_t *conn, const char *module_name, const char *feature_name);
698 
708 int sr_get_module_info(sr_conn_ctx_t *conn, sr_data_t **sysrepo_data);
709 
718 int sr_is_module_internal(const struct lys_module *ly_mod);
719 
722 // Data Retrieval API (get / get-config functionality)
725 
752 int sr_get_item(sr_session_ctx_t *session, const char *path, uint32_t timeout_ms, sr_val_t **value);
753 
771 int sr_get_items(sr_session_ctx_t *session, const char *xpath, uint32_t timeout_ms, const sr_get_options_t opts,
772  sr_val_t **values, size_t *value_cnt);
773 
786 int sr_session_acquire_data(sr_session_ctx_t *session, struct lyd_node *tree, sr_data_t **data);
787 
798 int sr_acquire_data(sr_conn_ctx_t *conn, struct lyd_node *tree, sr_data_t **data);
799 
818 int sr_get_subtree(sr_session_ctx_t *session, const char *path, uint32_t timeout_ms, sr_data_t **subtree);
819 
844 int sr_get_data(sr_session_ctx_t *session, const char *xpath, uint32_t max_depth, uint32_t timeout_ms,
845  const sr_get_options_t opts, sr_data_t **data);
846 
863 int sr_get_node(sr_session_ctx_t *session, const char *path, uint32_t timeout_ms, sr_data_t **node);
864 
871 void sr_release_data(sr_data_t *data);
872 
878 void sr_free_val(sr_val_t *value);
879 
887 void sr_free_values(sr_val_t *values, size_t count);
888 
891 // Data Manipulation API (edit-config functionality)
894 
927 int sr_set_item(sr_session_ctx_t *session, const char *path, const sr_val_t *value, const sr_edit_options_t opts);
928 
944 int sr_set_item_str(sr_session_ctx_t *session, const char *path, const char *value, const char *origin,
945  const sr_edit_options_t opts);
946 
963 int sr_delete_item(sr_session_ctx_t *session, const char *path, const sr_edit_options_t opts);
964 
968 int sr_oper_delete_item_str(sr_session_ctx_t *session, const char *path, const char *value, const sr_edit_options_t opts);
969 
982 int sr_discard_items(sr_session_ctx_t *session, const char *xpath);
983 
1011 int sr_move_item(sr_session_ctx_t *session, const char *path, const sr_move_position_t position, const char *list_keys,
1012  const char *leaflist_value, const char *origin, const sr_edit_options_t opts);
1013 
1028 int sr_edit_batch(sr_session_ctx_t *session, const struct lyd_node *edit, const char *default_operation);
1029 
1041 int sr_validate(sr_session_ctx_t *session, const char *module_name, uint32_t timeout_ms);
1042 
1059 int sr_apply_changes(sr_session_ctx_t *session, uint32_t timeout_ms);
1060 
1067 int sr_has_changes(sr_session_ctx_t *session);
1068 
1077 const struct lyd_node *sr_get_changes(sr_session_ctx_t *session);
1078 
1085 int sr_discard_changes(sr_session_ctx_t *session);
1086 
1100 int sr_replace_config(sr_session_ctx_t *session, const char *module_name, struct lyd_node *src_config,
1101  uint32_t timeout_ms);
1102 
1120 int sr_copy_config(sr_session_ctx_t *session, const char *module_name, sr_datastore_t src_datastore, uint32_t timeout_ms);
1121 
1131 int sr_discard_oper_changes(sr_conn_ctx_t *conn, sr_session_ctx_t *session, const char *module_name, uint32_t timeout_ms);
1132 
1141 int sr_get_oper_changes(sr_session_ctx_t *session, const char *module_name, sr_data_t **data);
1142 
1154 int sr_set_oper_changes_order(sr_session_ctx_t *session, const char *module_name, uint32_t order);
1155 
1165 int sr_get_oper_changes_order(sr_session_ctx_t *session, const char *module_name, uint32_t *order);
1166 
1169 // Locking API
1172 
1194 int sr_lock(sr_session_ctx_t *session, const char *module_name, uint32_t timeout_ms);
1195 
1205 int sr_unlock(sr_session_ctx_t *session, const char *module_name);
1206 
1222 int sr_get_lock(sr_conn_ctx_t *conn, sr_datastore_t datastore, const char *module_name, int *is_locked, uint32_t *id,
1223  struct timespec *timestamp);
1224 
1227 // Subscription API
1230 
1246 int sr_get_event_pipe(sr_subscription_ctx_t *subscription, int *event_pipe);
1247 
1261  struct timespec *wake_up_in);
1262 
1269 uint32_t sr_subscription_get_last_sub_id(const sr_subscription_ctx_t *subscription);
1270 
1279 int sr_subscription_get_suspended(sr_subscription_ctx_t *subscription, uint32_t sub_id, int *suspended);
1280 
1289 int sr_subscription_suspend(sr_subscription_ctx_t *subscription, uint32_t sub_id);
1290 
1299 int sr_subscription_resume(sr_subscription_ctx_t *subscription, uint32_t sub_id);
1300 
1314 int sr_unsubscribe_sub(sr_subscription_ctx_t *subscription, uint32_t sub_id);
1315 
1324 
1332 
1341 int sr_unsubscribe(sr_subscription_ctx_t *subscription);
1342 
1345 // Change Subscriptions API
1348 
1379 int sr_module_change_set_order(sr_conn_ctx_t *conn, const char *module_name, sr_datastore_t ds, uint32_t priority);
1380 
1392 int sr_module_change_get_order(sr_conn_ctx_t *conn, const char *module_name, sr_datastore_t ds, uint32_t *priority);
1393 
1413 int sr_module_change_subscribe(sr_session_ctx_t *session, const char *module_name, const char *xpath,
1414  sr_module_change_cb callback, void *private_data, uint32_t priority, sr_subscr_options_t opts,
1415  sr_subscription_ctx_t **subscription);
1416 
1428 int sr_module_change_sub_get_info(sr_subscription_ctx_t *subscription, uint32_t sub_id, const char **module_name,
1429  sr_datastore_t *ds, const char **xpath, uint32_t *filtered_out);
1430 
1439 int sr_module_change_sub_modify_xpath(sr_subscription_ctx_t *subscription, uint32_t sub_id, const char *xpath);
1440 
1456 int sr_get_changes_iter(sr_session_ctx_t *session, const char *xpath, sr_change_iter_t **iter);
1457 
1473 int sr_dup_changes_iter(sr_session_ctx_t *session, const char *xpath, sr_change_iter_t **iter);
1474 
1494  sr_val_t **old_value, sr_val_t **new_value);
1495 
1519  const struct lyd_node **node, const char **prev_value, const char **prev_list, int *prev_dflt);
1520 
1527 
1535 const struct lyd_node *sr_get_change_diff(sr_session_ctx_t *session);
1536 
1539 // RPC (Remote Procedure Calls) and Action API
1542 
1563 int sr_rpc_subscribe(sr_session_ctx_t *session, const char *xpath, sr_rpc_cb callback, void *private_data,
1564  uint32_t priority, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription);
1565 
1581 int sr_rpc_subscribe_tree(sr_session_ctx_t *session, const char *xpath, sr_rpc_tree_cb callback,
1582  void *private_data, uint32_t priority, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription);
1583 
1603 int sr_rpc_send(sr_session_ctx_t *session, const char *path, const sr_val_t *input, const size_t input_cnt,
1604  uint32_t timeout_ms, sr_val_t **output, size_t *output_cnt);
1605 
1619 int sr_rpc_send_tree(sr_session_ctx_t *session, struct lyd_node *input, uint32_t timeout_ms, sr_data_t **output);
1620 
1623 // Notifications API
1626 
1649 int sr_notif_subscribe(sr_session_ctx_t *session, const char *module_name, const char *xpath,
1650  const struct timespec *start_time, const struct timespec *stop_time, sr_event_notif_cb callback,
1651  void *private_data, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription);
1652 
1670 int sr_notif_subscribe_tree(sr_session_ctx_t *session, const char *module_name, const char *xpath,
1671  const struct timespec *start_time, const struct timespec *stop_time, sr_event_notif_tree_cb callback,
1672  void *private_data, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription);
1673 
1694 int sr_notif_send(sr_session_ctx_t *session, const char *path, const sr_val_t *values, const size_t values_cnt,
1695  uint32_t timeout_ms, int wait);
1696 
1714 int sr_notif_send_tree(sr_session_ctx_t *session, struct lyd_node *notif, uint32_t timeout_ms, int wait);
1715 
1728 int sr_notif_sub_get_info(sr_subscription_ctx_t *subscription, uint32_t sub_id, const char **module_name,
1729  const char **xpath, struct timespec *start_time, struct timespec *stop_time, uint32_t *filtered_out);
1730 
1740 int sr_notif_sub_modify_xpath(sr_subscription_ctx_t *subscription, uint32_t sub_id, const char *xpath);
1741 
1751 int sr_notif_sub_modify_stop_time(sr_subscription_ctx_t *subscription, uint32_t sub_id, const struct timespec *stop_time);
1752 
1755 // Operational Data API
1758 
1792 int sr_oper_get_subscribe(sr_session_ctx_t *session, const char *module_name, const char *path,
1793  sr_oper_get_items_cb callback, void *private_data, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription);
1794 
1820 int sr_oper_poll_subscribe(sr_session_ctx_t *session, const char *module_name, const char *path, uint32_t valid_ms,
1821  sr_subscr_options_t opts, sr_subscription_ctx_t **subscription);
1822 
1825 // sysrepo-plugind Plugin API
1828 
1839 #define SRP_INIT_CB "sr_plugin_init_cb"
1840 
1846 #define SRP_CLEANUP_CB "sr_plugin_cleanup_cb"
1847 
1859 void srplg_log_errinfo(sr_error_info_t **err_info, const char *plg_name, const char *err_format_name,
1860  sr_error_t err_code, const char *format, ...) _FORMAT_PRINTF(5, 6);
1861 
1873 int srplg_errinfo_push_error_data(sr_error_info_t *err_info, uint32_t size, const void *data);
1874 
1880 void srplg_errinfo_free(sr_error_info_t **err_info);
1881 
1885 #define SRPLG_LOG_ERR(plg_name, ...) srplg_log(plg_name, SR_LL_ERR, __VA_ARGS__)
1886 
1893 #define SRPLG_LOG_WRN(plg_name, ...) srplg_log(plg_name, SR_LL_WRN, __VA_ARGS__)
1894 
1901 #define SRPLG_LOG_INF(plg_name, ...) srplg_log(plg_name, SR_LL_INF, __VA_ARGS__)
1902 
1909 #define SRPLG_LOG_DBG(plg_name, ...) srplg_log(plg_name, SR_LL_DBG, __VA_ARGS__)
1910 
1922 void srplg_log(const char *plg_name, sr_log_level_t ll, const char *format, ...) _FORMAT_PRINTF(3, 4);
1923 
1924 #ifdef __cplusplus
1925 }
1926 #endif
1927 
1928 #endif /* _SYSREPO_H */
int sr_notif_sub_get_info(sr_subscription_ctx_t *subscription, uint32_t sub_id, const char **module_name, const char **xpath, struct timespec *start_time, struct timespec *stop_time, uint32_t *filtered_out)
Get information about an existing notification subscription.
int sr_session_switch_ds(sr_session_ctx_t *session, sr_datastore_t ds)
Change datastore which the session operates on. All subsequent calls will be issued on the chosen dat...
int sr_get_data(sr_session_ctx_t *session, const char *xpath, uint32_t max_depth, uint32_t timeout_ms, const sr_get_options_t opts, sr_data_t **data)
Retrieve a tree whose root nodes match the provided XPath. Data are represented as libyang subtrees...
int sr_discard_changes(sr_session_ctx_t *session)
Discard prepared changes made in the current session.
const char * sr_get_shm_prefix(void)
Get the common SHM file prefix prepended to all SHM files.
const char * sr_strerror(int err_code)
Returns the error message corresponding to the error code.
int sr_subscription_resume(sr_subscription_ctx_t *subscription, uint32_t sub_id)
Resume a previously suspended subscription. Special SR_EV_NOTIF_RESUMED notification is delivered for...
int sr_session_get_error(sr_session_ctx_t *session, const sr_error_info_t **error_info)
Retrieve information about the error that has occurred during the last operation executed within prov...
uint32_t sr_get_options_t
Options overriding default get handling by sr_get_data call, it is supposed to be a bitmask sr_get_op...
int sr_discard_oper_changes(sr_conn_ctx_t *conn, sr_session_ctx_t *session, const char *module_name, uint32_t timeout_ms)
Discard push operational changes of a module for a session.
sr_conn_ctx_t * sr_session_get_connection(sr_session_ctx_t *session)
Get the connection the session was created on.
sr_datastore_t
Datastores that sysrepo supports. To change which datastore a session operates on, use sr_session_switch_ds.
int sr_get_item(sr_session_ctx_t *session, const char *path, uint32_t timeout_ms, sr_val_t **value)
Retrieve a single data element selected by the provided path. Data are represented as sr_val_t struct...
int sr_set_module_ds_access(sr_conn_ctx_t *conn, const char *module_name, int mod_ds, const char *owner, const char *group, mode_t perm)
Change module permissions.
int sr_session_push_error_data(sr_session_ctx_t *session, uint32_t size, const void *data)
Push (add) another chunk of error data for a failed callback communicated back to the originator...
sr_log_level_t sr_log_get_stderr(void)
Learn current standard error output log level.
int sr_get_oper_changes(sr_session_ctx_t *session, const char *module_name, sr_data_t **data)
Get stored push operational changes of a session.
int sr_set_item_str(sr_session_ctx_t *session, const char *path, const char *value, const char *origin, const sr_edit_options_t opts)
Prepare to set (create) the value of a leaf, leaf-list, list, or presence container. These changes are applied only after calling sr_apply_changes(). Data are represented as pairs of a path and string value.
int sr_session_start(sr_conn_ctx_t *conn, const sr_datastore_t datastore, sr_session_ctx_t **session)
Start a new session.
int sr_remove_module(sr_conn_ctx_t *conn, const char *module_name, int force)
Remove an installed module from sysrepo.
int sr_remove_modules(sr_conn_ctx_t *conn, const char **module_names, int force)
Remove installed modules from sysrepo.
void sr_release_data(sr_data_t *data)
Release SR data structure, whoch consists of freeing the data tree, releasing the context...
int sr_session_set_error_format(sr_session_ctx_t *session, const char *error_format)
Deprecated, use sr_session_set_error().
int sr_session_acquire_data(sr_session_ctx_t *session, struct lyd_node *tree, sr_data_t **data)
Acquire libyang data tree together with its context lock in a SR data structure.
uint32_t sr_edit_options_t
Options overriding default behavior of data manipulation calls, it is supposed to be bitwise OR-ed va...
void sr_free_change_iter(sr_change_iter_t *iter)
Frees sr_change_iter_t iterator and all memory allocated within it.
void srplg_errinfo_free(sr_error_info_t **err_info)
Free a superfluous error info.
int sr_notif_send(sr_session_ctx_t *session, const char *path, const sr_val_t *values, const size_t values_cnt, uint32_t timeout_ms, int wait)
Send a notification. Data are represented as sr_val_t structures. In case there are particularly many...
int sr_rpc_send_tree(sr_session_ctx_t *session, struct lyd_node *input, uint32_t timeout_ms, sr_data_t **output)
Send an RPC/action and wait for the result. Data are represented as libyang subtrees.
int sr_discard_items(sr_session_ctx_t *session, const char *xpath)
Prepare to discard nodes matching the specified xpath (or all if not set) previously set by the sessi...
void sr_log_syslog(const char *app_name, sr_log_level_t log_level)
Enables / disables / changes log level (verbosity) of logging to system log.
int sr_get_items(sr_session_ctx_t *session, const char *xpath, uint32_t timeout_ms, const sr_get_options_t opts, sr_val_t **values, size_t *value_cnt)
Retrieve an array of data elements selected by the provided XPath. Data are represented as sr_val_t s...
int sr_session_unsubscribe(sr_session_ctx_t *session)
Unsubscribe all subscriptions created by this session.
int sr_is_module_internal(const struct lys_module *ly_mod)
Check whether a module is an internal libyang or sysrepo module. Evaluates to true for all the module...
sr_error_t
Sysrepo error codes.
Definition: sysrepo_types.h:40
uint32_t sr_subscription_get_last_sub_id(const sr_subscription_ctx_t *subscription)
Get the subscription ID of the last created subscription.
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 e...
void sr_free_val(sr_val_t *value)
Free sr_val_t structure and all memory allocated within it.
Information about a module to be installed.
sr_log_level_t
Log levels used to determine if message of certain severity should be printed.
Definition: sysrepo_types.h:63
void srplg_log(const char *plg_name, sr_log_level_t ll, const char *format,...) _FORMAT_PRINTF(3
int sr_set_item(sr_session_ctx_t *session, const char *path, const sr_val_t *value, const sr_edit_options_t opts)
Prepare to set (create) the value of a leaf, leaf-list, list, or presence container. These changes are applied only after calling sr_apply_changes(). Data are represented as sr_val_t structures.
int sr_module_change_sub_modify_xpath(sr_subscription_ctx_t *subscription, uint32_t sub_id, const char *xpath)
Modify an existing change subscription by changing its XPath filter.
void(* sr_event_notif_tree_cb)(sr_session_ctx_t *session, uint32_t sub_id, const sr_ev_notif_type_t notif_type, const struct lyd_node *notif, struct timespec *timestamp, void *private_data)
Callback to be called for the delivery of a notification. Data are represented as libyang subtrees...
void sr_free_values(sr_val_t *values, size_t count)
Free array of sr_val_t structures (and all memory allocated within of each array element).
void(* sr_event_notif_cb)(sr_session_ctx_t *session, uint32_t sub_id, const sr_ev_notif_type_t notif_type, const char *xpath, const sr_val_t *values, const size_t values_cnt, struct timespec *timestamp, void *private_data)
Callback to be called for the delivery of a notification. Data are represented as sr_val_t structures...
void sr_log_set_cb(sr_log_cb log_callback)
Sets callback that will be called when a log entry would be populated. Callback will be called for ev...
int sr_has_changes(sr_session_ctx_t *session)
Learn whether there are any prepared non-applied changes in the session.
int sr_module_change_get_order(sr_conn_ctx_t *conn, const char *module_name, sr_datastore_t ds, uint32_t *priority)
Get the current global priority of change subscriptions of a module.
uint32_t sr_get_content_id(sr_conn_ctx_t *conn)
Get content ID of the current YANG module set. It conforms to the requirements for ietf-yang-library ...
int sr_set_module_replay_support(sr_conn_ctx_t *conn, const char *module_name, int enable)
Change module replay support.
struct sr_subscription_ctx_s sr_subscription_ctx_t
Sysrepo subscription context returned from sr_*_subscribe calls, it is supposed to be released by the...
int sr_session_dup_error(sr_session_ctx_t *src_session, sr_session_ctx_t *trg_session)
Copy the first error (if any) from a session to a callback session.
struct ly_ctx * sr_session_acquire_context(sr_session_ctx_t *session)
Get the libyang context used by a connection. Can be used in an application for working with data and...
void sr_session_release_context(sr_session_ctx_t *session)
Release libyang context obtained from a session/connection.
int sr_get_oper_changes_order(sr_session_ctx_t *session, const char *module_name, uint32_t *order)
Get push operational changes order determining when they are applied relative to other sessions for t...
public sysrepo types header
struct lyd_node * sr_get_changes(sr_session_ctx_t *session)
Retrieve stored changes (prepared, not yet applied).
Custom datastore implementation config for each datastore and notifications of a module.
int sr_unsubscribe_sub(sr_subscription_ctx_t *subscription, uint32_t sub_id)
Unsubscribe a specific or all the subscriptions in a subscription structure.
int sr_session_get_orig_data(sr_session_ctx_t *session, uint32_t idx, uint32_t *size, const void **data)
Get a specific chunk of event originator data in a callback.
int sr_update_modules(sr_conn_ctx_t *conn, const char **schema_paths, const char *search_dirs)
Update installed schemas (modules) to new revisions in a batch.
int sr_update_module(sr_conn_ctx_t *conn, const char *schema_path, const char *search_dirs)
Update an installed schema (module) to a new revision.
int sr_notif_sub_modify_xpath(sr_subscription_ctx_t *subscription, uint32_t sub_id, const char *xpath)
Modify an existing notification subscription by changing its XPath filter. Special SR_EV_NOTIF_MODIFI...
uint32_t sr_conn_options_t
Options overriding default connection handling by sr_connect call, it is supposed to be bitwise OR-ed...
int sr_delete_item(sr_session_ctx_t *session, const char *path, const sr_edit_options_t opts)
Prepare to delete the nodes matching the specified xpath. These changes are applied only after callin...
int sr_unsubscribe(sr_subscription_ctx_t *subscription)
Unsubscribe all the subscriptions in a subscription structure and free it.
struct lyd_node * sr_get_change_diff(sr_session_ctx_t *session)
Get the changes directly in the form of a diff in module-change callbacks. It cannot be used outside ...
Detailed sysrepo session error information.
int sr_dup_changes_iter(sr_session_ctx_t *session, const char *xpath, sr_change_iter_t **iter)
Create an iterator for retrieving the changes (list of newly added / removed / modified nodes) in mod...
int sr_get_plugins(sr_conn_ctx_t *conn, const char ***ds_plugins, const char ***ntf_plugins)
Get loaded plugins of a connection.
int sr_oper_get_subscribe(sr_session_ctx_t *session, const char *module_name, const char *path, sr_oper_get_items_cb callback, void *private_data, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Register for providing operational data at the given path.
const char * sr_get_repo_path(void)
Get the path (directory) for all persistent sysrepo files.
int(* sr_rpc_cb)(sr_session_ctx_t *session, uint32_t sub_id, const char *xpath, const sr_val_t *input, const size_t input_cnt, sr_event_t event, uint32_t request_id, sr_val_t **output, size_t *output_cnt, void *private_data)
Callback to be called for the delivery of an RPC/action. Data are represented as sr_val_t structures...
int sr_set_oper_changes_order(sr_session_ctx_t *session, const char *module_name, uint32_t order)
Set explicit push operational changes order determining when they are applied relative to other sessi...
int sr_install_module(sr_conn_ctx_t *conn, const char *schema_path, const char *search_dirs, const char **features)
Install a new schema (module) into sysrepo.
int sr_session_set_error(sr_session_ctx_t *session, const char *err_format_name, sr_error_t err_code, const char *err_msg_format,...)
Set an error for a failed callback communicated back to the originator. Does not print the message...
void sr_log_stderr(sr_log_level_t log_level)
Enables / disables / changes log level (verbosity) of logging to standard error output.
struct sr_session_ctx_s sr_session_ctx_t
Sysrepo session on a connection.
Definition: sysrepo_types.h:99
void sr_session_del_orig_data(sr_session_ctx_t *session)
Remove all pushed event originator data.
int sr_session_notif_buffer(sr_session_ctx_t *session)
Use notification buffering for the session.
int(* sr_module_change_cb)(sr_session_ctx_t *session, uint32_t sub_id, const char *module_name, const char *xpath, sr_event_t event, uint32_t request_id, void *private_data)
Callback to be called on the event of changing datastore content of the specified module...
int sr_get_subtree(sr_session_ctx_t *session, const char *path, uint32_t timeout_ms, sr_data_t **subtree)
Retrieve a single subtree whose root node is selected by the provided path. Data are represented as l...
int sr_get_node(sr_session_ctx_t *session, const char *path, uint32_t timeout_ms, sr_data_t **node)
Retrieve a single value matching the provided XPath. Data are represented as a single libyang node...
A single, detailed error message. Used in sr_error_info_t.
int sr_notif_subscribe_tree(sr_session_ctx_t *session, const char *module_name, const char *xpath, const struct timespec *start_time, const struct timespec *stop_time, sr_event_notif_tree_cb callback, void *private_data, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Subscribes for the delivery of a notification(s). Data are represented as libyang subtrees...
struct sr_conn_ctx_s sr_conn_ctx_t
Sysrepo connection.
Definition: sysrepo_types.h:89
int sr_rpc_send(sr_session_ctx_t *session, const char *path, const sr_val_t *input, const size_t input_cnt, uint32_t timeout_ms, sr_val_t **output, size_t *output_cnt)
Send an RPC/action and wait for the result. Data are represented as sr_val_t structures.
void sr_release_context(sr_conn_ctx_t *conn)
Release libyang context obtained from a session/connection.
int sr_get_module_ds_access(sr_conn_ctx_t *conn, const char *module_name, int mod_ds, char **owner, char **group, mode_t *perm)
Learn about module permissions.
int sr_oper_poll_subscribe(sr_session_ctx_t *session, const char *module_name, const char *path, uint32_t valid_ms, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Start periodic retrieval and caching of operational data at the given path.
int sr_install_module2(sr_conn_ctx_t *conn, const char *schema_path, const char *search_dirs, const char **features, const sr_module_ds_t *module_ds, const char *owner, const char *group, mode_t perm, const char *data, const char *data_path, LYD_FORMAT format)
Install a new schema (module) into sysrepo with all the available options.
sr_datastore_t sr_session_get_ds(sr_session_ctx_t *session)
Learn the datastore a session operates on.
int sr_unlock(sr_session_ctx_t *session, const char *module_name)
Unlocks the data of the specified module or the whole datastore.
struct sr_change_iter_s sr_change_iter_t
Iterator used for retrieval of a changeset using sr_get_changes_iter call.
int(* sr_rpc_tree_cb)(sr_session_ctx_t *session, uint32_t sub_id, const char *op_path, const struct lyd_node *input, sr_event_t event, uint32_t request_id, struct lyd_node *output, void *private_data)
Callback to be called for the delivery of an RPC/action. Data are represented as libyang subtrees...
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.
int sr_copy_config(sr_session_ctx_t *session, const char *module_name, sr_datastore_t src_datastore, uint32_t timeout_ms)
Replaces a conventional datastore with the contents of another conventional datastore. If the module is specified, limits the operation only to the specified module. If it is not specified, the operation is performed on all modules.
sr_change_oper_t
Type of the operation made on an item, used by changeset retrieval in sr_get_change_next.
int sr_notif_send_tree(sr_session_ctx_t *session, struct lyd_node *notif, uint32_t timeout_ms, int wait)
Send a notification. Data are represented as libyang subtrees. In case there are particularly many no...
const char * sr_session_get_orig_name(sr_session_ctx_t *session)
Get event originator name.
uint32_t sr_session_get_id(sr_session_ctx_t *session)
Return the assigned session ID of the sysrepo session.
int sr_validate(sr_session_ctx_t *session, const char *module_name, uint32_t timeout_ms)
Perform the validation a datastore and any changes made in the current session, but do not apply nor ...
const char * sr_session_get_user(sr_session_ctx_t *session)
Get the effective user of a session.
void(* sr_log_cb)(sr_log_level_t level, const char *message)
Sets callback that will be called when a log entry would be populated.
Definition: sysrepo_types.h:77
int sr_get_module_replay_support(sr_conn_ctx_t *conn, const char *module_name, struct timespec *earliest_notif, int *enabled)
Learn replay support of a module.
int sr_subscription_suspend(sr_subscription_ctx_t *subscription, uint32_t sub_id)
Suspend a specific subscription. Special SR_EV_NOTIF_SUSPENDED notification is delivered for suspende...
int sr_module_change_subscribe(sr_session_ctx_t *session, const char *module_name, const char *xpath, sr_module_change_cb callback, void *private_data, uint32_t priority, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Subscribe for changes made in the specified module.
int sr_get_error_data(const sr_error_info_err_t *err, uint32_t idx, uint32_t *size, const void **data)
Get a specific chunk of error data.
int sr_oper_delete_item_str(sr_session_ctx_t *session, const char *path, const char *value, const sr_edit_options_t opts)
Deprecated, not supported.
int sr_session_stop(sr_session_ctx_t *session)
Stop the session and releases resources tied to it.
int(* sr_oper_get_items_cb)(sr_session_ctx_t *session, uint32_t sub_id, const char *module_name, const char *path, const char *request_xpath, uint32_t request_id, struct lyd_node **parent, void *private_data)
Callback to be called when operational data at the selected xpath are requested. Data are represented...
int sr_get_changes_iter(sr_session_ctx_t *session, const char *xpath, sr_change_iter_t **iter)
Create an iterator for retrieving the changes (list of newly added / removed / modified nodes) in mod...
int sr_session_push_orig_data(sr_session_ctx_t *session, uint32_t size, const void *data)
Push (add) another chunk of event originator data used for all events sent on this session...
int sr_rpc_subscribe(sr_session_ctx_t *session, const char *xpath, sr_rpc_cb callback, void *private_data, uint32_t priority, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Subscribe for the delivery of an RPC/action. Data are represented as sr_val_t structures.
int sr_get_change_tree_next(sr_session_ctx_t *session, sr_change_iter_t *iter, sr_change_oper_t *operation, const struct lyd_node **node, const char **prev_value, const char **prev_list, int *prev_dflt)
Returns the next change from the provided iterator created by sr_get_changes_iter call...
int sr_subscription_process_events(sr_subscription_ctx_t *subscription, sr_session_ctx_t *session, struct timespec *wake_up_in)
Process any pending new events on a subscription. Should not be called unless SR_SUBSCR_NO_THREAD fla...
int sr_lock(sr_session_ctx_t *session, const char *module_name, uint32_t timeout_ms)
Locks the data of the specified module or the whole datastore.
int sr_subscription_get_suspended(sr_subscription_ctx_t *subscription, uint32_t sub_id, int *suspended)
Learn the suspend state of a specific subscription.
int sr_rpc_subscribe_tree(sr_session_ctx_t *session, const char *xpath, sr_rpc_tree_cb callback, void *private_data, uint32_t priority, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Subscribe for the delivery of an RPC/action. Data are represented as libyang subtrees.
int sr_enable_module_feature(sr_conn_ctx_t *conn, const char *module_name, const char *feature_name)
Enable a module feature.
int sr_session_set_orig_name(sr_session_ctx_t *session, const char *orig_name)
Set event originator name used for all events sent on this session. It can then be read from the impl...
int sr_notif_subscribe(sr_session_ctx_t *session, const char *module_name, const char *xpath, const struct timespec *start_time, const struct timespec *stop_time, sr_event_notif_cb callback, void *private_data, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Subscribe for the delivery of a notification(s). Data are represented as sr_val_t structures...
const char * sr_get_shm_path(void)
Get the path (directory) for all volatile sysrepo files, created as SHM files.
int sr_module_change_sub_get_info(sr_subscription_ctx_t *subscription, uint32_t sub_id, const char **module_name, sr_datastore_t *ds, const char **xpath, uint32_t *filtered_out)
Get information about an existing change subscription.
int sr_get_event_pipe(sr_subscription_ctx_t *subscription, int *event_pipe)
Get the event pipe of a subscription. Do not call unless SR_SUBSCR_NO_THREAD flag was used when subsc...
int sr_apply_changes(sr_session_ctx_t *session, uint32_t timeout_ms)
Apply changes made in the current session. In case the changes could not be applied successfully for ...
int sr_check_module_ds_access(sr_conn_ctx_t *conn, const char *module_name, int mod_ds, int *read, int *write)
Check whether the current application has read/write access to a module.
int sr_move_item(sr_session_ctx_t *session, const char *path, const sr_move_position_t position, const char *list_keys, const char *leaflist_value, const char *origin, const sr_edit_options_t opts)
Prepare to move/create the instance of an user-ordered list or leaf-list to the specified position...
uint32_t sr_subscr_options_t
Options overriding default behavior of subscriptions, it is supposed to be a bitwise OR-ed value of a...
int sr_subscription_thread_resume(sr_subscription_ctx_t *subscription)
Resume the default handler thread of a subscription structure that was suspended previously.
int sr_get_lock(sr_conn_ctx_t *conn, sr_datastore_t datastore, const char *module_name, int *is_locked, uint32_t *id, struct timespec *timestamp)
Check whether the data of the specified module or the whole datastore are locked. ...
sr_move_position_t
Options for specifying move direction of sr_move_item call.
int sr_session_set_user(sr_session_ctx_t *session, const char *user)
Set the effective user of a session to a different one than the process owner.
int sr_session_set_error_message(sr_session_ctx_t *session, const char *format,...)
Deprecated, use sr_session_set_error().
int sr_edit_batch(sr_session_ctx_t *session, const struct lyd_node *edit, const char *default_operation)
Provide a prepared edit data tree to be applied. These changes are applied only after calling sr_appl...
struct ly_ctx * sr_acquire_context(sr_conn_ctx_t *conn)
Get the libyang context used by a connection. Can be used in an application for working with data and...
int sr_acquire_data(sr_conn_ctx_t *conn, struct lyd_node *tree, sr_data_t **data)
Acquire libyang data tree together with its context lock in a SR data structure.
int sr_disable_module_feature(sr_conn_ctx_t *conn, const char *module_name, const char *feature_name)
Disable a module feature.
int sr_module_change_set_order(sr_conn_ctx_t *conn, const char *module_name, sr_datastore_t ds, uint32_t priority)
Change the global priority of modules being notified about their changes. The default priority of eve...
int sr_subscription_thread_suspend(sr_subscription_ctx_t *subscription)
Suspend the default handler thread of a subscription structure. Meaning it will stop handling any eve...
int sr_replace_config(sr_session_ctx_t *session, const char *module_name, struct lyd_node *src_config, uint32_t timeout_ms)
Replace a datastore with the contents of a data tree. If the module is specified, limit the operation...
const sr_module_ds_t * sr_get_module_ds_default(void)
Get the default datastore plugins.
int sr_notif_sub_modify_stop_time(sr_subscription_ctx_t *subscription, uint32_t sub_id, const struct timespec *stop_time)
Modify an existing notification subscription by changing its stop time. Special SR_EV_NOTIF_MODIFIED ...
int sr_connect(const sr_conn_options_t opts, sr_conn_ctx_t **conn)
Connects to the sysrepo datastore.
int sr_install_modules2(sr_conn_ctx_t *conn, const sr_install_mod_t *modules, uint32_t module_count, const char *search_dirs, const char *data, const char *data_path, LYD_FORMAT format)
Install new schemas (modules) into sysrepo in a batch with all the available options.
int sr_disconnect(sr_conn_ctx_t *conn)
Disconnect from the sysrepo datastore.
int sr_get_module_info(sr_conn_ctx_t *conn, sr_data_t **sysrepo_data)
Get internal sysrepo data tree, which holds detailed information about installed modules. It should not be needed except for some specific use-cases. These data are from the sysrepo module found in modules/sysrepo.yang.
Structure that safely wraps libyang data and prevents unexpected context changes. ...
int sr_install_modules(sr_conn_ctx_t *conn, const char **schema_paths, const char *search_dirs, const char ***features)
Install new schemas (modules) into sysrepo in a batch.
sr_log_level_t sr_log_get_syslog(void)
Learn current system log log level.
uid_t sr_get_su_uid(void)
Get the sysrepo SUPERUSER UID.
int sr_get_change_next(sr_session_ctx_t *session, sr_change_iter_t *iter, sr_change_oper_t *operation, sr_val_t **old_value, sr_val_t **new_value)
Return the next change from the provided iterator created by sr_get_changes_iter call. Data are represented as sr_val_t structures.
Structure that contains value of an data element stored in the sysrepo datastore. ...