yumapro  20.10-12
YumaPro SDK
rpc_msg_t_ Struct Reference

NETCONF Server and Client RPC Request/Reply Message Header. More...

#include <rpc.h>

Collaboration diagram for rpc_msg_t_:

Data Fields

dlq_hdr_t qhdr
 queue header
 
xml_msg_hdr_t mhdr
 generic XML message header Most in-message state is kept in the mhdr There are several places in the code where the mhdr is used alone so there is no coupling to the RPC layer
 
xml_attrs_trpc_in_attrs
 incoming: top-level rpc element data
 
struct obj_template_t_rpc_method
 incoming: 2nd-level method name element data, used in agt_output_filter to check get or get-config; cannot import obj.h here! The object template type will be OBJ_TYP_RPC for an RPC method For an action this will be the top-level <action> RPC wrapper in the YANG namespace
 
int rpc_agt_state
 incoming: SERVER RPC processing state More...
 
op_errop_t rpc_err_option
 error option
 
op_editop_t rpc_top_editop
 for edit-config
 
val_value_t * rpc_input
 for an action, the rpc_input node is not used; Instead the rpc_actionval backptr is used instead
 
struct sil_sa_cb_t_rpc_sil_sa_cb
 backptr to SIL-SA edit control block if WITH_YCONTROL=1
 
dlq_hdr_t rpc_inputQ
 the rpc_inputQ is used with JSON encoded input since an array is allowed at the top-level; it is used instead of rpc_input if encoding == JSON, even if only 1 array node is parsed; More...
 
void * rpc_user1
 incoming: hooks for method routines to save context or whatever hack: transfer pointers from validate to invoke so data does not need to be regenerated or retrieved
 
void * rpc_user2
 2nd user pointer
 
uint32 rpc_returncode
 for nested callbacks
 
rpc_data_t rpc_data_type
 incoming: get method reply handling builtin If the rpc_datacb is non-NULL then it will be used as a callback to generate the rpc-reply inline, instead of buffering the output. More...
 
void * rpc_datacb
 agt_rpc_data_cb_t
 
dlq_hdr_t rpc_dataQ
 data reply: Q of val_value_t
 
op_filter_t rpc_filter
 backptrs for get* methods
 
struct agt_cfg_transaction_t_rpc_txcb
 incoming: agent database edit transaction control block must be freed by an upper layer if set to malloced data
 
boolean rpc_parse_errors
 load-config parse-error and –startup-error=continue flag if the val_purge_errors_from_root function is needed
 
xmlChar * rpc_message_id
 debugging and audit message strings More...
 
xmlChar * rpc_trace_id
 backptr into rpc_in_attrs
 
boolean rpc_replay_config
 replay config mode
 
boolean rpc_with_template
 –with-template parameter was seen in the validate phase
 
dlq_hdr_t hook_inputQ
 points to add_edit_value node comming from the users freed in the end of transaction. More...
 
boolean rpc_defer_reply
 YPSERVER mode is skipping the regular rpc-reply phase and will send the reply after doing the remote task.
 
xml_attrs_t rpc_defer_in_attrs
 the top->attrs gets deleted so a deferred rpc-reply needs to save the rpc_in_attrs More...
 
rpc_rpytyp_t rpc_reply_type
 saved for audit record if needed More...
 
status_t rpc_status
 processing status
 
time_t rpc_start_time
 timestamp when started
 
const xmlChar * subrpc_filespec
 saved by agt_db_api.c so the ycontrol callback function can generate an external value with the DB-API subrpc response message
 

Detailed Description

NETCONF Server and Client RPC Request/Reply Message Header.

Field Documentation

◆ hook_inputQ

dlq_hdr_t hook_inputQ

points to add_edit_value node comming from the users freed in the end of transaction.

Used only with set-hook Q of val_value_t

◆ rpc_agt_state

int rpc_agt_state

incoming: SERVER RPC processing state

agt_rpc_phase_t

◆ rpc_data_type

rpc_data_t rpc_data_type

incoming: get method reply handling builtin If the rpc_datacb is non-NULL then it will be used as a callback to generate the rpc-reply inline, instead of buffering the output.

The rpc_data and rpc_filter parameters are optionally used by the rpc_datacb function to generate a reply. type of data reply

◆ rpc_defer_in_attrs

xml_attrs_t rpc_defer_in_attrs

the top->attrs gets deleted so a deferred rpc-reply needs to save the rpc_in_attrs

malloced

◆ rpc_inputQ

dlq_hdr_t rpc_inputQ

the rpc_inputQ is used with JSON encoded input since an array is allowed at the top-level; it is used instead of rpc_input if encoding == JSON, even if only 1 array node is parsed;

Q of val_value_t *

◆ rpc_message_id

xmlChar* rpc_message_id

debugging and audit message strings

backptr into rpc_in_attrs

◆ rpc_reply_type

rpc_rpytyp_t rpc_reply_type

saved for audit record if needed

reply type needed


The documentation for this struct was generated from the following file: