db_api.h File Reference

Subsystem Database API. More...

#include <xmlstring.h>
#include "db_api_types.h"
#include "rpc.h"
#include "val.h"
#include "yang_patch.h"

Include dependency graph for db_api.h:

Go to the source code of this file.

Macros
#define	DB_API   (const xmlChar *)"db-api"
	YControl service name.
#define	DB_API_MOD   (const xmlChar *)"yumaworks-db-api"
	DB-API YANG module.
#define	DB_API_OBJ   (const xmlChar *)"db-api"
	db-api container name
#define	DB_API_REQ_OK(ST)   (ST >= DB_API_ST_READY)
	Check if DB-API state is ready.

Functions
status_t	db_api_register_service (void)
	Register the DB-API service with the YControl layer. More...
status_t	db_api_register_service_ex (boolean with_db_lock)
	Register the DB-API service with the YControl layer. More...
boolean	db_api_service_ready (void)
	Check if the DB-API service is done initializing, and is now ready to send requests to the server. More...
status_t	db_api_send_edit (const xmlChar *edit_target, const xmlChar *edit_operation, const xmlChar *edit_xml_value)
	Create a YANG Patch edit request and send it to the DB-API service on the main server. More...
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)
	Create a YANG Patch edit request and send it to the DB-API service on the main server. More...
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)
	Create a YANG Patch edit request and send it to the DB-API service on the main server. More...
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)
	Create a YANG Patch edit request and send it to the DB-API service on the main server. More...
status_t	db_api_check_edit (void)
	Check on the status of an edit in progress. More...
status_t	db_api_check_edit_ex (const xmlChar **errstr)
	Check on the status of an edit in progress. More...
status_t	db_api_send_getconfig (const xmlChar *filespec, boolean withdef)
	Create a <getconfig> request and send it to the main server. More...
status_t	db_api_send_getfilter (const xmlChar *filespec, boolean withdef, boolean get_config, const xmlChar *xpath_filter)
	Retrieve data from the server with complete parameters. More...
status_t	db_api_send_getfilter_cb (db_api_dataresp_cbfn_t cbfn, void *cookie, boolean withdef, boolean get_config, const xmlChar *xpath_filter)
	Retrieve data from the server with user callback. More...
status_t	db_api_start_patch (const xmlChar *patch_id_str, boolean system_edit, yang_patch_cb_t **retcb)
	Start a YANG Patch request that can have multiple edits. More...
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)
	Start a YANG Patch request that can have multiple edits with complete parameters (YPW-1826) More...
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)
	Create an edit request and add to YANG Patch in progress. More...
status_t	db_api_send_patch (yang_patch_cb_t *pcb)
	Send a previously created patch request. More...
void	db_api_free_patch (yang_patch_cb_t *pcb)
	Free a patch control block. More...
status_t	db_api_send_enter_maintmode (void)
	Create a <enter-maintmode> request and send it to the main server. More...
status_t	db_api_send_enter_maintmode_ex (boolean read_ok, boolean operation_ok)
	Create a <enter-maintmode> request and send it to the main server. More...
status_t	db_api_send_exit_maintmode (void)
	Create a <exit-maintmode> request and send it to the main server. More...
status_t	db_api_send_set_loglevel (const char *dlevel)
	Create a <set-log-level> request and send it to the main server. More...
status_t	db_api_request_local_db_lock (void)
	API to request that the local system has the Db-Edit-Lock. More...
status_t	db_api_release_local_db_lock (void)
	API to release the local system Db-Edit-Lock. More...
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)
	Create a <subrpc-request> request and send it to the main server. More...
status_t	db_api_send_ypha_request (val_value_t *msgval)
	Create a <yp-ha-mode> request and send it to the main server. More...
status_t	db_api_send_protocol_control (const xmlChar *action, const xmlChar *protocol)
	Create a <protocol-control> request and send it to the main server. More...
uint32	db_api_get_last_msg_id (void)
	API to get the last message ID sent by the db-api system. More...

Detailed Description

Subsystem Database API.