sil_sa_types.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_sil_sa_types
#define _H_sil_sa_types

/*  FILE: sil_sa_types.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/

/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************

date         init     comment
----------------------------------------------------------------------
15-mar-14    abb      Begun
*/

#include <xmlstring.h>

#ifndef _H_agt
#include "agt.h"
#endif

#ifndef _H_dlq
#include "dlq.h"
#endif

#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif

#ifndef _H_obj
#include "obj.h"
#endif

#ifndef _H_rpc
#include "rpc.h"
#endif

#ifndef _H_status_enum
#include "status_enum.h"
#endif

#ifndef _H_val
#include "val.h"
#endif


#ifdef __cplusplus
extern "C" {
#endif



/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/


/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/

typedef enum sil_sa_state_t_ {
    SIL_SA_ST_NONE,

    SIL_SA_ST_START,

    SIL_SA_ST_STOPPED,

    SIL_SA_ST_ERROR,

    SIL_SA_ST_WAIT_CONFIG,

    SIL_SA_ST_WAIT_REGISTER,

    SIL_SA_ST_READY,

    SIL_SA_ST_WAIT_APPLY,

    SIL_SA_ST_WAIT_COMMIT,

    SIL_SA_ST_WAIT_HOOK_GETDATA,
} sil_sa_state_t;


typedef struct sil_sa_bundle_t_ {
    dlq_hdr_t qhdr;

    xmlChar *bundle_name;

    dlq_hdr_t bundle_modQ;

    boolean load_event_done;

} sil_sa_bundle_t;


typedef struct sil_sa_cb_t_ {
    ncx_module_t                *mod;

    obj_template_t              *obj;

    val_value_t                 *payload;

    sil_sa_state_t               state;

    boolean                      sil_load_done;

    boolean                      need_replay;

    boolean                      init2_done;

    uint32                       msgid;

    val_value_t                 *config_response;

    val_value_t                 *start_request;

    ncx_transaction_id_t         txid;

    boolean                      is_validate;

    boolean                      is_reverse_edit;

    boolean                      is_load_config;

    dlq_hdr_t                    editQ;   /* Q of sil_sa_edit_t */

    struct sil_sa_edit_t_       *cur_edit;

    rpc_msg_t                   *rpc_msg;

    const xmlChar               *user_id;

    const xmlChar               *client_addr;

    const xmlChar               *target;

    const xmlChar               *txid_str;

    uint32                       error_edit_index;

    status_t                     error_edit_res;

    const xmlChar               *error_edit_str;

    dlq_hdr_t                    bundleQ;

    dlq_hdr_t                    library_parmQ;

    dlq_hdr_t bundle_unloadQ;

    val_value_t                 *keys_val;

    dlq_hdr_t                    added_editQ;

    boolean                      is_hook_load;

    boolean                      is_hook_validate;

    val_value_t                 *hook_get_value;

    boolean                      skip_reverse_edit;

} sil_sa_cb_t;


typedef struct sil_sa_child_edit_t_ {
    dlq_hdr_t                    qhdr;

    op_editop_t                  editop;

    val_value_t                 *newval;

    val_value_t                 *curval;
} sil_sa_child_edit_t;


typedef struct sil_sa_edit_t_ {
    dlq_hdr_t                    qhdr;

    uint32                       edit_index;

    op_editop_t                  editop;

    const xmlChar               *path;

    val_value_t                 *newval;

    val_value_t                 *curval;

    val_value_t                 *keysval;

    obj_template_t              *cbobj;

    boolean                      apply_done;

    boolean                      hook_edit;

    agt_hook_type_t              hook_type;

    dlq_hdr_t                    child_editQ;

} sil_sa_edit_t;


typedef struct sil_sa_added_edit_t_ {
    dlq_hdr_t                    qhdr;

    const xmlChar               *path;

    val_value_t                 *editval;

    const xmlChar               *editop;

    const xmlChar               *where;

    const xmlChar               *point;

    boolean                      skipcb;

    obj_template_t              *cbobj;
} sil_sa_added_edit_t;



#ifdef __cplusplus
}  /* end extern 'C' */
#endif

#endif      /* _H_sil_sa_types */