agt_ncx.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_agt_ncx
#define _H_agt_ncx
 
/*  FILE: agt_ncx.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
04-feb-06    abb      Begun
 
*/
 
#ifndef _H_cfg
#include "cfg.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
extern status_t
    agt_ncx_init (void);
 
 
extern void
    agt_ncx_cleanup (void);
 
 
extern status_t
    agt_ncx_cfg_load (cfg_template_t *cfg,
                      cfg_location_t cfgloc,
                      const xmlChar *cfgparm);
 
 
extern status_t
    agt_ncx_cfg_save_ex (ses_cb_t *scb,
                         rpc_msg_t *msg,
                         cfg_template_t *cfg);
 
 
extern status_t
    agt_ncx_cfg_save (cfg_template_t *cfg);
 
 
extern status_t
    agt_ncx_cfg_save_inline (const xmlChar *source_url,
                             val_value_t *newroot);
 
 
extern status_t
    agt_ncx_load_backup (const xmlChar *filespec,
                         cfg_template_t *cfg,
                         ses_id_t  use_sid,
                         dlq_hdr_t *errQ,
                         boolean do_config_change,
                         const rpc_msg_t *reqmsg);
 
 
 
extern boolean
    agt_ncx_cc_active (void);
 
 
extern ses_id_t
    agt_ncx_cc_ses_id (void);
 
 
extern void
    agt_ncx_clear_cc_ses_id (void);
 
 
extern const xmlChar *
    agt_ncx_cc_persist_id (void);
 
 
extern void
    agt_ncx_check_cc_timeout (void);
 
 
#ifdef PTHREADS
extern void
    agt_ncx_check_restconf_cc_timeout (void);
 
#endif  // PTHREADS
 
 
extern status_t
    agt_ncx_cancel_confirmed_commit (ses_cb_t *scb,
                                     ncx_confirm_event_t event);
 
 
extern status_t
    agt_ncx_cancel_confirmed_commit_withmsg (ses_cb_t  *scb,
                                             rpc_msg_t *msg,
                                             xml_node_t *methnode,
                                             ncx_confirm_event_t event);
 
 
extern status_t
    agt_ncx_internal_commit (ses_cb_t  *scb,
                             rpc_msg_t *msg,
                             boolean write_backup,
                             boolean save_nvstore,
                             ses_id_t rollback_sid,
                             xmlChar **backup_source,
                             boolean *errdone,
                             boolean *rootcheck_done,
                             status_t *rootcheck_res);
 
 
extern status_t
    agt_ncx_write_config (const xmlChar *filespec,
                          cfg_template_t *cfg);
 
 
extern status_t
    agt_ncx_force_write_config (const xmlChar *filespec,
                                cfg_template_t *cfg);
 
 
extern status_t
    agt_ncx_process_one_loaded_module (ses_cb_t *scb,
                                       ncx_module_t *mod);
 
 
extern status_t
    agt_ncx_final_process_loaded_modules (ses_cb_t *scb,
                                          rpc_msg_t *msg,
                                          boolean is_booting);
 
 
 
extern status_t
    agt_ncx_check_commit_parms (boolean confirmed,
                                uint32 confirm_timeout,
                                const xmlChar *persist,
                                const xmlChar *persist_id);
 
 
extern status_t
    agt_ncx_commit_invoke (ses_cb_t *scb,
                           rpc_msg_t *msg,
                           cfg_template_t *running,
                           const xmlChar *comment_str,
                           boolean confirmed,
                           uint32 confirm_timeout,
                           const xmlChar *persist,
                           const xmlChar *persist_id,
                           agt_ccparm_t *ret_ccparm,
                           boolean *errdone,
                           boolean *save_startup);
 
 
 
extern status_t
    agt_ncx_load_config_ha (ses_cb_t *scb,
                            rpc_msg_t *msg,
                            val_value_t *config_val,
                            ncx_transaction_id_t txid);
 
 
extern status_t
    agt_ncx_do_lock_validate (cfg_template_t *cfg);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_ncx */