agt_sil.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.
 */
#ifdef WITH_YCONTROL
#ifndef _H_agt_sil
#define _H_agt_sil
 
/*  FILE: agt_sil.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-feb-14    abb      Begun
*/
 
#ifndef _H_agt
#include "agt.h"
#endif
 
#ifndef _H_agt_cfg
#include "agt_cfg.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_getcb
#include "getcb.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
typedef struct agt_sil_added_edit_t_ {
    dlq_hdr_t         qhdr;
 
    xmlChar          *path;
 
    val_value_t      *editval;
 
    xmlChar          *editop;
 
    xmlChar          *where;
 
    xmlChar          *point;
 
    boolean           skipcb;
} YPACK agt_sil_added_edit_t;
 
 
typedef void
    (*agt_sil_get_walker_fn_t) (getcb_get2_t *get2cb,
                                const xmlChar *subsys_id,
                                status_t get_status,
                                val_value_t *return_val);
 
 
typedef status_t
    (*agt_sil_rpc_walker_fn_t) (const xmlChar *subsys_id,
                                status_t rpc_status,
                                val_value_t *return_val,
                                dlq_hdr_t *saveQ);
 
 
typedef status_t
    (*agt_sil_shook_walker_fn_t) (ses_cb_t *scb,
                                  rpc_msg_t *msg,
                                  agt_cfg_transaction_t *txcb,
                                  const xmlChar *subsys_id,
                                  status_t tx_status,
                                  dlq_hdr_t *edded_editQ);
 
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern status_t
    agt_sil_init (void);
 
 
extern void
    agt_sil_cleanup (void);
 
 
extern status_t
    agt_sil_start_transaction (agt_cfg_transaction_t *txcb,
                               const xmlChar *user_id,
                               const xmlChar *client_addr,
                               const xmlChar *target,
                               boolean is_validate,
                               boolean is_replay,
                               boolean is_reverse_edit,
                               boolean is_load_config,
                               boolean is_hook_load,
                               boolean is_hook_validate,
                               dlq_hdr_t *editQ);
 
 
extern status_t
    agt_sil_continue_start_transaction (agt_cfg_transaction_t *txcb,
                                        const xmlChar *user_id,
                                        const xmlChar *client_addr,
                                        const xmlChar *target,
                                        boolean is_replay,
                                        dlq_hdr_t *editQ);
 
 
extern status_t
    agt_sil_continue_transaction (const xmlChar *txid_str,
                                  agt_cbtyp_t cur_phase);
 
 
extern void
    agt_sil_end_transaction (const xmlChar *txid_str);
 
 
extern void
    agt_sil_cancel_transaction (const xmlChar *txid_str);
 
 
extern status_t
    agt_sil_send_load_event (const xmlChar *name,
                             boolean is_bundle,
                             boolean is_load);
 
 
extern status_t
    agt_sil_send_stream_callback_event (const xmlChar *subsys_id,
                                        const xmlChar *modname,
                                        const xmlChar *stream_name,
                                        boolean all_streams,
                                        agt_not_subevent_t subevent);
 
 
extern boolean
    agt_sil_edit_transaction_in_progress (void);
 
 
extern void
    agt_sil_check_deleted_edits (agt_cfg_transaction_t *txcb);
 
 
 
extern status_t
    agt_sil_start_get_transaction (ses_cb_t *client_scb,
                                   getcb_get2_t *get2cb,
                                   xml_msg_hdr_t *msg,
                                   const xmlChar **txid_str);
 
 
extern status_t
    agt_sil_get_transaction_status (const xmlChar *txid_str);
 
 
extern void
    agt_sil_walk_get_results (const xmlChar *txid_str,
                              agt_sil_get_walker_fn_t get_walker_fn);
 
 
extern status_t
    agt_sil_walk_rpc_results (const xmlChar *txid_str,
                              agt_sil_rpc_walker_fn_t rpc_walker_fn,
                              dlq_hdr_t *saveQ);
 
 
extern status_t
    agt_sil_walk_shook_results (ses_cb_t *scb,
                                rpc_msg_t *msg,
                                agt_cfg_transaction_t *txcb,
                                const xmlChar *txid_str,
                                agt_sil_shook_walker_fn_t shook_walker_fn);
 
 
extern void
    agt_sil_end_get_transaction (const xmlChar *txid_str);
 
 
extern void
    agt_sil_set_subsys_timeout (uint32 val);
 
 
extern status_t
    agt_sil_start_rpc_transaction (ses_cb_t *client_scb,
                                   rpc_msg_t *msg,
                                   obj_template_t *obj,
                                   val_value_t *actionval,
                                   const xmlChar **txid_str);
 
 
extern status_t
    agt_sil_rpc_transaction_status (const xmlChar *txid_str);
 
 
extern void
    agt_sil_end_rpc_transaction (const xmlChar *txid_str);
 
 
extern status_t
    agt_sil_handle_remote_trans_start (ses_cb_t *client_scb,
                                       const xmlChar *client_txid,
                                       boolean isvalidate,
                                       boolean isrollback,
                                       boolean isrunning);
 
 
extern status_t
    agt_sil_transaction_complete_cb (const xmlChar *txid_str);
 
 
extern status_t
    agt_sil_get_exit_mode_edit (const xmlChar *txid_str,
                                agt_tx_type_t tx_type,
                                val_value_t **error_val,
                                xmlChar **error_path,
                                xmlChar **error_msg,
                                boolean *need_reverse_edit);
 
 
extern status_t
    agt_sil_get_exit_mode (const xmlChar *txid_str,
                           agt_tx_type_t tx_type);
 
 
extern boolean
    agt_sil_last_in_transaction (const xmlChar *txid_str,
                                 ses_id_t sid);
 
 
extern void
    agt_sil_unload_module (const xmlChar *modname);
 
 
extern status_t
    agt_sil_bundle_walker (const xmlChar *name,
                           void *cookie);
 
 
extern status_t
    agt_sil_module_walker (const xmlChar *name,
                           void *cookie);
 
extern status_t
    agt_sil_handle_remote_commit_completeness (ses_cb_t *client_scb,
                                               const xmlChar *client_txid,
                                               agt_cbtyp_t cbtyp,
                                               agt_commit_type_t commit_type);
 
 
 
extern boolean
    agt_sil_subsys_registered (const xmlChar *subsys_id);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_sil */
#endif   // WITH_YCONTROL