getbulk.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 - 2024, 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_getbulk
#define _H_getbulk
 
/*  FILE: getbulk.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
#include <xmlstring.h>
 
#include "dlq.h"
#include "ncxtypes.h"
#include "status_enum.h"
#include "val.h"
#include "yangapi.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
 
typedef struct getbulk_cb_t_ {
 
    struct cfg_template_t_ *source_cfg;
 
    xmlChar *list_target;
 
    struct obj_template_t_ *target_obj;
 
    uint32 count;
 
    restconf_content_t content_enum;
 
    uint32 ret_count;
 
    /* depth parameter set directly in xml_msg_hdr */
    //uint16 depth;
 
    /* withdef parameter set directly in xml_msg_hdr */
    //ncx_withdefaults_t  withdef;
 
    int32 start_indent;
 
    val_value_t *last_keys;
 
    val_value_t *list_test_val;
 
    val_value_t *fixed_keys;
 
    obj_template_t *last_keys_obj;
 
    val_value_t *last_entry;
 
    val_value_t *ret_last_keys;
 
} getbulk_cb_t;
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
extern getbulk_cb_t *
    getbulk_new_cb (void);
 
 
extern void
    getbulk_free_cb (getbulk_cb_t *cb);
 
 
extern status_t
    getbulk_check_get2 (getbulk_cb_t *bulk,
                        obj_template_t *obj,
                        uint32 *max_entries,
                        val_value_t **last_entry);
 
 
extern boolean
    getbulk_with_get2 (getbulk_cb_t *bulk,
                       obj_template_t *obj);
 
 
extern status_t
    getbulk_create_last_keys (getbulk_cb_t *bulk,
                              val_value_t *lastval);
 
 
extern status_t
    getbulk_create_last_keys_get2 (getbulk_cb_t *bulk,
                                   dlq_hdr_t *keyQ);
 
 
#ifdef __cplusplus
} /* end extern 'C' */
#endif
 
#endif