rpc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 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_rpc
#define _H_rpc
/*  FILE: rpc.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************
 
date             init     comment
----------------------------------------------------------------------
01-may-05    abb      Begun.
*/
 
#include <time.h>
#include <xmlstring.h>
 
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_op
#include "op.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_xmlns
#include "xmlns.h"
#endif
 
#ifndef _H_xml_msg
#include "xml_msg.h"
#endif
 
#ifndef _H_xml_util
#include "xml_util.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                         C O N S T A N T S                         *
*                                                                   *
*********************************************************************/
#define RPC_STR_REQ     "rpc"
#define RPC_STR_RPY     "rpc-reply"
#define RPC_STR_ERR     "rpc-error"
#define RPC_STR_MSG_ID  "message-id"
#define RPC_STR_GRP_ID  "group-id"
 
#define RPC_MHDR(MSG) &(MSG)->mhdr
 
#define RPC_ERR_QUEUE(MSG) &(MSG)->mhdr.errQ
 
#define RPC_MSG_SET_REPLAY(MSG) (MSG)->rpc_replay_config = true
 
#define RPC_MSG_IS_REPLAY(MSG) (MSG)->rpc_replay_config
 
#define RPC_MSG_ID(MSG) (MSG)->rpc_message_id
 
#define RPC_MSG_SIL_SA_CB(MSG) (MSG)->rpc_sil_sa_cb
 
#define RPC_MSG_TXCB(MSG) (MSG)->rpc_txcb
 
#define RPC_MSG_GETBULK(MSG) (MSG)->mhdr.getbulk_cb
 
#define RPC_MSG_SET_WITH_TEMPLATE(MSG) (MSG)->rpc_with_template = true
 
#define RPC_MSG_IS_WITH_TEMPLATE(MSG) (MSG)->rpc_with_template
 
#define RPC_MSG_METHOD(MSG) (MSG)->rpc_method
 
#define RPC_SET_DEFER_REPLY(MSG) (MSG)->rpc_defer_reply = TRUE
 
#define RPC_IS_DEFER_REPLY(MSG) ((MSG)->rpc_defer_reply)
 
/* yp-gnmi control block. Used in restconf processing code */
#define RPC_MSG_YPGNMI_GETCB(MSG) (MSG)->mhdr.gnmi_getcb
 
/* yp-gnmi control block. Used in restconf processing code */
#define RPC_MSG_YPGNMI_EDITCB(MSG) (MSG)->mhdr.gnmi_editcb
 
#define RPC_MSG_REPLY_TYPE(MSG) (MSG)->rpc_reply_type
 
#define RPC_MSG_STATUS(MSG) (MSG)->rpc_status
 
#define RPC_MSG_START_TIME(MSG) (MSG)->rpc_start_time
 
#define RPC_MSG_SUBRPC_FILESPEC(MSG) (MSG)->subrpc_filespec
 
#define RPC_MSG_USER1(MSG) (MSG)->rpc_user1
 
#define RPC_MSG_USER2(MSG) (MSG)->rpc_user2
 
#define RPC_MSG_DATA_TYPE(MSG) (MSG)->rpc_data_type
 
#define RPC_MSG_DATACB(MSG) (MSG)->rpc_datacb
 
 
/********************************************************************
*                                                                   *
*                             T Y P E S                             *
*                                                                   *
*********************************************************************/
 
typedef enum rpc_data_t_ {
    RPC_DATA_NONE,   
    RPC_DATA_STD,
 
    RPC_DATA_YANG
} rpc_data_t;
 
 
typedef enum rpc_rpytyp_t_ {
    RPC_RPYTYP_NONE,     
    RPC_RPYTYP_OK,       
    RPC_RPYTYP_ERROR,    
    RPC_RPYTYP_DATA,     
} rpc_rpytyp_t;
 
 
typedef struct rpc_msg_t_ {
    dlq_hdr_t        qhdr;
 
    xml_msg_hdr_t    mhdr;
 
    xml_attrs_t     *rpc_in_attrs;     /* borrowed from <rpc> elem */
 
    struct obj_template_t_ *rpc_method;
 
    int              rpc_agt_state;
 
    op_errop_t       rpc_err_option;
 
    op_editop_t      rpc_top_editop;
 
    val_value_t     *rpc_input;
 
    struct sil_sa_cb_t_ *rpc_sil_sa_cb;
 
    dlq_hdr_t        rpc_inputQ;     
    void           *rpc_user1;
 
    void           *rpc_user2;
 
    uint32          rpc_returncode;
 
    rpc_data_t      rpc_data_type;
 
    void           *rpc_datacb;
 
    dlq_hdr_t       rpc_dataQ;
 
    op_filter_t     rpc_filter;
 
    struct agt_cfg_transaction_t_ *rpc_txcb;
 
    boolean         rpc_parse_errors;
 
    xmlChar        *rpc_message_id;
 
    xmlChar        *rpc_trace_id;
 
    boolean         rpc_replay_config;
 
    boolean         rpc_with_template;
 
    dlq_hdr_t     hook_inputQ;
 
    boolean       rpc_defer_reply;
 
    xml_attrs_t   rpc_defer_in_attrs;
 
    rpc_rpytyp_t rpc_reply_type;
 
    status_t     rpc_status;
 
    time_t       rpc_start_time;
 
    const xmlChar *subrpc_filespec;
 
} rpc_msg_t;
 
 
/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/
 
 
extern rpc_msg_t *
    rpc_new_msg (void);
 
 
extern rpc_msg_t *
    rpc_new_out_msg (void);
 
 
extern void
    rpc_free_msg (rpc_msg_t *msg);
 
 
extern void rpc_msg_add_error_data (rpc_msg_t *msg,
                                    val_value_t *val);
 
 
extern const xmlChar *
    rpc_msg_get_reply_type (rpc_rpytyp_t rpytyp);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif            /* _H_rpc */