rpc_err.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_err
#define _H_rpc_err
/*  FILE: rpc_err.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************
 
date             init     comment
----------------------------------------------------------------------
06-apr-05    abb      Begun.
*/
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_rpc
#include "rpc.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                         C O N S T A N T S                         *
*                                                                   *
*********************************************************************/
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
 
/*** YANG standard error-app-tag values ***/
/* 13.1 */
#define RPC_ERR_APPTAG_UNIQUE_FAILED    (const xmlChar *)"data-not-unique"
 
/* 13.2 */
#define RPC_ERR_APPTAG_MAX_ELEMS       (const xmlChar *)"too-many-elements"
 
/* 13.3 */
#define RPC_ERR_APPTAG_MIN_ELEMS       (const xmlChar *)"too-few-elements"
 
/* 13.4 */
#define RPC_ERR_APPTAG_MUST            (const xmlChar *)"must-violation"
 
/* 13.5 */
#define RPC_ERR_APPTAG_INSTANCE_REQ    (const xmlChar *)"instance-required"
 
/* 13.6 */
#define RPC_ERR_APPTAG_CHOICE          (const xmlChar *)"missing-choice"
 
/* 13.7 */
#define RPC_ERR_APPTAG_INSERT          (const xmlChar *)"missing-instance"
 
 
#define RPC_ERR_APPTAG_RANGE           (const xmlChar *)"not-in-range"
 
#define RPC_ERR_APPTAG_VALUE_SET       (const xmlChar *)"not-in-value-set"
 
#define RPC_ERR_APPTAG_PATTERN         (const xmlChar *)"pattern-test-failed"
 
#define RPC_ERR_APPTAG_DATA_REST   \
    (const xmlChar *)"data-restriction-violation"
 
#define RPC_ERR_APPTAG_DATA_NOT_UNIQUE \
    (const xmlChar *)"data-not-unique"
 
/* ietf-netconf-state:get-schema */
/* ietf-netconf-partial-lock:partial-lock */
#define RPC_ERR_APPTAG_NO_MATCHES     (const xmlChar *)"no-matches"
 
/* ietf-netconf-partial-lock:partial-lock */
#define RPC_ERR_APPTAG_NOT_NODESET      (const xmlChar *)"not-a-node-set"
 
/* ietf-netconf-partial-lock:partial-lock */
#define RPC_ERR_APPTAG_LOCKED           (const xmlChar *)"locked"
 
/* ietf-netconf-partial-lock:partial-lock */
#define RPC_ERR_APPTAG_COMMIT           (const xmlChar *)\
    "outstanding-confirmed-commit"
 
 
/*** netconfcentral errror-app-tag values ***/
#define RPC_ERR_APPTAG_GEN_WARNING      (const xmlChar *)"general-warning"
#define RPC_ERR_APPTAG_GEN_ERROR        (const xmlChar *)"general-error"
#define RPC_ERR_APPTAG_INT_ERROR        (const xmlChar *)"internal-error"
#define RPC_ERR_APPTAG_IO_ERROR         (const xmlChar *)"io-error"
#define RPC_ERR_APPTAG_MALLOC_ERROR     (const xmlChar *)"malloc-error"
#define RPC_ERR_APPTAG_LIMIT_REACHED    (const xmlChar *)"limit-reached"
#define RPC_ERR_APPTAG_LIBXML2_ERROR    (const xmlChar *)"libxml2-error"
#define RPC_ERR_APPTAG_SQL_ERROR        (const xmlChar *)"sql-error"
#define RPC_ERR_APPTAG_SSH_ERROR        (const xmlChar *)"ssh-error"
#define RPC_ERR_APPTAG_BEEP_ERROR       (const xmlChar *)"beep-error"
#define RPC_ERR_APPTAG_HTML_ERROR       (const xmlChar *)"html-error"
#define RPC_ERR_APPTAG_DATA_INCOMPLETE  (const xmlChar *)"data-incomplete"
#define RPC_ERR_APPTAG_DATA_INVALID     (const xmlChar *)"data-invalid"
#define RPC_ERR_APPTAG_DUPLICATE_ERROR  (const xmlChar *)"duplicate-error"
#define RPC_ERR_APPTAG_RESOURCE_IN_USE  (const xmlChar *)"resource-in-use"
#define RPC_ERR_APPTAG_NO_ACCESS        (const xmlChar *)"no-access"
#define RPC_ERR_APPTAG_RECOVER_FAILED   (const xmlChar *)"recover-failed"
#define RPC_ERR_APPTAG_NO_SUPPORT       (const xmlChar *)"no-support"
 
 
/*** ietf-subscribed-notifications ***/
 
#define RPC_ERR_APPTAG_NOTIF_DSCP_UNAVAILABLE \
    (const xmlChar *)"ietf-subscribed-notifications:dscp-unavailable"
 
#define RPC_ERR_APPTAG_NOTIF_ENCODING_UNSUPPORTED \
    (const xmlChar *)"ietf-subscribed-notifications:encoding-unsupported"
 
#define RPC_ERR_APPTAG_NOTIF_FILTER_UNAVAILABLE \
    (const xmlChar *)"ietf-subscribed-notifications:filter-unavailable"
 
#define RPC_ERR_APPTAG_NOTIF_FILTER_UNSUPPORTED \
    (const xmlChar *)"ietf-subscribed-notifications:filter-unsupported"
 
#define RPC_ERR_APPTAG_NOTIF_INSUFFICIENT_RESOURCES \
    (const xmlChar *)"ietf-subscribed-notifications:insufficient-resources"
 
#define RPC_ERR_APPTAG_NOTIF_NO_SUCH_SUBSCRIPTION \
    (const xmlChar *)"ietf-subscribed-notifications:no-such-subscription"
 
#define RPC_ERR_APPTAG_NOTIF_REPLAY_UNSUPPORTED \
    (const xmlChar *)"ietf-subscribed-notifications:replay-unsupported"
 
#define RPC_ERR_APPTAG_NOTIF_STREAM_UNAVAILABLE \
    (const xmlChar *)"ietf-subscribed-notifications:stream-unavailable"
 
/*** ietf-yang-push errors ***/
 
#define RPC_ERR_APPTAG_PUSH_CANT_EXCLUDE \
    (const xmlChar *)"ietf-yang-push:cant-exclude"
 
#define RPC_ERR_APPTAG_PUSH_DATASTORE_NOT_SUBSCRIBABLE \
    (const xmlChar *)"ietf-yang-push:datastore-not-subscribable"
 
#define RPC_ERR_APPTAG_PUSH_NO_SUCH_RESYNC \
    (const xmlChar *)"ietf-yang-push:no-such-subscription-resync"
 
#define RPC_ERR_APPTAG_PUSH_ON_CHANGE_UNSUPPORTED \
    (const xmlChar *)"ietf-yang-push:on-change-unsupported"
 
#define RPC_ERR_APPTAG_PUSH_ON_CHANGE_SYNC_UNSUPPORTED \
    (const xmlChar *)"ietf-yang-push:on-change-sync-unsupported"
 
#define RPC_ERR_APPTAG_PUSH_PERIOD_UNSUPPORTED \
    (const xmlChar *)"ietf-yang-push:period-unsupported"
 
#define RPC_ERR_APPTAG_PUSH_UPDATE_TOO_BIG \
    (const xmlChar *)"ietf-yang-push:update-too-big"
 
#define RPC_ERR_APPTAG_PUSH_SYNC_TOO_BIG \
    (const xmlChar *)"ietf-yang-push:sync-too-big"
 
#define RPC_ERR_APPTAG_PUSH_UNCHANGING_SELECTION \
    (const xmlChar *)"ietf-yang-push:unchanging-selection"
 
 
#define RPC_ERR_LAST_ERROR RPC_ERR_MALFORMED_MESSAGE
 
/********************************************************************
*                                                                   *
*                          T Y P E S                                *
*                                                                   *
*********************************************************************/
 
