sid_dict.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_sid_dict
#define _H_sid_dict
 
#ifdef WITH_YANG_CBOR
/*  FILE: sid_dict.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
27-sep-15    abb      Begun; start from ydump.c
 
*/
 
/*** assumes procdefs.h has been included ***/
 
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_xml_msg
#include "xml_msg.h"
#endif
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#define SID_DICT_SERVER  1
 
#define SID_DICT_FIRST   2
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
 
 
typedef boolean (*sid_dict_walk_cbfn_t) (ncx_sid_t sid,
                                         ncx_sid_ns_t  sid_ns,
                                         const xmlChar *identifier,
                                         boolean is_obsolete,
                                         uint8 sid_flags,
                                         void *cookie);
 
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
/* Group defined in obj.h */
 
 
extern status_t
    sid_dict_init (void);
 
 
extern status_t
    sid_dict_init_write (void);
 
 
 
extern void
    sid_dict_cleanup (void);
 
 
extern void
    sid_dict_cleanup_write (void);
 
 
extern status_t
    sid_dict_add_data (uint32 id,
                       obj_template_t *obj,
                       boolean internal);
 
 
extern boolean
    sid_dict_remove_data (uint32 id,
                          obj_template_t *obj);
 
 
extern status_t
    sid_dict_find_data (uint32 id,
                        ncx_sid_t sid,
                        obj_template_t **obj);
 
 
extern status_t
    sid_dict_add_module (uint32 id,
                         ncx_module_t *mod,
                         boolean internal);
 
 
extern boolean
    sid_dict_remove_module (uint32 id,
                            ncx_module_t *mod);
 
 
extern status_t
    sid_dict_find_module (uint32 id,
                          ncx_sid_t sid,
                          ncx_module_t **mod);
 
 
extern status_t
    sid_dict_add_identity (uint32 id,
                           ncx_identity_t *ident,
                           boolean internal);
 
 
extern boolean
    sid_dict_remove_identity (uint32 id,
                              ncx_identity_t *ident);
 
 
extern status_t
    sid_dict_find_identity (uint32 id,
                            ncx_sid_t sid,
                            ncx_identity_t **ident);
 
 
extern status_t
    sid_dict_add_feature (uint32 id,
                          ncx_feature_t *feat,
                          boolean internal);
 
 
extern boolean
    sid_dict_remove_feature (uint32 id,
                             ncx_feature_t *feat);
 
 
extern status_t
    sid_dict_find_feature (uint32 id,
                           ncx_sid_t sid,
                           ncx_feature_t **feat);
 
 
extern status_t
    sid_dict_add_module_write (ncx_module_t *mod,
                               uint32 *retcnt);
 
 
extern status_t
    sid_dict_walk_module_write (sid_dict_walk_cbfn_t cbfn,
                                void *cookie);
 
 
extern status_t
    sid_dict_walk_tree (uint32 id,
                        sid_dict_walk_cbfn_t cbfn,
                        void *cookie);
 
 
extern void
    sid_dict_dump (uint32 id);
 
 
 
extern void
    sid_dict_write_dump (void);
 
 
extern void
    sid_dict_xml_wr (ses_cb_t *scb,
                     xml_msg_hdr_t *mhdr,
                     obj_template_t *obj,
                     boolean external_only,
                     xmlns_id_t parent_nsid,
                     ncx_sid_t start_sid,
                     ncx_sid_t stop_sid,
                     int32 indent);
 
 
extern ncx_sid_t
    sid_dict_highest (void);
 
 
extern uint32
    sid_dict_count (void);
 
 
extern status_t
    sid_dict_new (uint32 *id);
 
 
extern void
    sid_dict_free (uint32 id);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif  // WITH_YANG_CBOR
#endif      /* _H_sid_dict */