agt_glob.h

Go to the documentation of this file.

/*
 * Copyright (c) 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_glob
#define _H_agt_glob
 
/*  FILE: agt_glob.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
20-apr-24    am      Begun
 
*/
 
#ifndef _H_agt_rpc
#include "agt_rpc.h"
#endif
 
#ifndef _H_agt_action
#include "agt_action.h"
#endif
 
#ifndef _H_rpc
#include "rpc.h"
#endif
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_xml_util
#include "xml_util.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                                                   *
*                         T Y P E S                                 *
*                                                                   *
*********************************************************************/
 
 
typedef struct agt_glob_cbset_t_ {
 
    agt_rpc_method_t        rpc_cbfn[AGT_RPC_NUM_CALLBACK_PHASES];
 
    agt_action_cb_t         action_cbfn[AGT_RPC_NUM_CALLBACK_PHASES];
 
    agt_cb_fn_t             edit2_cbfn;
 
    agt_edit3_fn_t          edit3_cbfn;
 
    dlq_hdr_t               glob_subsysQ;
 
} agt_glob_cbset_t;
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern status_t
    agt_glob_init (void);
 
 
extern void
    agt_glob_cleanup (void);
 
 
extern agt_glob_cbset_t *
    agt_glob_get_cbset (void);
 
 
extern agt_rpc_method_t *
    agt_glob_get_rpc_cbfn (obj_template_t *obj);
 
 
extern agt_action_cb_t *
    agt_glob_get_action_cbfn (obj_template_t *obj);
 
 
extern agt_cb_fn_t
    agt_glob_get_edit2_cbfn (obj_template_t *obj);
 
 
extern agt_edit3_fn_t
    agt_glob_get_edit3_cbfn (obj_template_t *obj);
 
 
extern boolean
    agt_glob_has_rpc_callback (obj_template_t *obj);
 
 
extern boolean
    agt_glob_has_action_callback (obj_template_t *obj);
 
 
extern boolean
    agt_glob_has_edit_callback (obj_template_t *obj);
 
 
extern status_t
    agt_glob_register_rpc (agt_rpc_phase_t phase,
                           agt_rpc_method_t cbfn);
 
 
extern void
    agt_glob_unregister_rpc (void);
 
 
extern status_t
    agt_glob_register_action (agt_rpc_phase_t phase,
                              agt_action_cb_t action_cb);
 
 
extern void
    agt_glob_unregister_action (void);
 
 
extern status_t
    agt_glob_register_edit2 (agt_cb_fn_t cbfn);
 
 
extern status_t
    agt_glob_register_edit3 (agt_edit3_fn_t cbfn);
 
 
extern void
    agt_glob_unregister_edit (void);
 
 
extern status_t
    agt_glob_register_get (getcb_fn2_t cbfn);
 
 
extern void
    agt_glob_unregister_get (void);
 
 
extern boolean
    agt_glob_edit2_enabled (void);
 
 
extern boolean
    agt_glob_edit3_enabled (void);
 
 
extern status_t
    agt_glob_setup_subsysQ (const xmlChar *subsys_id,
                            agt_cb_calltype_t calltype);
 
 
extern dlq_hdr_t *
    agt_glob_get_subsysQ (void);
 
 
extern void
    agt_glob_clean_subsysQ (void);
 
 
extern boolean
    agt_glob_edit2_allowed (obj_template_t *obj);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_glob */