agt_sil_lib.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2022, 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_sil_lib
#define _H_agt_sil_lib
 
/*  FILE: agt_sil_lib.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
00-may-14    abb      Begun; split out from agt.h
*/
 
#include <xmlstring.h>
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifndef _H_xml_msg
#include "xml_msg.h"
#endif
 
#ifndef _H_xmlns
#include "xmlns.h"
#endif
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
#define SA_NAME_EXT (const xmlChar *)"_sa"
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
typedef enum agt_siltype_t_ {
    AGT_SILTYP_NONE,     
    AGT_SILTYP_MODULE,   
    AGT_SILTYP_BUNDLE    
} agt_siltype_t;
 
 
/********* Server Instrumentation Library Callbacks ***********/
 
 
typedef status_t (*agt_sil_init_fn_t)(const xmlChar *modname,
                                      const xmlChar *revision);
 
 
 
typedef status_t (*agt_sil_init2_fn_t)(void);
 
 
typedef void (*agt_sil_cleanup_fn_t)(void);
 
 
 
/* Example: N=test2
extern status_t y_test2_init(const xmlChar *modname, const xmlChar *revision);
extern status_t y_test2_init2(void);
extern void y_test2_cleanup(void);
*/
 
#define AGT_SIL_LIB_EXTERN(N) \
 extern status_t y_##N##_init (const xmlChar *modname, const xmlChar *revision);\
 extern status_t y_##N##_init2 (void);\
 extern void y_##N##_cleanup (void);
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern status_t
    agt_load_sil_code (const xmlChar *modname,
                       const xmlChar *revision,
                       boolean cfgloaded,
                       agt_siltype_t siltyp,
                       boolean is_sil_sa);
 
 
extern status_t
    agt_unload_sil_code (const xmlChar *modname);
 
 
extern boolean
    agt_dynlib_loaded (const xmlChar *name);
 
 
extern void
    agt_sil_lib_init (void);
 
 
extern void
    agt_sil_lib_cleanup (void);
 
 
extern status_t load_SIL (const xmlChar *modname,
                          const xmlChar *revision,
                          agt_siltype_t siltyp,
                          boolean is_sil_sa);
 
 
extern status_t
    load_SIL_loadpath (const xmlChar *modname,
                       const xmlChar *revision,
                       agt_siltype_t siltyp,
                       boolean is_sil_sa,
                       boolean is_loadpath);
 
 
extern status_t
    agt_sil_lib_call_init2 (void);
 
 
extern void
    agt_sil_lib_support_save (ses_cb_t *scb,
                              xml_msg_hdr_t *mhdr,
                              xmlns_id_t parent_nsid,
                              int32 indent,
                              int32 startindent);
 
 
extern status_t
    agt_sil_lib_register_statlib (const xmlChar *modname,
                                  agt_sil_init_fn_t init_fn,
                                  agt_sil_init2_fn_t init2_fn,
                                  agt_sil_cleanup_fn_t cleanup_fn);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt */