db_api.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 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_db_api
#define _H_db_api
 
/*  FILE: db_api.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
18-nov-14    abb      Begun
*/
 
#include <xmlstring.h>
 
#ifndef _H_db_api_types
#include "db_api_types.h"
#endif
 
#ifndef _H_rpc
#include "rpc.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_yang_patch
#include "yang_patch.h"
#endif
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
#define DB_API      (const xmlChar *)"db-api"
 
#define DB_API_MOD  (const xmlChar *)"yumaworks-db-api"
 
#define DB_API_OBJ  (const xmlChar *)"db-api"
 
#define DB_API_REQ_OK(ST) (ST >= DB_API_ST_READY)
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern status_t
    db_api_register_service (void);
 
 
extern status_t
    db_api_register_service_ex (boolean with_db_lock);
 
 
extern boolean
    db_api_service_ready (void);
 
 
extern status_t
    db_api_send_edit (const xmlChar *edit_target,
                      const xmlChar *edit_operation,
                      const xmlChar *edit_xml_value);
 
 
extern status_t
    db_api_send_edit_ex (const xmlChar *edit_target,
                         const xmlChar *edit_operation,
                         const xmlChar *edit_xml_value,
                         const xmlChar *patch_id_str,
                         boolean system_edit);
 
 
extern status_t
    db_api_send_edit_full (const xmlChar *edit_target,
                           const xmlChar *edit_operation,
                           const xmlChar *edit_xml_value,
                           const xmlChar *patch_id_str,
                           boolean system_edit,
                           const xmlChar *insert_point,
                           const xmlChar *insert_where);
 
 
extern status_t
    db_api_send_edit_full2 (const xmlChar *edit_target,
                            const xmlChar *edit_operation,
                            const xmlChar *edit_xml_value,
                            const xmlChar *patch_id_str,
                            boolean system_edit,
                            const xmlChar *insert_point,
                            const xmlChar *insert_where,
                            boolean skip_sil);
 
 
extern status_t
    db_api_check_edit (void);
 
 
extern status_t
    db_api_check_edit_ex (const xmlChar **errstr);
 
 
 
extern status_t
    db_api_send_getconfig (const xmlChar *filespec,
                           boolean withdef);
 
 
extern status_t
    db_api_send_getfilter (const xmlChar *filespec,
                           boolean withdef,
                           boolean get_config,
                           const xmlChar *xpath_filter);
 
 
extern status_t
    db_api_send_getfilter_cb (db_api_dataresp_cbfn_t cbfn,
                              void *cookie,
                              boolean withdef,
                              boolean get_config,
                              const xmlChar *xpath_filter);
 
 
extern status_t
    db_api_start_patch (const xmlChar *patch_id_str,
                        boolean system_edit,
                        yang_patch_cb_t **retcb);
 
 
 
extern status_t
    db_api_start_patch2 (const xmlChar *patch_id_str,
                         boolean system_edit,
                         boolean skip_sil,
                         const xmlChar *comment,
                         yang_patch_cb_t **retcb);
 
 
extern status_t
    db_api_add_edit (yang_patch_cb_t *pcb,
                     const xmlChar *edit_id_str,
                     const xmlChar *edit_target,
                     const xmlChar *edit_operation,
                     const xmlChar *edit_xml_value,
                     const xmlChar *insert_point,
                     const xmlChar *insert_where);
 
 
extern status_t
    db_api_send_patch (yang_patch_cb_t *pcb);
 
 
extern void
    db_api_free_patch (yang_patch_cb_t *pcb);
 
 
extern status_t
    db_api_send_enter_maintmode (void);
 
 
extern status_t
    db_api_send_enter_maintmode_ex (boolean read_ok,
                                    boolean operation_ok);
 
 
extern status_t
    db_api_send_exit_maintmode (void);
 
 
extern status_t
    db_api_send_set_loglevel (const char *dlevel);
 
 
extern status_t
    db_api_request_local_db_lock (void);
 
 
extern status_t
    db_api_release_local_db_lock (void);
 
 
extern status_t
    db_api_send_subrpc_request (const xmlChar *user_id,
                                const xmlChar *rpc_modname,
                                const xmlChar *rpc_name,
                                const xmlChar *in_filespec,
                                const xmlChar *out_filespec);
 
 
 
 
 
extern status_t
    db_api_send_ypha_request(val_value_t *msgval);
 
 
 
extern status_t
    db_api_send_protocol_control (const xmlChar *action,
                                  const xmlChar *protocol);
 
 
 
extern uint32
    db_api_get_last_msg_id (void);
 
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_db_api */