diff options
author | mhemmatp <mhemmatp@cisco.com> | 2019-12-12 16:05:13 +0100 |
---|---|---|
committer | mhemmatp <mhemmatp@cisco.com> | 2019-12-12 17:09:06 +0100 |
commit | a0f325f0b6ca0129ed339ac4ac94d7159e926977 (patch) | |
tree | 81e6b447bc44d418c6625fdf66c03a42096476d2 /ctrl/sysrepo-plugins/hicn-plugin/plugin/hicn_plugin.h | |
parent | 02be1b9403b12c03fc4c03ef872fb71ec37b2c1c (diff) |
[HICN-440] Add comments to hicn sysrepo plugin code
Signed-off-by: mhemmatp <mhemmatp@cisco.com>
Change-Id: I0ed0c5b0b9cd7714b46867e4d4fe0324945cf418
Diffstat (limited to 'ctrl/sysrepo-plugins/hicn-plugin/plugin/hicn_plugin.h')
-rw-r--r-- | ctrl/sysrepo-plugins/hicn-plugin/plugin/hicn_plugin.h | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/ctrl/sysrepo-plugins/hicn-plugin/plugin/hicn_plugin.h b/ctrl/sysrepo-plugins/hicn-plugin/plugin/hicn_plugin.h index 4e48c8c29..0890c3f03 100644 --- a/ctrl/sysrepo-plugins/hicn-plugin/plugin/hicn_plugin.h +++ b/ctrl/sysrepo-plugins/hicn-plugin/plugin/hicn_plugin.h @@ -13,13 +13,34 @@ * limitations under the License. */ +/** + * @file hicn_plugin.h + * @brief This file contains init and cleanup for the sysrepo. + */ + #ifndef __HICN_PLUGIN_H__ #define __HICN_PLUGIN_H__ #include "hicn_vpp_comm.h" -// functions that sysrepo-plugin need + +/** + * @brief initialize function for sysrepo plugin, + * In this function we connect to vpp from one side + * and subscribe for all hICN events as well as interface events (if any) + * @param session pointer to the sesssion context + * @param private_ctx pointer to the context + * @return in success the function returns SR_ERR_OK otherwise it pass error + */ int sr_plugin_init_cb(sr_session_ctx_t *session, void **private_ctx); + +/** + * @brief cleanup function for sysrepo, + * In this function we connect to vpp from one side + * and and unsubscribe for all hICN events as well as interface events (if any) + * @param session pointer to the sesssion context + * @param private_ctx pointer to the context + */ void sr_plugin_cleanup_cb(sr_session_ctx_t *session, void *private_ctx); #endif //__HICN_PLUGIN_H__
\ No newline at end of file |