typedef enum rpc_err_t_ {
    RPC_ERR_NONE,                
    RPC_ERR_IN_USE,              
    RPC_ERR_INVALID_VALUE,       
    RPC_ERR_TOO_BIG,             
    RPC_ERR_MISSING_ATTRIBUTE,   
    RPC_ERR_BAD_ATTRIBUTE,       
    RPC_ERR_UNKNOWN_ATTRIBUTE,   
    RPC_ERR_MISSING_ELEMENT,     
    RPC_ERR_BAD_ELEMENT,         
    RPC_ERR_UNKNOWN_ELEMENT,     
    RPC_ERR_UNKNOWN_NAMESPACE,   
    RPC_ERR_ACCESS_DENIED,       
    RPC_ERR_LOCK_DENIED,         
    RPC_ERR_RESOURCE_DENIED,     
    RPC_ERR_ROLLBACK_FAILED,     
    RPC_ERR_DATA_EXISTS,         
    RPC_ERR_DATA_MISSING,        
    RPC_ERR_OPERATION_NOT_SUPPORTED,  
    RPC_ERR_OPERATION_FAILED,    
    RPC_ERR_PARTIAL_OPERATION,   
    RPC_ERR_MALFORMED_MESSAGE    
} rpc_err_t;
 
 
typedef enum rpc_err_sev_t_ {
    RPC_ERR_SEV_NONE,         
    RPC_ERR_SEV_WARNING,      
    RPC_ERR_SEV_ERROR         
} rpc_err_sev_t;
 
 
typedef struct rpc_err_info_ {
    dlq_hdr_t          qhdr;   
    val_value_t       *user_val;
 
    xmlns_id_t         name_nsid;
 
    const xmlChar     *name;
 
    xmlChar           *dname;
    boolean            isqname;     
    ncx_btype_t        val_btype;   
    uint8              val_digits;  
    xmlns_id_t         val_nsid;    
    xmlChar           *badns;       
    xmlChar           *dval;        
    union {
    const xmlChar     *strval;     
    ncx_num_t          numval;     
    void              *cpxval;     
    } v;
} rpc_err_info_t;
 
 
typedef struct rpc_err_rec_t_ {
    dlq_hdr_t          error_qhdr;
 
    status_t           error_res;
 
    ncx_layer_t        error_type;
 
    rpc_err_t          error_id;
 
    rpc_err_sev_t      error_severity;
 
    const xmlChar     *error_tag;
 
    const xmlChar     *error_app_tag;
 
    xmlChar           *error_path;
 
    xmlChar           *error_message;
 
    const xmlChar     *error_message_lang;
    dlq_hdr_t          error_info;     
} rpc_err_rec_t;
 
 
/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/
 
 
extern const xmlChar *
    rpc_err_get_errtag (rpc_err_t errid);
 
 
extern rpc_err_t
    rpc_err_get_errtag_enum (const xmlChar *errtag);
 
 
extern rpc_err_rec_t *
    rpc_err_new_record (void);
 
 
extern void
    rpc_err_init_record (rpc_err_rec_t *err);
 
 
extern void
    rpc_err_free_record (rpc_err_rec_t *err);
 
 
extern void
    rpc_err_clean_record (rpc_err_rec_t *err);
 
 
extern rpc_err_info_t *
    rpc_err_new_info (void);
 
 
extern void
    rpc_err_free_info (rpc_err_info_t *errinfo);
 
 
extern void
    rpc_err_dump_errors (const rpc_msg_t  *msg, log_debug_t lvl);
 
 
 
extern void
    rpc_err_dump_errors_audit (const rpc_msg_t  *msg);
 
 
extern const xmlChar *
    rpc_err_get_severity (rpc_err_sev_t  sev);
 
 
extern void
    rpc_err_clean_errQ (dlq_hdr_t *errQ);
 
 
extern boolean
    rpc_err_any_errors (const rpc_msg_t  *msg);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif            /* _H_rpc_err */