ypgnmi.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 - 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.
 *
 */
#if defined(WITH_GNMI) && defined(WITH_RESTCONF) && defined(WITH_YCONTROL)
 
#ifndef _H_ypgnmi
#define _H_ypgnmi
 
/*  FILE: ypgnmi.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-JUNE-18    am      Begun
*/
 
#include <xmlstring.h>
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_yangapi
#include "yangapi.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                                                   *
*                T Y P E S                                          *
*                                                                   *
*********************************************************************/
 
typedef struct ypgnmi_get_cb_t_ {
 
    xmlChar         *prefix_str;
 
    xmlChar         *path_str;
 
    restconf_content_t content_enum;
 
    obj_template_t  *target_obj;
 
    val_value_t     *request_target;
 
} ypgnmi_get_cb_t;
 
 
typedef struct ypgnmi_edit_t_ {
 
    /* queue header in case added to a queue */
    dlq_hdr_t        qhdr;
 
    xmlChar         *path_str;
 
    xmlChar         *input;
 
    op_editop_t      editop;
 
    status_t         res;
 
    const xmlChar         *error_details;
 
    obj_template_t  *target_obj;
 
    val_value_t     *value;
} ypgnmi_edit_t;
 
 
typedef struct ypgnmi_edit_cb_t_ {
    dlq_hdr_t        editsQ;
 
    xmlChar         *prefix_str;
 
} ypgnmi_edit_cb_t;
 
 
/********************************************************************
*                                                                   *
*           F U N C T I O N S                                       *
*                                                                   *
*********************************************************************/
 
 
extern ypgnmi_get_cb_t *
    ypgnmi_new_gcb (void);
 
 
extern void
    ypgnmi_free_gcb (ypgnmi_get_cb_t *cb);
 
 
extern ypgnmi_edit_t *
    get_first_edit_entry (ypgnmi_edit_cb_t *cb);
 
 
extern ypgnmi_edit_t *
    get_next_edit_entry (ypgnmi_edit_t *entry);
 
 
extern ypgnmi_edit_t *
    ypgnmi_new_edit (xmlChar *path_str,
                     xmlChar *input,
                     op_editop_t editop);
 
 
extern void
    ypgnmi_free_edit (ypgnmi_edit_t *entry);
 
 
extern ypgnmi_edit_cb_t *
    ypgnmi_new_ecb (void);
 
 
extern void
    ypgnmi_free_ecb (ypgnmi_edit_cb_t *cb);
 
 
extern void
    ypgnmi_set_edit_status (rpc_msg_t *msg,
                            const xmlChar *edit_id,
                            status_t res);
 
 
extern boolean
    ypgnmi_check_edits_status (ypgnmi_edit_cb_t *ecb);
 
 
#ifdef __cplusplus
} /* end extern 'C' */
#endif
 
#endif      /* _H_ypgnmi */
#endif   // WITH_GNMI && WITH_RESTCONF && WITH_YCONTROL