transformer.h

Go to the documentation of this file.

/*
 *    Caplin Transformer SDK
 *
 *    Copyright CAPLIN Systems Ltd 2000-2019
 *
 *    $Author$
 *    $DateTime$
 *    $Change$
 *    $Id$
 */


#ifndef __TRANSFORMER_H__
#define __TRANSFORMER_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <time.h>
#include "datasrc.h"


#define TRANSFORMER_VERSION "8.0.1"

#define TRANSFORMER_MAJOR_VERSION 8
#define TRANSFORMER_MINOR_VERSION 0
#define TRANSFORMER_PATCH_VERSION 1


#ifndef WIN32
#ifndef TRANSFORMER_EXPORT
#define TRANSFORMER_EXPORT extern
#endif
#ifndef TRANSFORMER_MODULE_EXPORT
#define TRANSFORMER_MODULE_EXPORT extern
#endif
#else
#ifndef TRANSFORMER_EXPORT
#define TRANSFORMER_EXPORT __declspec(dllimport)
#endif
#ifndef TRANSFORMER_MODULE_EXPORT
#define TRANSFORMER_MODULE_EXPORT __declspec(dllexport)
#endif
#endif



typedef struct _userinfo userinfo_t;

typedef struct  _authfuncs     authfuncs_t;

typedef struct _tfhandle tf_handle_t;

typedef int (*tf_request_cb)(tf_handle_t *handle, int peer, const char *subject, int flags, int id, void *data);

typedef int (*tf_discard_cb)(tf_handle_t *handle, int peer, const char *subject, int flags, int id, void *data);

typedef int (*tf_update_cb)(tf_handle_t *handle, int peer, ds_data_t *dsdata, int flags, int id, void *data);

typedef int (*tf_nodata_cb)(tf_handle_t *handle, int peer, const char *subject, short nodata_flags, int flags, int id, void *data);

typedef int (*tf_status_cb)(tf_handle_t *handle, int peer, const char *subject, int status, u_short code, const char *message, int flags, int id, void *data);

typedef void    (*update_cb)(int peer, ds_data_t *dsdata, time_t update_time, int val, void *data);

typedef void (*tf_finalize_cb)(int val, void *data, tf_handle_t *handle);

#ifndef WIN32
#ifndef CONF_DARWIN
enum
{
    FALSE = 0,
    TRUE = 1,
};
#endif
#endif


TRANSFORMER_EXPORT int        register_interest(const char *name, update_cb update,int id, void *data);

TRANSFORMER_EXPORT int        register_interest_check(const char *name, update_cb update,int id, void *data);

TRANSFORMER_EXPORT int        deregister_interest(const char *name, update_cb update,int id, void *data);

TRANSFORMER_EXPORT int        register_type_interest(int typ, update_cb update, int id, void *data);

TRANSFORMER_EXPORT int        deregister_type_interest(int typ, update_cb update, int id, void *data);

TRANSFORMER_EXPORT void       free_array(int argc, char *argv[]);

typedef int     (*provider_cb)(int peer, char *name, int isrequest);

#define PROVIDER_DENY    -1

#define PROVIDER_OK       0

#define TF_LISTENER_DEFAULT           0

#define TF_LISTENER_WILDNOW           2 

#define TF_LISTENER_WILDNEXT          4   

#define TF_LISTENER_WILDREMOVE        8

#define TF_LISTENER_WILDCARD          (TF_LISTENER_WILDNOW|TF_LISTENER_WILDNEXT)

#define TF_LISTENER_NOASKPEERS        16    

#define TF_LISTENER_NOASKMODULES      32

#define TF_LISTENER_ACCESSORY         (1|TF_LISTENER_NOASKPEERS|TF_LISTENER_NOASKMODULES)

#define TF_LISTENER_PROVIDEONCE       64

#define TF_LISTENER_NOREGEX       128

#define TF_LISTENER_ONCE          256

TRANSFORMER_EXPORT tf_handle_t   *tf_add_listener(const char *pattern, int listener_typeflags, tf_update_cb update, tf_nodata_cb nodata, tf_status_cb status, int val, void *data, tf_finalize_cb finalize);

