sid_file.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 - 2025, 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_file
#define _H_sid_file
 
#ifdef WITH_YANG_CBOR
 
/*  FILE: sid_file.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
26-nov-21    abb      Begun; start from yang_hash.c
 
*/
 
#include "status_enum.h"
#include "obj.h"
 
/*** assumes procdefs.h has been included ***/
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
/* Group definied in yang.h */
 
 
extern status_t sid_file_init (void);
 
 
extern void sid_file_cleanup (void);
 
 
extern val_value_t *
    sid_file_load (ncx_module_t *mod,
                   status_t *res);
 
 
extern val_value_t *
    sid_file_load_update (ncx_module_t *mod,
                          const xmlChar *parmstr,
                          boolean is_date,
                          status_t *res);
 
 
extern status_t
    sid_file_apply (uint32 sid_tree_id,
                    val_value_t *sidfile,
                    ncx_module_t *mod,
                    boolean internal,
                    boolean update_mode);
 
 
extern obj_template_t *
    sid_file_get_obj (void);
 
 
extern status_t
    sid_file_get_ranges (val_value_t *sidfile,
                         dlq_hdr_t *sid_rangeQ,
                         uint32 *total);
 
 
 
extern status_t
    sid_file_add_range (ncx_sid_t range_start,
                        uint32 range_size,
                        dlq_hdr_t *sid_rangeQ);
 
 
 
extern status_t
    sid_file_check_ranges (ncx_sid_t sid,
                           dlq_hdr_t *sid_rangeQ,
                           boolean set_highest,
                           ncx_sid_range_t **ret_range);
 
 
 
extern status_t
    sid_file_verify_ranges (dlq_hdr_t *sid_rangeQ);
 
 
#endif  // WITH_YANG_CBOR
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_sid_file */