TRANSFORMER_EXPORT tf_handle_t   *tf_add_listener_get_cache(const char *pattern, int listener_typeflags, tf_update_cb update, tf_nodata_cb nodata, tf_status_cb status, int val, void *data, tf_finalize_cb finalize, ds_data_t **dsdata_ptr);

TRANSFORMER_EXPORT tf_handle_t   *tf_add_listener_nspace(ds5_namespace_t *nspace, int listener_typeflags, tf_update_cb update, tf_nodata_cb nodata, tf_status_cb status, int val, void *data, tf_finalize_cb finalize);


TRANSFORMER_EXPORT tf_handle_t   *tf_add_type_listener(int data_type, int listener_typeflags, tf_update_cb update, tf_nodata_cb nodata, tf_status_cb status, int val, void *data, tf_finalize_cb finalize);

TRANSFORMER_EXPORT tf_handle_t   *tf_add_provider(const char *pattern, int provider_typeflags, tf_request_cb request, tf_discard_cb discard, int val, void *data, tf_finalize_cb finalize);
TRANSFORMER_EXPORT tf_handle_t   *tf_add_provider_nspace(ds5_namespace_t *nspace, int provider_typeflags, tf_request_cb request, tf_discard_cb discard, int val, void *data, tf_finalize_cb finalize);

TRANSFORMER_EXPORT void           tf_handle_delete(tf_handle_t *handle);

TRANSFORMER_EXPORT int            tf_handle_set_listener_params(tf_handle_t *handle, tf_update_cb update, tf_nodata_cb nodata, tf_status_cb status, int val, void *data);

TRANSFORMER_EXPORT int            tf_handle_set_provider_params(tf_handle_t *handle, tf_request_cb request, tf_discard_cb discard, int val, void *data);

TRANSFORMER_EXPORT void           tf_handle_set_listener_data(tf_handle_t *handle, void *data);

TRANSFORMER_EXPORT int            tf_handle_set_update_cb(tf_handle_t *handle, tf_update_cb update);

TRANSFORMER_EXPORT int            tf_handle_set_nodata_cb(tf_handle_t *handle, tf_nodata_cb nodata);

TRANSFORMER_EXPORT int            tf_handle_set_status_cb(tf_handle_t *handle, tf_status_cb status);

TRANSFORMER_EXPORT int            tf_handle_set_request_cb(tf_handle_t *handle, tf_request_cb request);

TRANSFORMER_EXPORT int            tf_handle_set_discard_cb(tf_handle_t *handle, tf_discard_cb discard);

TRANSFORMER_EXPORT int            tf_handle_set_listener_finalize_cb(tf_handle_t *handle, tf_finalize_cb finalize);

TRANSFORMER_EXPORT int            tf_handle_set_callback_params(tf_handle_t *handle, int id, void *data);


TRANSFORMER_EXPORT ds5_namespace_t  *tf_create_globbed_namespace(const char *globbed);
TRANSFORMER_EXPORT ds5_namespace_t  *tf_create_regex_namespace(const char *expr);
TRANSFORMER_EXPORT int               tf_regex_namespace_add_expr(ds5_namespace_t *nspace, const char *expr, int exclude);



typedef enum _authdirection
{
    MAP_FORWARD = 0,   
    MAP_REVERSE = 1    
} authdirection_t;

struct _authfuncs
{
    int        (*map_object)(int peer, char *orig, char *destbuf, int destlen, authdirection_t direction);
    int        (*request_object)(int peer, char *orig, char *mapname, void **userptr);
    int        (*discard_object)(int peer, char *orig, char *mapname, void **userptr);
    int       *(*return_peers)(char *name, int *peers_num);
    ds_data_t *(*map_fields)(int peerno, char *basename, ds_data_t *orig, void **userptr, int *cancel_sub);
};

TRANSFORMER_EXPORT void        auth_register_functions(authfuncs_t *auth);

TRANSFORMER_EXPORT void        auth_deregister_functions();

TRANSFORMER_EXPORT void        auth_invalidate_perms();

TRANSFORMER_EXPORT void        auth_invalidate_peer_perms(int peernum);

TRANSFORMER_EXPORT int         tf_register_function(const char *name, void *function);

TRANSFORMER_EXPORT void       *tf_find_function(const char *name);;

TRANSFORMER_EXPORT int        file_reading();

TRANSFORMER_EXPORT void       file_write_pkt(FILE *fp, ds_data_t *pkt, time_t tim);

TRANSFORMER_EXPORT void       mod_config_parse_file(const char *file);

TRANSFORMER_EXPORT void       mod_config_parse_optional_file(const char *file);

TRANSFORMER_EXPORT char      *filename_expand(char *format);

TRANSFORMER_EXPORT  ds_log_t  *rtas_log;

TRANSFORMER_EXPORT  int        c_debug_level;

#define DBG(level) ( ( c_debug_level >= (level) ) )

enum
{
    DBG_CRIT = 1,
    DBG_ERROR,
    DBG_NOTIFY,
    DBG_WARN,
    DBG_INFO,
    DBG_DEBUG
};

TRANSFORMER_EXPORT int        debug_level(char *text);

TRANSFORMER_EXPORT char      *debug_string(int level);

#define PACKET_STORE        1

#define PACKET_PUBLISH      2

#define PACKET_OWRITE       4

#define PACKET_FREE         8

#define PACKET_NOLISTEN    32

#define PACKET_UPDATE     128

#define PACKET_NOFEEDTIME 256

TRANSFORMER_EXPORT char      *packet_get_field_byname(ds_data_t *pkt, const char *field);

TRANSFORMER_EXPORT char      *packet_get_field(ds_data_t *pkt, int fid);

TRANSFORMER_EXPORT int        packet_update(ds_data_t *dest, ds_data_t *src);

TRANSFORMER_EXPORT int        packet_merge(ds_data_t *dest, ds_data_t *src, int *newfields);

TRANSFORMER_EXPORT int        packet_update_field_byname(ds_data_t *dest, const char *field, const char *value);

TRANSFORMER_EXPORT int        packet_update_field(ds_data_t *dest, int fid, const char *value);

TRANSFORMER_EXPORT ds_data_t *packet_clone(ds_data_t *src);

TRANSFORMER_EXPORT int        packet_delete_field(ds_data_t *pkt, int index);

TRANSFORMER_EXPORT void       packet_contrib(ds_data_t *pkt,void *data,int storeflags);

TRANSFORMER_EXPORT void       packet_log_dump(ds_log_t *log,const char *label,ds_data_t *pkt);

TRANSFORMER_EXPORT void       register_provider(const char *wildcard, provider_cb provider);

TRANSFORMER_EXPORT void       deregister_provider(const char *wildcard, provider_cb provider);

#define SYMBOL_PUBLISH      2

#define SYMBOL_NOSAVE      16

#define SYMBOL_NOLISTEN    32

TRANSFORMER_EXPORT int        symbol_create(const char *name, unsigned flags);

TRANSFORMER_EXPORT ds_data_t *symbol_last_update(const char *name);

TRANSFORMER_EXPORT time_t     symbol_last_updatetime(const char *name);

TRANSFORMER_EXPORT ds_data_t *symbol_last_mmaker_update(const char *name, const char *mmaker);

TRANSFORMER_EXPORT char     **symbol_return_mmakers(const char *name, int *num);

TRANSFORMER_EXPORT char      *symbol_last_field_byname(const char *name, const char *field);

TRANSFORMER_EXPORT char      *symbol_last_field(const char *name, int fid);

TRANSFORMER_EXPORT char     **symbol_historic_field(const char *name, int fid, int *number);

TRANSFORMER_EXPORT void       symbol_add_constant(const char *name, int fid, const char *value);

TRANSFORMER_EXPORT char      *symbol_get_constant(const char *name, int fid);

TRANSFORMER_EXPORT char     **symbol_match(const char *name, int *num);

TRANSFORMER_EXPORT char     **symbol_match_bytype(const char *name, int type, int *number);

TRANSFORMER_EXPORT void       symbol_delete_type2(const char *name, const char *index, int fieldnum);

TRANSFORMER_EXPORT void       symbol_delete_all_mmaker(const char *name);

TRANSFORMER_EXPORT void       symbol_delete_mmaker(const char *symname, const char *mmaker);

TRANSFORMER_EXPORT void       symbol_send_nodata(const char *symname, u_short flags);

TRANSFORMER_EXPORT int        symbol_get_type(const char *objname);

TRANSFORMER_EXPORT int        symbol_request(const char *name, update_cb update,int id, void *data);

TRANSFORMER_EXPORT int        symbol_discard(const char *name, update_cb update,int id, void *data);

TRANSFORMER_EXPORT int        tf_symbol_get_type(const char *objname);

TRANSFORMER_EXPORT int        tf_symbol_get_status(const char *name, char **status_message_ptr);

TRANSFORMER_EXPORT void       tf_symbol_send_status(const char *name, int status, const char *message);

TRANSFORMER_EXPORT ds_data_t *symbol_last_permission_update(const char *name, const char *key);

TRANSFORMER_EXPORT char     **symbol_return_permission_keys(const char *name, int *num);

TRANSFORMER_EXPORT void       symbol_delete_permission_key(const char *name, const char *index);

TRANSFORMER_EXPORT void       symbol_delete_all_permission_keys(const char *name);

TRANSFORMER_EXPORT char     **tf_symbol_match(const char *pattern, int *number);

TRANSFORMER_EXPORT char     **tf_symbol_match_bytype(const char *pattern, int type, int *number);

TRANSFORMER_EXPORT void       symbol_unset_flag(const char *subject, unsigned int flags);

TRANSFORMER_EXPORT void       symbol_set_flag(const char *subject, unsigned int flags);


struct _userinfo
{
    unsigned int  id;
    char         *ident;
    char         *desc;
    int         (*strprint)(char *dest, size_t len, void *data);
    void        (*filewrite)(FILE *fp, void *data);
    void       *(*fileread)(FILE *fp, char *name);
};

TRANSFORMER_EXPORT void      *symbol_get_userdata(const char *name,unsigned int id);

TRANSFORMER_EXPORT void       symbol_remove_alluserdata(const char *wildcard,unsigned int id, void (*dataremover)(void *data));

TRANSFORMER_EXPORT void       symbol_remove_userdata(const char *name,unsigned  int id);

TRANSFORMER_EXPORT void       symbol_set_userdata(const char *name, unsigned int id, void *ptr);

TRANSFORMER_EXPORT void       register_userdata_funcs(userinfo_t *user);

TRANSFORMER_EXPORT void       deregister_userdata_funcs(unsigned int id);

typedef void      (*udpcmd_t)(int argc,char *argv[]);

TRANSFORMER_EXPORT int        udpsignal_addjob(const char *cmd, udpcmd_t callback, const char *msg);

TRANSFORMER_EXPORT int        udpsignal_deljob(const char *cmd, udpcmd_t callback);

TRANSFORMER_EXPORT void       udpsignal_send(const char *message);

TRANSFORMER_EXPORT void       udpsignal_send_argv(const char *command, char *argv[]);

#define CMD_DUMP_MEMORY       "memory_write"

#define CMD_RESTORE_MEMORY    "memory_read"

#define CMD_SYMBOL_DEL_PKTS   "symbol_delete"

#define CMD_SYMBOL_PUBLISH    "symbol_publish"

#define CMD_SOURCE_UP          "source_up"

#define CMD_SOURCE_DOWN        "source_down"

TRANSFORMER_MODULE_EXPORT void         mod_init(char *module_name);

TRANSFORMER_EXPORT char * mon_module_setup(const char *name,const char *description,const char *version);

#ifdef __cplusplus
}
#endif

#endif /* __TRANSFORMER_H__ */