DataSource for C SDK  7.1.25.59931-c880adcd
datasrc.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright CAPLIN Systems Ltd 2000-2007
4  *
5  *
6  * $Author$
7  * $DateTime$
8  * $Change$
9  * $Id$
10  *
11  *
12  */
13 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17 
18 
19 #ifndef __DATASRC_H__
20 #define __DATASRC_H__
21 
22 
23 #undef DATASRC_MAJOR_VERSION
24 #undef DATASRC_MINOR_VERSION
25 #undef DATASRC_PATCH_VERSION
26 
27 #define DATASRC_MAJOR_VERSION 7
28 #define DATASRC_MINOR_VERSION 1
29 #define DATASRC_PATCH_VERSION 25
30 
31 
32 #include <stdio.h>
33 #include <stdlib.h>
34 
35 #ifdef WIN32
36 
37 #include <winsock2.h>
38 #include <windows.h>
39 #include <time.h>
40 #include <ws2tcpip.h>
41 #include <direct.h>
42 #include <io.h>
43 #include <mswsock.h>
44 
45 #else /* ! WIN32 */
46 
47 #include <sys/time.h>
48 #include <sys/types.h>
49 #include <unistd.h>
50 #include <netinet/in.h>
51 #include <sys/socket.h>
52 #include <arpa/inet.h>
53 #include <netdb.h>
54 #include <sys/ioctl.h>
55 #include <net/if.h>
56 #include <sys/uio.h>
57 #include <sys/timeb.h>
58 #include <utime.h>
59 
60 #endif /* ! WIN32 */
61 
62 #include <limits.h>
63 #include <sys/stat.h>
64 #include <string.h>
65 #include <fcntl.h>
66 #include <stdarg.h>
67 #include <errno.h>
68 
69 
70 
71 #define EXIT_CODE_NML 0
72 #define EXIT_CODE_CFG 1
73 #define EXIT_CODE_LOG 2
74 #define EXIT_CODE_NET 3
75 #define EXIT_CODE_SYS 4
76 #define EXIT_CODE_LIC 5
77 #define EXIT_CODE_SIG 6
78 #define EXIT_CODE_SVC 7
79 #define EXIT_CODE_SSL 8
80 #define EXIT_CODE_JVM 9
81 
82 /* Reserve codes for binary start-up issues */
83 #define EXIT_CODE_BIN_MISSING 10
84 #define EXIT_CODE_BIN_NOT_EXEC 11
85 #define EXIT_CODE_BIN_EXIT AFTER_FORK 12
86 #define EXIT_CODE_BIN_BAD_ARCH 126
87 
88 /* Reserve an exit code for Java DataSource blade errors */
89 #define EXIT_CODE_JAVA_DATASOURCE_ERROR 201
90 
91 #define EXIT_CODE_GRACEFUL 202
92 
93 #ifndef WIN32
94 #ifndef DATASRCAPI
95 #define DATASRCAPI
96 #endif
97 #else /* WIN32 */
98 #ifndef DATASRCAPI
99 #ifndef DATASRC_EXPORT
100 #define DATASRCAPI _declspec(dllimport)
101 #else
102 #define DATASRCAPI _declspec(dllexport)
103 #endif
104 #endif
105 #endif /* WIN32 */
106 
107 
108 /* Provide some protection for variadic arguments */
109 #ifdef __GNUC__
110 #define PRINTF(fmt,arg) __attribute__ ((__format__ (__printf__, (fmt), (arg))))
111 #else
112 #define PRINTF(fmt,arg)
113 #endif
114 
115 
121 /* Types */
122 
127 #ifndef WIN32
128 typedef int sock_t;
129 
136 #define INVALID_SOCKET -1
137 
143 #define SOCKET_ERROR -1
144 #else /* WIN32 */
145 
146 typedef SOCKET sock_t;
147 #include <inttypes.h>
148 #endif /* WIN32 */
149 
153 typedef struct _ds_peer_set ds_set_t;
154 
155 typedef uint64_t ds_bitfield_t;
156 
157 typedef struct _ds_data ds_data_t;
158 
159 typedef struct _ds_field ds_field_t;
160 
164 typedef struct _ds_delay ds_delay_t;
165 
166 
170 typedef struct _config_ctx ds_config_ctx_t;
171 
175 typedef struct _ds_log ds_log_t;
176 
191 typedef void (*recv_update_t)(int peer, ds_data_t *pkt);
192 
209 typedef void (*recv_replay_t)(int peer, ds_data_t *pkt, time_t tm);
210 
229 typedef void (*recv_nodata_t)(int peer, char *subject, unsigned short flags);
230 
253 typedef void (*recv_peer_status_t)(int peer, int status, int val, void *data);
254 
273 typedef void (*recv_request_t)(int peer, int count, char **subjects, unsigned short flags);
274 
293 typedef void (*recv_discard_t)(int peer, int count, char **subjects, unsigned short flags);
294 
314 typedef void (*recv_object_status_t)(int peer, char *subject, int status, unsigned short code, char *msgstr);
315 
325 typedef void (*recv_service_status_t)(char *service, int status);
326 
327 
337 typedef void (*recv_map_t)(int peer, char *from, char *to);
338 
339 
357 typedef struct
358  {
361  char *log_root;
362  unsigned short flags;
363  unsigned short type;
379  void (*exit_func)(int exit_code, char *msg);
381  char *logfile;
383  }
384 ds_init_t;
385 
390 #define DS_INITIALISER \
391  { \
392  NULL, /* application_name */ \
393  NULL, /* application_root */ \
394  NULL, /* log_root */ \
395  0, /* flags */ \
396  0, /* type */ \
397  NULL, /* recv_request */ \
398  NULL, /* recv_discard */ \
399  NULL, /* recv_update */ \
400  NULL, /* recv_nodata */ \
401  NULL, /* recv_peer_status */ \
402  NULL, /* recv_object_status */ \
403  NULL, /* recv_service_status */ \
404  NULL, /* recv_map */ \
405  NULL, /* exit_func */ \
406  NULL, /* logfile */ \
407  NULL, /* log */ \
408  }
409 
410 
411 /* datasrc */
412 
413 DATASRCAPI void ds_reserve_std_fds(void);
414 DATASRCAPI void ds_config_init(const char *file, int argc, char **argv);
415 DATASRCAPI int ds_init(ds_init_t *init, int argc, char **argv);
416 DATASRCAPI void ds_thread_init(int event_module, int flags);
417 DATASRCAPI char *ds_filename_expand(const char *format, char *buffer, size_t bufsize);
418 DATASRCAPI ds_log_t *ds_get_event_log(void);
419 
420 
421 /* ds5 */
422 
423 
428 
433  {
439  void (*free)(ds5_namespace_t *nspace);
440 
449  int (*match)(ds5_namespace_t *nspace, const char *subject);
450 
451 
460  char *(*describe)(ds5_namespace_t *nspace, char *buf, size_t buflen);
461 
462  };
463 
464 
465 DATASRCAPI ds5_namespace_t *ds5_create_prefix_namespace(const char *prefix);
466 
467 DATASRCAPI ds5_namespace_t *ds5_create_globbed_namespace(const char *globbed);
468 DATASRCAPI ds5_namespace_t *ds5_create_regex_namespace(const char *expr);
469 DATASRCAPI int ds5_regex_namespace_add_expr(ds5_namespace_t *nspace, const char *expr, int exclude);
470 
471 
472 /* Macros for convenience */
473 
481 #define ds5_namespace_match(nspace, subject) nspace->match(nspace, subject)
482 
487 #define ds5_namespace_free(nspace) nspace->free(nspace)
488 
489 
490 
491 
492 
501 typedef struct _ds5_publisher_s ds5_publisher_t;
502 
503 
504 
505 
506 
507 
508 
519 typedef struct
520  {
539  void (*receive_request)(void *context, int peer, const char *subject);
540 
561  void (*receive_discard)(void *context, int peer, const char *subject);
562  }
564 
565 
566 DATASRCAPI ds5_publisher_t *ds5_create_active_publisher(ds5_namespace_t *nspace, ds5_dataprovider_t *provider, void *context);
567 DATASRCAPI ds5_publisher_t *ds5_create_compatibility_publisher(ds5_namespace_t *nspace, ds5_dataprovider_t *provider, void *context);
569 
571 DATASRCAPI void ds5_publish_to_subscribed_peers(ds5_publisher_t *pub, ds_data_t *dsdata);
572 DATASRCAPI void ds5_publish_response(ds5_publisher_t *pub, ds_data_t *dsdata);
573 DATASRCAPI void ds5_publish_response_no_free(ds5_publisher_t *pub, ds_data_t *dsdata);
574 DATASRCAPI void ds5_publish_status(ds5_publisher_t *pub, const char *subject, int status, const char *message);
575 DATASRCAPI void ds5_publish_status_all(ds5_publisher_t *pub, int status, const char *message);
576 DATASRCAPI void ds5_publish_subject_error(ds5_publisher_t *publisher, const char *subject, int flags);
577 DATASRCAPI void ds5_publish_to_peer(ds5_publisher_t *publisher, int peernum, ds_data_t *dsdata);
578 DATASRCAPI void ds5_publish_to_peer_no_free(ds5_publisher_t *publisher, int peernum, ds_data_t *dsdata);
579 DATASRCAPI void ds5_publish_subject_map(ds5_publisher_t *publisher, const char *subject, const char *mapped_to, int flags);
580 
581 
595 typedef struct
596  {
607  void (*service_status)(void *context, const char *service_name, int state);
608 
620  void (*peer_status)(void *context, int peer_index, const char *peer_name, int state);
621  }
623 
624 
634 typedef struct _ds5_subscription_s ds5_subscription_t;
635 
636 
649 typedef struct
650  {
660  void (*record_updated)(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata);
661 
671  void (*record_type2_updated)(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata);
672 
682  void (*record_type3_updated)(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata);
683 
693  void (*container_updated)(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata);
694 
704  void (*permission_updated)(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata);
705 
715  void (*news_updated)(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata);
716 
726  void (*news_story_updated)(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata);
727 
737  void (*page_updated)(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata);
738 
751  void (*unknown_subject_type_updated)(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata);
752 
753 
764  void (*subscription_error)(void *context, ds5_subscription_t *sub, int peer, const char *subject, short flags);
765 
777  void (*subscription_status)(void *context, ds5_subscription_t *sub, int peer, const char *subject, int status, const char *message);
778  }
780 
781 
782 
783 
784 
785 DATASRCAPI void ds5_config_init(const char *configfile, int argc, char **argv);
786 DATASRCAPI int ds5_init(int argc, char **argv);
787 DATASRCAPI void ds5_add_connectionlistener(ds5_connectionlistener_t *connection_listener, void *context);
788 
789 
790 
791 
793 DATASRCAPI ds5_subscription_t *ds5_create_active_subscription(const char *subject, ds5_subscriptionlistener_t *listener, void *context);
794 DATASRCAPI void ds5_unsubscribe(ds5_subscription_t *sub);
795 
796 
797 
798 /* config */
799 
800 
809 #define DS_OFFSET(t,m) ((void *)&((t *)0)->m)
810 
814 #define DS_CONFIG_BOOL 0x0001
815 
820 #define DS_CONFIG_INT 0x0002
821 
825 #define DS_CONFIG_FLOAT 0x0003
826 
830 #define DS_CONFIG_STR 0x0004
831 
835 #define DS_CONFIG_CHAR 0x0005
836 
840 #define DS_CONFIG_FUNC 0x0006
841 
845 #define DS_CONFIG_FILE 0x0007
846 
850 #define DS_CONFIG_LONG 0x0008
851 
854 #define DS_CONFIG_GROUP 0x0010
855 #define DS_CONFIG_GROUP_END 0x0011
856 #define DS_CONFIG_SECTION 0x0020
857 #define DS_CONFIG_SECTION_END 0x0021
858 
862 #define DS_CONFIG_JAVA 0x0080
863 
867 #define DS_CONFIG_ARRAY 0x0100
868 
873 #define DS_CONFIG_INT_ARRAY (DS_CONFIG_ARRAY|DS_CONFIG_INT)
874 
878 #define DS_CONFIG_FLOAT_ARRAY (DS_CONFIG_ARRAY|DS_CONFIG_FLOAT)
879 
880 
884 #define DS_CONFIG_STR_ARRAY (DS_CONFIG_ARRAY|DS_CONFIG_STR)
885 
889 #define DS_CONFIG_CHAR_ARRAY (DS_CONFIG_ARRAY|DS_CONFIG_CHAR)
890 
894 #define DS_CONFIG_STRICT 0x0200
895 
900 #define DS_CONFIG_DEPRECATED 0x0400
901 
902 
924 typedef struct
925  {
926  char *name;
927  double value;
928  char *docstring;
929  }
931 
932 
945 typedef void (*ds_config_func)(char *name, int num, char **values);
946 
947 
948 DATASRCAPI ds_config_ctx_t *ds_config_new_ctx(void);
949 DATASRCAPI void ds_config_free_ctx(ds_config_ctx_t *ctx);
951 DATASRCAPI void ds_config_add_search(const char *path);
952 DATASRCAPI void ds_config_add_file(const char *file);
953 DATASRCAPI void ds_config_add_optional_file(const char *file);
954 DATASRCAPI void ds_config_add_option(char opt, const char *longopt, const char *help, int type, void *value);
955 DATASRCAPI void ds_config_add_bounded_option(char sopt,const char *longopt, const char *help, int type, void *value, void *min, void *max);
956 DATASRCAPI void ds_config_add_option_enum(char opt,const char *longopt, const char *help, int type, void *value, ds_config_enum_t *enums);
957 DATASRCAPI void ds_config_add_bounded_option_enum(char sopt,const char *longopt, const char *help, int type, void *value, ds_config_enum_t *enums, void *min, void *max);
958 DATASRCAPI void ds_config_add_array_option(const char *longopt, const char *help, int type, void *value, int *num);
959 DATASRCAPI void ds_config_add_bounded_array_option(const char *longopt,const char *help, int type, void *value, int *num, void *min, void *max);
960 DATASRCAPI void ds_config_add_array_option_enum(const char *longopt,const char *help, int type, void *value, int *num, ds_config_enum_t *enums);
961 DATASRCAPI void ds_config_add_bounded_array_option_enum(const char *longopt,const char *help, int type, void *value, int *num, ds_config_enum_t *enums, void *min, void *max);
962 DATASRCAPI void ds_config_del_option(const char *longopt);
963 DATASRCAPI void ds_config_add_group(const char *longopt, const char *help, void *base, void *def, size_t size, int *num);
964 DATASRCAPI void ds_config_add_group_with_info(const char *longopt, const char *help, void *base, void *def, size_t size, int *num, int file_offset, int line_offset);
965 DATASRCAPI void ds_config_end_group(const char *longopt,const char *help);
966 DATASRCAPI void ds_config_add_section(const char *longopt,const char *help);
967 DATASRCAPI void ds_config_end_section(const char *longopt,const char *help);
968 DATASRCAPI void ds_config_parse_files(void);
969 DATASRCAPI void ds_config_parse_args(int argc, char **argv, int *retargc);
970 DATASRCAPI int ds_config_parse_file(const char *unresolved_filename);
971 DATASRCAPI void ds_config_list_options(void);
972 DATASRCAPI void ds_config_list_values(void);
973 DATASRCAPI int ds_config_get_enum(const char *value, ds_config_enum_t *enums);
974 DATASRCAPI void ds_config_add_error_message_fmt(const char *fmt,...) PRINTF(1,2);
975 DATASRCAPI void ds_config_add_config_reading_message_fmt(const char *fmt,...) PRINTF(1,2);
976 DATASRCAPI void ds_config_add_error_message(const char *msg);
977 DATASRCAPI char *ds_config_get_filename(void);
978 DATASRCAPI int ds_config_get_linenumber(void);
979 DATASRCAPI void ds_config_set_test(const char *tag, char **value);
980 DATASRCAPI void ds_config_del_test(const char *tag);
981 DATASRCAPI void ds_config_set_option(const char *name, const char *value);
982 
983 
984 /* event */
985 
986 
987 typedef unsigned long ds_reltime_t;
988 
993 typedef struct _ds_timed_event ds_timed_event_t;
994 
995 
1000 typedef struct _ds_io_event ds_except_event_t;
1001 
1002 
1003 
1008 typedef struct _ds_io_event ds_read_event_t;
1009 
1010 
1015 typedef struct _ds_io_event ds_write_event_t;
1016 
1017 
1022 typedef struct _ds_io_event ds_generic_event_t;
1023 
1024 
1035 typedef int (*ds_io_event_cb)(sock_t sock, int val, void *data);
1036 
1047 typedef int (*ds_timed_event_cb)(int id, int val, void *data);
1048 
1049 
1050 #define DOUBLE_TO_RELTIME(r,d) r = ((int)(d) << 9) + ((int)(((d) - (int)(d)) * 1000000) >> 11);
1051 #define TIMEVAL_TO_RELTIME(r,tv) r = ((tv).tv_sec << 9) + ((tv).tv_usec >> 11);
1052 
1053 
1054 DATASRCAPI ds_timed_event_t *ds_add_timed_event(int id, double delay, ds_timed_event_cb cb, int val, void *data);
1055 DATASRCAPI ds_read_event_t *ds_add_read_event(sock_t fd, ds_io_event_cb cb, int val, void *data);
1056 DATASRCAPI ds_write_event_t *ds_add_write_event(sock_t fd, ds_io_event_cb cb, int val, void *data);
1057 DATASRCAPI ds_except_event_t *ds_add_except_event(sock_t fd, ds_io_event_cb cb, int val, void *data);
1058 
1059 DATASRCAPI int ds_del_timed_event(ds_timed_event_t *ev);
1060 DATASRCAPI int ds_del_read_event(ds_read_event_t *ev);
1061 DATASRCAPI int ds_del_write_event(ds_write_event_t *ev);
1062 DATASRCAPI int ds_del_except_event(ds_except_event_t *ev);
1063 
1064 DATASRCAPI int ds_del_timed_event_free_data(ds_timed_event_t *ev, void (*free_data)(int, void *));
1065 DATASRCAPI int ds_del_read_event_free_data(ds_read_event_t *ev, void (*free_data)(int, void *));
1066 DATASRCAPI int ds_del_write_event_free_data(ds_write_event_t *ev, void (*free_data)(int, void *));
1067 DATASRCAPI int ds_del_except_event_free_data(ds_except_event_t *ev, void (*free_data)(int, void *));
1068 
1069 DATASRCAPI void ds_timed_event_set_callback(ds_timed_event_t *ev, ds_timed_event_cb cb, int val, void *data);
1070 DATASRCAPI double ds_timed_event_get_fire_time(ds_timed_event_t *ev);
1071 DATASRCAPI void ds_read_event_set_callback(ds_read_event_t *ev, ds_io_event_cb cb, int val, void *data);
1072 DATASRCAPI void ds_write_event_set_callback(ds_write_event_t *ev, ds_io_event_cb cb, int val, void *data);
1073 
1074 DATASRCAPI void ds_set_timed_delay(ds_timed_event_t *ev, double delay);
1075 DATASRCAPI void ds_set_timed_delay_next(ds_timed_event_t *ev, double delay);
1076 
1077 DATASRCAPI void ds_loop(void);
1078 DATASRCAPI void ds_stop(void);
1079 
1080 DATASRCAPI ds_reltime_t ds_get_relative_time(void);
1081 DATASRCAPI time_t ds_get_time(void);
1082 DATASRCAPI struct tm *ds_gmtime(void);
1083 DATASRCAPI struct tm *ds_localtime(void);
1084 DATASRCAPI int ds_get_gmt_offset(time_t t);
1085 DATASRCAPI char *ds_get_timezone(char *buf, int len);
1086 
1087 DATASRCAPI ds_timed_event_t *ds_add_periodic_event(int starttime, int period, int id, ds_timed_event_cb cb, int val, void *data);
1088 DATASRCAPI ds_timed_event_t *ds_add_periodic_event_from_time(time_t then, int starttime, int period, int id, ds_timed_event_cb cb, int val, void *data);
1089 DATASRCAPI int ds_check_periodic_event(int period, ds_timed_event_t **tev);
1090 
1091 
1092 /* cache */
1093 
1098 #define DS_CACHE_DATASRC -1
1099 
1100 DATASRCAPI void ds_cache_add_object(char *subject);
1101 
1102 
1103 /* daemon */
1104 
1105 
1106 DATASRCAPI void ds_daemon_redirect(void);
1107 DATASRCAPI int ds_daemon_disabled(void);
1108 
1109 
1110 /* fields */
1111 
1112 
1120 #define DS_FIELDS_SEPARATOR -65536
1121 
1127 #define DS_FIELDS_NOT_DEFINED (-2147483647 - 1)
1128 
1129 DATASRCAPI int ds_fields_max(void);
1130 DATASRCAPI int ds_fields_add(int num, const char *name, int flags, int dp, const char *fmt);
1131 DATASRCAPI int ds_fields_numbyname(const char *name);
1132 DATASRCAPI char *ds_fields_namebynum(int num);
1133 DATASRCAPI int ds_fields_indexbyname(const char *name);
1134 DATASRCAPI int ds_fields_indexbynum(int num);
1135 DATASRCAPI int ds_fields_numbyindex(int index);
1136 DATASRCAPI char *ds_fields_namebyindex(int index);
1137 DATASRCAPI char *ds_fields_rttpnumbyindex(int index);
1138 DATASRCAPI int ds_fields_getflags(int index);
1139 DATASRCAPI int ds_fields_getdp(int index);
1140 
1141 
1142 
1143 /* log */
1144 
1148 #define DS_LOG_CONFIG 0
1149 #define DS_LOG_ALWAYS 1
1150 
1153 #define DS_LOG_CRIT 2
1154 
1157 #define DS_LOG_ERROR 3
1158 
1161 #define DS_LOG_NOTIFY 4
1162 
1165 #define DS_LOG_WARN 5
1166 
1169 #define DS_LOG_INFO 6
1170 
1173 #define DS_LOG_DEBUG 7
1174 
1177 #define DS_LOG_FINER 8
1178 
1181 #define DS_LOG_FINEST 9
1182 
1185 #define DS_LOG_MONITOR 128
1186 
1189 #define DS_LOG_TERMINAL 256
1190 
1193 #define DS_LOG_SYSLOG 512
1194 #define DS_LOG_FILEONLY 1024
1195 #define DS_LOG_NO_MONITOR 2048
1196 
1204 typedef void (*ds_loglevelchange_t)(ds_log_t *log, int new_level);
1205 
1212 typedef void (*ds_logcycled_t)(ds_log_t *log);
1213 
1214 
1215 
1216 
1217 DATASRCAPI ds_log_t *ds_new_log(const char *name,const char *logname);
1218 DATASRCAPI ds_log_t *ds_new_level_log(const char *name, const char *logname, ds_loglevelchange_t change_cb);
1219 DATASRCAPI ds_log_t *ds_new_headed_log(const char *name, const char *logname, const char *header);
1220 DATASRCAPI void ds_free_log(ds_log_t *log);
1221 DATASRCAPI void ds_write(ds_log_t *log, void *data, size_t len);
1222 #ifndef WIN32
1223 DATASRCAPI void ds_writev(ds_log_t *log, struct iovec *vector, int count);
1224 #endif
1225 DATASRCAPI void ds_printf(ds_log_t *log, const char *fmt, ...) PRINTF(2,3);
1226 DATASRCAPI void ds_printf_time(ds_log_t *log, const char *fmt, ...) PRINTF(2,3);
1227 DATASRCAPI void ds_printf_time_ap(ds_log_t *log, const char *extra, const char *fmt, va_list ap);
1228 DATASRCAPI void ds_syslog(ds_log_t *log, int priority, const char *fmt, ...) PRINTF(3,4);
1229 DATASRCAPI void ds_cycle_all_logs(const char *suffix, long maxsize);
1230 DATASRCAPI int ds_cycle_log(ds_log_t *log, const char *suffix, long maxsize);
1231 DATASRCAPI int ds_debug_level(const char *text);
1232 DATASRCAPI char *ds_debug_string(int level);
1233 DATASRCAPI char *ds_debug_config_string(int level);
1234 DATASRCAPI void ds_log(ds_log_t *log, int level, const char *fmt,...) PRINTF(3,4);
1235 DATASRCAPI int ds_log_set_log_level(ds_log_t *log, const char *level);
1236 DATASRCAPI void ds_log_change_level_callback(ds_log_t *log, ds_loglevelchange_t change_cb);
1238 DATASRCAPI char *ds_log_getfilename(ds_log_t *log);
1239 DATASRCAPI char *ds_log_getname(ds_log_t *log);
1240 DATASRCAPI int ds_log_get_level(ds_log_t *log);
1241 DATASRCAPI int ds_log_flush(ds_log_t *log);
1242 
1243 
1244 /* lty_chain */
1245 
1246 
1256 DATASRCAPI void ds_add_latency_chain(ds_data_t *dsdata, char suffix, struct timespec *tp);
1257 
1269 DATASRCAPI void ds_add_latency_chain2(ds_data_t *dsdata, char suffix, struct timespec tp, char suffix2, struct timespec *tp2);
1270 
1275 DATASRCAPI void ds_add_latency_initial_timestamp(ds_data_t *dsdata);
1276 
1277 /* monitor */
1278 
1279 
1283 #define TYPE_NONE 0
1284 
1288 #define TYPE_BINARY 1
1289 
1292 #define TYPE_STRING 2
1293 
1296 #define TYPE_SHORT 3
1297 
1300 #define TYPE_USHORT 4
1301 
1304 #define TYPE_LONG 5
1305 
1308 #define TYPE_ULONG 6
1309 
1312 #define TYPE_LLONG 7
1313 
1316 #define TYPE_ULLONG 8
1317 
1320 #define TYPE_DOUBLE 9
1321 
1326 #define TYPE_TIMESTAMP 10
1327 
1332 #define TYPE_BOOLEAN 11
1333 
1337 #define TYPE_RELATION 20
1338 
1342 #define TYPE_SUBSCRIPTION 21
1343 
1344 
1348 #define TYPE_PRIMITIVE_MASK 31
1349 
1353 #define TYPE_ARRAY 32
1354 
1357 #define TYPE_ACTIVE 64
1358 
1368 #define TYPE_ACTIVE2 128
1369 
1372 #define TYPE_METHOD 256
1373 
1376 #define TYPE_KEY 512
1377 
1380 #define TYPE_HIERARCHY 1024
1381 
1387 #define TYPE_OPTIONAL 2048
1388 
1389 
1395 typedef struct {
1396  size_t size;
1397  union _ds_mondata_value {
1398  void *b;
1399  char **c;
1400  int16_t *s;
1401  uint16_t *us;
1402  int32_t *l;
1403  uint32_t *ul;
1404  int64_t *ll;
1405  uint64_t *ull;
1406  double *d;
1407  } data;
1408  }
1409 ds_array_t;
1410 
1416 typedef struct
1417  {
1419  int datatype;
1420  union _ds_mondata_value2
1421  {
1422  void *active_ptr; /* Do not set used by monitoring API */
1423  char *c;
1424  int16_t s;
1425  uint16_t us; /* Also used for TYPE_BOOLEAN */
1426  int32_t l;
1427  uint32_t ul; /* Also used for TYPE_TIMESTAMP */
1428  int64_t ll;
1429  uint64_t ull;
1430  double d;
1431  ds_array_t array;
1432  }
1433  data;
1434  }
1435 ds_monitor_t;
1436 
1437 
1441 typedef struct
1442  {
1444  char *name;
1445  char *description;
1446  char *docstring;
1447  }
1449 
1450 
1465 typedef ds_monitor_t *(*ds_monitor_method_cb)(char *templatename, char *key, char *property, int argc, char *argv[]);
1466 
1476 typedef ds_monitor_t *(*ds_monitor_active_cb)(char *templatename, char *key, char *propertyname);
1477 
1478 
1479 
1484 typedef struct
1485  {
1486  char *username;
1487  char *password;
1488  char *ipaddress;
1489  }
1490 ds_monauth_t;
1491 
1501 typedef int (*ds_monitor_authenticator_t)(ds_monauth_t *credentials);
1502 
1503 
1504 
1505 DATASRCAPI char *ds_monitor_module_name(void);
1506 
1507 
1508 DATASRCAPI void ds_monitor_add_server_type(const char *type, const char *root);
1509 DATASRCAPI void ds_monitor_start_template(const char *templatename, const char *description);
1510 DATASRCAPI void ds_monitor_add_template_member(const char *templatename, const char *propertyname, const char *description, int typeflags, ds_arguments_t *args, void *ptr);
1511 DATASRCAPI void ds_monitor_add_template_relation(const char *templatename, const char *propertyname, const char *targettemplate, const char *description, int thisend_multiple, int thatend_multiple);
1512 DATASRCAPI void ds_monitor_add_template_subscription(const char *templatename, const char *propertyname, const char *targettemplate, const char *description, const char *singleton, ds_monitor_active_cb callback_fn);
1513 
1514 
1515 DATASRCAPI void ds_monitor_add_relation(const char *templatename, const char *key, const char *propertyname, const char *targetkey);
1516 DATASRCAPI void ds_monitor_del_relation(const char *templatename, const char *key, const char *propertyname, const char *targetkey);
1517 
1518 DATASRCAPI void ds_monitor_add_subscription(const char *templatename, const char *key, const char *propertyname, const char *value);
1519 DATASRCAPI void ds_monitor_del_subscription(const char *templatename, const char *key, const char *propertyname, const char *value);
1520 
1521 DATASRCAPI void ds_monitor_end_template(const char *templatename);
1522 
1523 DATASRCAPI void ds_monitor_create_group(const char *templatename, const char *key, const char *brief, const char *description);
1524 DATASRCAPI void ds_monitor_delete_group(const char *templatename, const char *key);
1525 
1526 
1527 
1528 DATASRCAPI void ds_monitor_update(const char *templatename, const char *key, ds_monitor_t *mondata);
1529 DATASRCAPI void ds_monitor_update_string(const char *templatename, const char *key, const char *propertyname, const char *value);
1530 DATASRCAPI void ds_monitor_update_ushort(const char *templatename, const char *key, const char *propertyname, uint16_t);
1531 DATASRCAPI void ds_monitor_update_short(const char *templatename, const char *key, const char *propertyname, int16_t value);
1532 DATASRCAPI void ds_monitor_update_ulong(const char *templatename, const char *key, const char *propertyname, uint32_t value);
1533 DATASRCAPI void ds_monitor_update_long(const char *templatename,const char *key, const char *propertyname, int32_t value);
1534 DATASRCAPI void ds_monitor_update_ullong(const char *templatename, const char *key, const char *propertyname, uint64_t value);
1535 DATASRCAPI void ds_monitor_update_llong(const char *templatename, const char *key, const char *propertyname, int64_t value);
1536 DATASRCAPI void ds_monitor_update_double(const char *templatename, const char *key, const char *propertyname, double value);
1537 DATASRCAPI void ds_monitor_update_timestamp(const char *templatename, const char *key, const char *propertyname, int64_t value);
1538 DATASRCAPI void ds_monitor_update_boolean(const char *templatename, const char *key, const char *propertyname, uint8_t value);
1539 
1540 
1541 
1542 DATASRCAPI ds_monitor_t *ds_monitor_new(const char *propertyname, int type, int datasize, const void *datum);
1543 DATASRCAPI ds_monitor_t *ds_monitor_new_array(const char *propertyname, int type);
1544 DATASRCAPI void ds_monitor_add_data(ds_monitor_t *data, const void *datum);
1545 DATASRCAPI void ds_monitor_free(ds_monitor_t *data); /* Needed by plugin */
1546 
1547 DATASRCAPI void ds_monitor_free_data(ds_monitor_t *data);
1548 
1549 
1550 DATASRCAPI ds_monitor_t *ds_monitor_new_string(const char *templatename, const char *key, const char *propertyname, const char *value);
1551 DATASRCAPI ds_monitor_t *ds_monitor_new_ushort(const char *templatename, const char *key, const char *propertyname, uint16_t value);
1552 DATASRCAPI ds_monitor_t *ds_monitor_new_short(const char *templatename, const char *key, const char *propertyname, int16_t value);
1553 DATASRCAPI ds_monitor_t *ds_monitor_new_ulong(const char *templatename, const char *key, const char *propertyname, uint32_t value);
1554 DATASRCAPI ds_monitor_t *ds_monitor_new_long(const char *templatename,const char *key, const char *propertyname, int32_t value);
1555 DATASRCAPI ds_monitor_t *ds_monitor_new_ullong(const char *templatename, const char *key, const char *propertyname, uint64_t value);
1556 DATASRCAPI ds_monitor_t *ds_monitor_new_llong(const char *templatename, const char *key, const char *propertyname, int64_t value);
1557 DATASRCAPI ds_monitor_t *ds_monitor_new_double(const char *templatename, const char *key, const char *propertyname, double value);
1558 DATASRCAPI ds_monitor_t *ds_monitor_new_timestamp(const char *templatename, const char *key, const char *propertyname, int64_t value);
1559 DATASRCAPI ds_monitor_t *ds_monitor_new_boolean(const char *templatename, const char *key, const char *propertyname, uint8_t value);
1560 
1561 
1563 
1564 
1565 /* net */
1566 
1567 
1568 DATASRCAPI sock_t ds_listen_socket(const char *addr, int port, int backlog);
1569 DATASRCAPI sock_t ds_accept_socket(sock_t fd);
1570 DATASRCAPI sock_t ds_multicast_listen_socket(const char *p_interface, const char *addr, int port);
1571 DATASRCAPI sock_t ds_udp_listen_socket(const char *p_interface, int port);
1572 DATASRCAPI sock_t ds_client_socket(const char *serv, unsigned short port);
1573 DATASRCAPI sock_t ds_client_socket_nonblocking(const char *serv, unsigned short port);
1574 DATASRCAPI int ds_udp_send(const char *data, int len, const char *addr, int port);
1575 DATASRCAPI int ds_udp_sendto(const char *data, int len, struct sockaddr_storage *serv_addr);
1576 DATASRCAPI sock_t ds_udp_client_socket(const char *addr, int port, struct sockaddr_storage *serv_addr);
1577 DATASRCAPI int ds_udp_bind_client_socket(sock_t sock, const char *addr, int port);
1578 DATASRCAPI char *ds_interface_address(const char *ifname);
1579 DATASRCAPI void ds_setnonblocking(sock_t fd);
1580 DATASRCAPI char *ds_getnameinfo(const struct sockaddr_storage *addr, char *buf, size_t buflen);
1581 DATASRCAPI int ds_compare_sockaddr(struct sockaddr_storage *sa, struct sockaddr_storage *sb);
1582 DATASRCAPI int ds_pipe(sock_t fds[2]);
1583 DATASRCAPI int ds_check_subnet(const char *s_address, const char *s_network, const char *s_netmask);
1584 DATASRCAPI struct sockaddr_storage *ds_gethostsockaddr(const char *name, struct sockaddr_storage *populate);
1585 DATASRCAPI struct addrinfo *ds_gethostsockaddrs(const char *name);
1586 
1587 
1588 
1589 /* Message Types */
1590 
1598 #define DS_MSG_CONNECT 0x0100
1599 
1607 #define DS_MSG_DISCONNECT 0x0200
1608 #define DS_MSG_STATUS 0x0400
1609 
1614 #define DS_MSG_AFFINITY_REMOVED 0x0800
1615 
1616 
1617 /* Peer Types */
1618 
1619 #define DS_T_USERMASK 0x00ff
1620 
1630 #define DS_T_ACTIVE 0x0001
1631 
1642 #define DS_T_CONTRIB 0x0002
1643 
1644 #define DS_T_MSG 0x0100
1645 
1646 
1647 /* Peer Flags */
1648 
1649 #define DS_F_USERMASK 0x00ff
1650 
1666 #define F_SENDFROMSEQ 0x0001
1667 
1668 #define F_SENDFROMFIELD 0x0002
1669 
1670 
1684 #define F_RECVAUTOREPLAY 0x0004
1685 
1686 
1701 #define F_NOCONNECT 0x0008
1702 
1703 #define F_RECONNECT 0x0100
1704 #define F_FAILOVER 0x0200
1705 
1706 
1707 /* No Data Flags */
1708 
1709 #define F_NODATAMASK 0x000f
1710 
1720 #define F_NOTFOUND 0x0001
1721 
1730 #define F_READDENY 0x0002
1731 
1740 #define F_WRITEDENY 0x0003
1741 
1750 #define F_DELETEOBJECT 0x0004
1751 
1760 #define F_UNAVAILABLE 0x0005
1761 #define F_STATUS 0x0006
1762 
1763 
1764 
1770 #define F_IGNOREREQTIMEOUT 0x0008
1771 
1772 /* Object Types */
1773 
1777 #define DS_PAGE_TYPE 221
1778 
1781 #define DS_RECORD_TYPE 222
1782 
1785 #define DS_RECORD_TYPE2 225
1786 
1789 #define DS_RECORD_TYPE3 226
1790 
1793 #define DS_NEWS_TYPE 223
1794 
1797 #define DS_STORY_TYPE 224
1798 
1801 #define DS_CONTAINER_TYPE 228
1802 
1805 #define DS_PERMISSION_TYPE 230
1806 
1813 #define DS_GENERIC_TYPE 231
1814 
1818 #define DS_JSON_TYPE 232
1819 
1820 
1821 /* Data Flags */
1822 
1826 #define F_CREATEOBJECT 0x0010
1827 
1830 #define F_CREATEPARENT 0x0020
1831 #define F_PERSISTENT 0x0040
1832 #define F_CREATEDATA 0x0080
1833 
1837 #define F_CLEAR_PERM 0x0400
1838 
1849 #define F_FILTER_PERM 0x0800
1850 
1855 #define F_AUTHGLOBAL 0x0100
1856 
1860 #define F_CLEAR_TYPE3 0x0100
1861 
1865 #define F_FILTER_TYPE3 0x0200
1866 
1869 #define F_CLEAR_TYPE2 0x0400
1870 
1884 #define F_FILTER_TYPE2 0x0800
1885 
1891 #ifdef __DARWIN_NULL
1892 #undef F_NOCACHE
1893 #endif
1894 #define F_NOCACHE 0x0400
1895 
1902 #define F_DELETE_HEADLINE 0x0100
1903 
1911 #define F_CHANGE_HEADLINE 0x0200
1912 
1917 #define F_IMAGE 0x1000
1918 
1922 #define F_NONACTIVE 0x2000
1923 
1926 #define F_AUTHUPDATE 0x4000
1927 
1928 
1936 #define F_CONSTITUENT_NOAUTH 0x4000
1937 
1944 #define F_CHANGEDFIELDS 0x8000
1945 
1946 /* Field Data Types */
1947 
1948 #define FLOAT32_TYPE 1
1949 #define FLOAT64_TYPE 2
1950 #define INT8_TYPE 3
1951 #define INT16_TYPE 4
1952 #define INT32_TYPE 5
1953 #define INT64_TYPE 6
1954 #define UINT8_TYPE 7
1955 #define UINT16_TYPE 8
1956 #define UINT32_TYPE 9
1957 #define UINT64_TYPE 10
1958 
1959 
1960 /* Object request flags */
1961 
1971 #define DS_REQUEST_FAILOVER 1
1972 
1981 #define DS_REQUEST_CACHE 4
1982 
1983 
1984 
1985 /* Object Status Flags */
1986 
1996 #define S_INFO 0x0000
1997 
2006 #define S_STALE 0x0001
2007 
2016 #define S_NOTSTALE 0x0004
2017 
2029 #define S_UPDCLR 0x0100
2030 
2041 #define S_FAILOVER 0x1101 /* Failover implies S_STALE|S_UPDCLR */
2042 
2043 
2056 #define OBJ_STATUS_INFO 0x0000
2057 
2070 #define OBJ_STATUS_OK 0x0001
2071 
2086 #define OBJ_STATUS_STALE 0x0002
2087 
2088 
2104 #define OBJ_STATUS_LIMITED 0x0008
2105 
2106 
2107 #define OBJ_STATUS_NOTMAPPED 0x0010
2108 
2117 #define SVC_STATUS_OK 0x0001
2118 
2127 #define SVC_STATUS_DOWN 0x0002
2128 
2137 #define SVC_STATUS_LIMITED 0x0008
2138 
2139 
2140 /* Field Macros */
2141 #define DS_MAX_BITFIELD (sizeof(ds_bitfield_t)*8)
2142 
2143 #define DS_BITFIELD_SET(n,p) *(p) |= (1ULL << (n))
2144 #define DS_BITFIELD_CLR(n,p) *(p) &= ~(1ULL << (n))
2145 #define DS_BITFIELD_ISSET(n,p) (*(p) & (1ULL << (n)))
2146 #define DS_BITFIELD_ZERO(p) *(p) = 0
2147 #define DS_BITFIELD_NONZERO(p) memset((char *)(p), 0xffffffff, sizeof(*(p)))
2148 
2149 /* Peer set functions and macros */
2150 
2151 DATASRCAPI int ds_iszero(ds_set_t *p);
2152 DATASRCAPI void ds_not(ds_set_t *p);
2153 DATASRCAPI void ds_or(ds_set_t *p1, ds_set_t *p2, ds_set_t *o);
2154 DATASRCAPI void ds_and(ds_set_t *p1, ds_set_t *p2, ds_set_t *a);
2155 DATASRCAPI int ds_and_iszero(ds_set_t *p1, ds_set_t *p2);
2156 DATASRCAPI int ds_and3_iszero(ds_set_t *p1, ds_set_t *p2, ds_set_t *p3);
2157 DATASRCAPI int ds_isequal(ds_set_t *p1, ds_set_t *p2);
2158 
2163 #define DS_MAX_PEERS 1024
2164 
2169 #define DS_MIN_PEER 0
2170 
2175 #define DS_INTERNAL_DATASRC 1023
2176 
2177 typedef uint32_t dsset_element_t;
2178 
2179 #define DS_NUMBITS (sizeof(dsset_element_t) * 8)
2180 #define DS_NUM_ELEMS (DS_MAX_PEERS+DS_NUMBITS-1)/DS_NUMBITS
2181 #define DS_NUM_BYTES (DS_NUM_ELEMS * sizeof(dsset_element_t))
2182 
2183 struct _ds_peer_set
2184  {
2185  dsset_element_t bits[DS_NUM_ELEMS];
2186  };
2187 
2192 #define DS_SET(n,p) ((p)->bits[(n)/DS_NUMBITS] |= ((unsigned)1 << ((n) % DS_NUMBITS)))
2193 
2198 #define DS_CLR(n,p) ((p)->bits[(n)/DS_NUMBITS] &= ~((unsigned)1 << ((n) % DS_NUMBITS)))
2199 
2204 #define DS_ISSET(n,p) ((p)->bits[(n)/DS_NUMBITS] & ((unsigned)1 << ((n) % DS_NUMBITS)))
2205 
2210 #define DS_ZERO(p) memset((char *)(p)->bits, 0, DS_NUM_BYTES)
2211 
2216 #define DS_NONZERO(p) memset((char *)(p)->bits, 0xff, DS_NUM_BYTES)
2217 
2222 #define DS_NOT(p) ds_not(p)
2223 
2228 #define DS_ISZERO(p) ds_iszero(p)
2229 
2234 #define DS_AND(p1, p2, a) ds_and(p1, p2, a)
2235 
2240 #define DS_OR(p1, p2, o) ds_or(p1, p2, o)
2241 
2246 #define DS_AND_ISZERO(p1, p2) ds_and_iszero(p1, p2)
2247 
2252 #define DS_AND3_ISZERO(p1, p2, p3) ds_and3_iszero(p1, p2, p3)
2253 
2258 #define DS_ISEQUAL(p1, p2) ds_isequal(p1, p2)
2259 
2260 DATASRCAPI ds_data_t *ds_init_data(const char *subject, unsigned short type, unsigned short flags);
2261 DATASRCAPI void ds_set_subject(ds_data_t *data, const char *subject);
2262 
2263 DATASRCAPI void ds_add_data(ds_data_t *data, int32_t fieldnum, const char *value);
2264 DATASRCAPI void ds_add_data_fmt(ds_data_t *data, int32_t fieldnum, const char *fmt, ...);
2265 DATASRCAPI void ds_add_data_str(ds_data_t *data, int32_t fieldnum, const char *value);
2266 DATASRCAPI void ds_add_data_float32(ds_data_t *data, int32_t fieldnum, float value);
2267 DATASRCAPI void ds_add_data_float64(ds_data_t *data, int32_t fieldnum, double value);
2268 DATASRCAPI void ds_add_data_int8(ds_data_t *data, int32_t fieldnum, int8_t value);
2269 DATASRCAPI void ds_add_data_int16(ds_data_t *data, int32_t fieldnum, int16_t value);
2270 DATASRCAPI void ds_add_data_int32(ds_data_t *data, int32_t fieldnum, int32_t value);
2271 DATASRCAPI void ds_add_data_int64(ds_data_t *data, int32_t fieldnum, int64_t value);
2272 DATASRCAPI void ds_add_data_uint8(ds_data_t *data, int32_t fieldnum, uint8_t value);
2273 DATASRCAPI void ds_add_data_uint16(ds_data_t *data, int32_t fieldnum, uint16_t value);
2274 DATASRCAPI void ds_add_data_uint32(ds_data_t *data, int32_t fieldnum, uint32_t value);
2275 DATASRCAPI void ds_add_data_uint64(ds_data_t *data, int32_t fieldnum, uint64_t value);
2276 DATASRCAPI void ds_add_data_char(ds_data_t *data, int32_t fieldnum, char value);
2277 
2278 DATASRCAPI ds_data_t *ds_clone_data(ds_data_t *data);
2279 
2280 #define ds_add_data_short(d,f,v) ds_add_data_int16(d,f,v)
2281 #define ds_add_data_int(d,f,v) ds_add_data_int32(d,f,v)
2282 #define ds_add_data_long(d,f,v) ds_add_data_int32(d,f,v)
2283 #define ds_add_data_float(d,f,v) ds_add_data_float32(d,f,v)
2284 #define ds_add_data_double(d,f,v) ds_add_data_float64(d,f,v)
2285 
2286 DATASRCAPI void ds_send_data(ds_data_t *data);
2287 DATASRCAPI void ds_send_data_to_peer(int peer, ds_data_t *data);
2288 DATASRCAPI void ds_send_data_no_free(ds_data_t *data);
2289 DATASRCAPI void ds_send_data_to_peer_no_free(int peer, ds_data_t *data);
2290 DATASRCAPI void ds_send_nodata(const char *subject, unsigned short flags);
2291 DATASRCAPI void ds_send_nodata_to_peer(int peer, const char *subject, unsigned short flags);
2292 DATASRCAPI void ds_free_data(ds_data_t *data);
2293 DATASRCAPI void ds_send_status(const char *subject, unsigned short flags, unsigned short code, const char *msgstr);
2294 DATASRCAPI void ds_send_status_to_peer(int peer,const char *subject, unsigned short flags, unsigned short code, const char *msgstr);
2295 DATASRCAPI void ds_send_data_direct(ds_data_t *data);
2296 DATASRCAPI void ds_send_nodata_direct(const char *subject, unsigned short flags);
2297 DATASRCAPI void ds_send_status_direct(const char *subject, unsigned short flags, unsigned short code, const char *msgstr);
2298 
2299 DATASRCAPI void ds_send_map_to_peer(int peer, const char *subject, const char *mapped, unsigned short flags);
2300 DATASRCAPI void ds_send_map(const char *subject, const char *mapped, unsigned short flags);
2301 
2302 
2313 typedef void (*ds_delay_send_cb)(void *context, ds_data_t *dsdata);
2314 
2315 DATASRCAPI ds_delay_t *ds_new_delay(double delay_time, char *prefix, double batch_time);
2316 DATASRCAPI ds_delay_t *ds_new_delay_with_callback(double delay_time, char *prefix, double batch_time, void *callback_param, ds_delay_send_cb callback_func);
2317 DATASRCAPI void ds_delay_data(ds_delay_t *delay, ds_data_t *dsdata);
2318 
2319 DATASRCAPI int32_t ds_add_record_str(ds_data_t *data, const char *field, const char *value);
2320 DATASRCAPI int32_t ds_add_record_int(ds_data_t *data,const char *field, int value);
2321 DATASRCAPI int32_t ds_add_record_char(ds_data_t *data,const char *field, char value);
2322 DATASRCAPI int32_t ds_add_record_float(ds_data_t *data,const char *field, double value);
2323 DATASRCAPI int32_t ds_add_record_fmt(ds_data_t *data,const char *field, const char *fmt, ...);
2324 
2325 DATASRCAPI ds_data_t *ds_init_page(const char *subject, int rows, int cols, const char *type, unsigned short flags);
2326 DATASRCAPI void ds_add_page_row(ds_data_t *data, int row, int col, const char *str);
2327 DATASRCAPI void ds_add_page_field(ds_data_t *data, int32_t fieldnum, const char *value);
2328 DATASRCAPI void ds_add_page_field_by_name(ds_data_t *data, const char *field, const char *value);
2329 
2330 DATASRCAPI ds_data_t *ds_init_news(const char *subject, unsigned short flags);
2331 DATASRCAPI void ds_add_news_headline(ds_data_t *data, const char *headline);
2332 DATASRCAPI void ds_add_news_storycode(ds_data_t *data, const char *story);
2333 DATASRCAPI void ds_add_news_datetime(ds_data_t *data, const char *datestr);
2334 DATASRCAPI void ds_add_news_authstr(ds_data_t *data, const char *authstr);
2335 DATASRCAPI void ds_add_news_product_code(ds_data_t *data, const char *code);
2336 DATASRCAPI void ds_add_news_topic_code(ds_data_t *data, const char *code);
2337 DATASRCAPI void ds_add_news_company_code(ds_data_t *data, const char *code);
2338 DATASRCAPI void ds_add_news_user_code(ds_data_t *data, int codenum, const char *code);
2339 DATASRCAPI void ds_add_news_field(ds_data_t *dsdata, const char *fieldname, const char *value);
2340 
2341 DATASRCAPI ds_data_t *ds_init_container(const char *subject, const unsigned short flags);
2342 DATASRCAPI void ds_add_container_symbol_and_request(ds_data_t *data, const char *symbol, const int request);
2343 DATASRCAPI void ds_add_container_symbol(ds_data_t *data, const char *symbol);
2344 DATASRCAPI void ds_add_container_symbol_at_position(ds_data_t *data, int position, const char *symbol);
2345 DATASRCAPI void ds_remove_container_symbol(ds_data_t *data, const char *symbol);
2346 DATASRCAPI void ds_cleardown_container_with_prefix(ds_data_t *data, const char *prefix);
2347 
2348 DATASRCAPI ds_data_t *ds_init_permission(const char *subject, const char *key, unsigned short flags);
2349 DATASRCAPI void ds_add_permission_key(ds_data_t *data, const char *key);
2350 
2351 DATASRCAPI void ds_add_binary(ds_data_t *data, int32_t fieldnum, char *value, int len, char type);
2352 DATASRCAPI void ds_add_binary_float32(ds_data_t *data, int32_t fieldnum, float value);
2353 DATASRCAPI void ds_add_binary_float64(ds_data_t *data, int32_t fieldnum, double value);
2354 DATASRCAPI void ds_add_binary_int8(ds_data_t *data, int32_t fieldnum, int8_t value);
2355 DATASRCAPI void ds_add_binary_int16(ds_data_t *data, int32_t fieldnum, int16_t value);
2356 DATASRCAPI void ds_add_binary_int32(ds_data_t *data, int32_t fieldnum, int32_t value);
2357 DATASRCAPI void ds_add_binary_int64(ds_data_t *data, int32_t fieldnum, int64_t value);
2358 DATASRCAPI void ds_add_binary_uint8(ds_data_t *data, int32_t fieldnum, uint8_t value);
2359 DATASRCAPI void ds_add_binary_uint16(ds_data_t *data, int32_t fieldnum, uint16_t value);
2360 DATASRCAPI void ds_add_binary_uint32(ds_data_t *data, int32_t fieldnum, uint32_t value);
2361 DATASRCAPI void ds_add_binary_uint64(ds_data_t *data, int32_t fieldnum, uint64_t value);
2362 DATASRCAPI void ds_add_binary_string(ds_data_t *data, int32_t fieldnum, char *value);
2363 DATASRCAPI void ds_add_binary_opaque(ds_data_t *data, int32_t fieldnum, char *value, int len);
2364 DATASRCAPI void ds_add_binary_time(ds_data_t *data, int32_t fieldnum, time_t value);
2365 DATASRCAPI void ds_add_binary_time_millis(ds_data_t *data, int32_t fieldnum, int64_t value);
2366 DATASRCAPI void ds_add_binary_timeval(ds_data_t *data, int32_t fieldnum, struct timeval value);
2367 DATASRCAPI void ds_add_binary_timespec(ds_data_t *data, int32_t fieldnum, struct timespec value);
2368 
2369 #define ds_add_binary_char(d,f,v) ds_add_binary_int8(d,f,v);
2370 #define ds_add_binary_short(d,f,v) ds_add_binary_int16(d,f,v);
2371 #define ds_add_binary_int(d,f,v) ds_add_binary_int32(d,f,v);
2372 #define ds_add_binary_long(d,f,v) ds_add_binary_int32(d,f,v);
2373 #define ds_add_binary_float(d,f,v) ds_add_binary_float32(d,f,v);
2374 #define ds_add_binary_double(d,f,v) ds_add_binary_float64(d,f,v);
2375 #define ds_add_binary_time_micros(d,f,v) ds_add_binary_timeval(d,f,v);
2376 #define ds_add_binary_time_nanos(d,f,v) ds_add_binary_timespec(d,f,v);
2377 
2378 
2382 #define NEWS_HEADLINE_FIELDNUM 0
2383 
2386 #define NEWS_STORYCODE_FIELDNUM 1
2387 
2390 #define NEWS_DATETIME_FIELDNUM 2
2391 
2394 #define NEWS_AUTHSTR_FIELDNUM 5
2395 
2398 #define NEWS_PRODUCT_CODE_FIELDNUM 100
2399 
2402 #define NEWS_TOPIC_CODE_FIELDNUM 101
2403 
2406 #define NEWS_COMPANY_CODE_FIELDNUM 102
2407 
2410 #define NEWS_USER_CODE_FIELDNUM 200
2411 
2414 #define NEWS_USER_CODE_MAX 10
2415 
2416 #define NEWS_SIZE_FIELDNUM 300
2417 #define NEWS_REASON_FIELDNUM 301
2418 
2419 #define NEWS_REQ_SEARCH 1000
2420 #define NEWS_REQ_STORYCODE 1001
2421 #define NEWS_REQ_DATE_TO 1002
2422 #define NEWS_REQ_DATE_FROM 1003
2423 #define NEWS_REQ_FLAGS 1004
2424 
2425 #define NEWS_GENERIC_FIELDNUM 1024
2426 
2427 /* peer */
2428 
2429 
2430 DATASRCAPI extern int ds_num_peers;
2431 
2432 
2433 DATASRCAPI int ds_peer_details(int peer, char **name);
2434 DATASRCAPI int ds_peer_host_details(int peer, char **addr);
2435 DATASRCAPI int ds_peer_id(int peer);
2436 DATASRCAPI char *ds_peer_name(int peer);
2437 DATASRCAPI int ds_peer_flags(int peer);
2438 DATASRCAPI int ds_peer_local_type(int peer);
2439 DATASRCAPI int ds_peer_type(int peer);
2440 DATASRCAPI int ds_peer_up(int peer);
2441 DATASRCAPI void ds_peer_add_extra_handshake_data(int peer, const char *data);
2442 DATASRCAPI int ds_peer_all_type(int flag);
2443 
2444 DATASRCAPI void ds_set_status_down(void);
2445 DATASRCAPI void ds_set_status_down_to_peer(int peer);
2446 DATASRCAPI void ds_set_status_msg(unsigned short msgid, const char *msgstr);
2447 DATASRCAPI void ds_set_status_msg_to_peer(int peer, unsigned short msgid, const char *msgstr);
2448 DATASRCAPI void ds_set_status_up(void);
2449 DATASRCAPI void ds_set_status_up_to_peer(int peer);
2450 DATASRCAPI int ds_peer_by_label(const char *label);
2451 DATASRCAPI int ds_peer_by_local_label(const char *label);
2452 DATASRCAPI char *ds_peer_label_byindex(int index);
2453 DATASRCAPI int ds_peer_enabled_state(int peer);
2454 
2455 DATASRCAPI int ds_peer_details_r(int peer, char *buffer, size_t buflen);
2456 DATASRCAPI int ds_peer_host_details_r(int peer, char *buffer, size_t buflen);
2457 DATASRCAPI char *ds_peer_name_r(int peer, char *buffer, size_t buflen);
2458 DATASRCAPI char *ds_peer_label_byindex_r(int peer, char *buffer, size_t buflen);
2459 
2460 /* pkt */
2461 
2468 struct _ds_data
2469  {
2470  unsigned short seq;
2471  unsigned short flags;
2472  unsigned short type;
2473  char *subject;
2474  unsigned short count;
2476  time_t time;
2477  };
2478 
2486  {
2487  int32_t fieldnum;
2488  int32_t len;
2489  char *value;
2490  unsigned short flags;
2491  };
2492 
2493 
2494 /* replay */
2495 
2496 
2497 DATASRCAPI void ds_replay(recv_replay_t callback);
2498 DATASRCAPI int ds_replay_from_file(recv_replay_t callback, char *filename);
2499 DATASRCAPI void ds_replay_from_log(recv_replay_t callback, ds_log_t *log);
2500 DATASRCAPI void ds_replay_by_time(time_t t, recv_replay_t callback);
2501 DATASRCAPI int ds_replay_by_time_from_file(time_t t, recv_replay_t callback, char *filename);
2502 DATASRCAPI void ds_replay_by_time_from_log(time_t t, recv_replay_t callback, ds_log_t *log);
2503 DATASRCAPI void ds_replay_by_field(int fieldnum, char *value, recv_replay_t callback);
2504 DATASRCAPI int ds_replay_by_field_from_file(int fieldnum, char *value, recv_replay_t callback, char *filename);
2505 DATASRCAPI void ds_replay_by_field_from_log(int fieldnum, char *value, recv_replay_t callback, ds_log_t *log);
2506 
2507 
2508 /* udp */
2509 
2510 
2515 typedef struct _ds_udp_event ds_udp_event_t;
2516 
2528 typedef int (*ds_udp_event_cb)(int argc, char *argv[], int val, void *data);
2529 
2530 
2531 DATASRCAPI ds_udp_event_t *ds_add_udp_event(const char *command, ds_udp_event_cb cb, int val, void *data);
2532 DATASRCAPI void ds_del_udp_event(ds_udp_event_t *event);
2533 
2534 DATASRCAPI void ds_udpsignal_send(const char *message);
2535 DATASRCAPI void ds_udpsignal_send_argv(const char *message, char *argv[]);
2536 
2537 /* Deprecated methods of handling udp commands */
2538 DATASRCAPI int ds_udpsignal_addjob(const char *cmd,void (*fn)(int argc,char *argv[]), const char *description);
2539 DATASRCAPI int ds_udpsignal_deljob(const char *cmd, void (*fn)(int argc, char *argv[]));
2540 
2541 
2542 /* misc */
2543 
2544 DATASRCAPI void ds_set_productname(const char *name);
2545 
2546 /* advmap */
2547 
2548 DATASRCAPI char *ds_request_object(const char *name);
2549 DATASRCAPI char *ds_request_object_with_flags(const char *name,int flags);
2550 DATASRCAPI int ds_request_objects(int count, char **obs, char ***services);
2551 DATASRCAPI int ds_request_objects_with_flags(int count, char **obs, int flags, char ***services);
2552 DATASRCAPI void ds_discard_object(const char *name);
2553 DATASRCAPI void ds_discard_objects(int count, char **obs);
2554 DATASRCAPI char * ds_get_service(const char *name);
2555 DATASRCAPI int ds_send_contribution(ds_data_t *dsdata);
2556 DATASRCAPI int ds_get_num_services(void);
2557 DATASRCAPI int ds_get_service_by_index(int index, char **name_ptr);
2558 DATASRCAPI int ds_object_available(const char *name);
2559 DATASRCAPI int ds_object_can_contrib(const char *name);
2560 DATASRCAPI void ds_purge_object(const char *name);
2561 DATASRCAPI int ds_required_services_status(char *buf, size_t buflen);
2562 DATASRCAPI int ds_get_service_type(const char *servicename);
2563 DATASRCAPI int ds_get_is_contrib_source(const char *name, int peer);
2564 
2566 DATASRCAPI int ds_set_request_hint(const char *name, int num, char **hints);
2567 DATASRCAPI char **ds_get_request_hints(const char *name, int *ret);
2568 DATASRCAPI char **ds_get_request_hints_dynamic(const char *name, int *ret);
2569 DATASRCAPI void ds_set_object_data(const char *name, void *data);
2570 DATASRCAPI void *ds_get_object_data(const char *name);
2571 
2572 /* signature */
2573 DATASRCAPI int ds_signature_check(char *key_id, char *token);
2574 
2575 /* page */
2576 
2577 #define DS_BIGPAGE_R 25
2578 #define DS_BIGPAGE_C 80
2579 #define DS_BIGPAGE_TYPE "25"
2580 #define DS_SMALLPAGE_R 14
2581 #define DS_SMALLPAGE_C 64
2582 #define DS_SMALLPAGE_TYPE "218"
2583 
2584 
2585 DATASRCAPI int ds_signature_verify_username(char *expected_username, char *token);
2586 
2593 #define DS_SIGNATURE_OK 0
2594 
2600 #define DS_SIGNATURE_INVALID_TOKEN 1
2601 
2607 #define DS_SIGNATURE_UNKNOWN_KEYID 2
2608 
2614 #define DS_SIGNATURE_ALREADY_USED 3
2615 #endif /* __DATASRC_H__ */
2616 
2617 #ifdef __cplusplus
2618 } /* extern "C" */
2619 #endif
2620 
DATASRCAPI void ds_add_binary_time_millis(ds_data_t *data, int32_t fieldnum, int64_t value)
Add a value to a data object in the form of a timestamp.
Definition: binary.c:553
DATASRCAPI int ds_del_except_event(ds_except_event_t *ev)
Remove a socket except event.
Definition: event.c:753
DATASRCAPI char * ds_log_getfilename(ds_log_t *log)
Get the filename of a log object.
Definition: log.c:1571
DATASRCAPI void ds_add_binary_opaque(ds_data_t *data, int32_t fieldnum, char *value, int len)
Add a value to a data object in the form of an opaque value.
Definition: binary.c:510
recv_update_t recv_update
Definition: datasrc.h:366
DATASRCAPI void ds_monitor_update_long(const char *templatename, const char *key, const char *propertyname, int32_t value)
Post an update to the monitoring system for a long value.
Definition: monitor.c:1519
DATASRCAPI ds_data_t * ds_init_container(const char *subject, const unsigned short flags)
Initialise a container object.
Definition: container.c:35
char * log_root
Definition: datasrc.h:361
DATASRCAPI void ds_add_data_float32(ds_data_t *data, int32_t fieldnum, float value)
Add a value to a data object in the form of a floating point number.
Definition: api.c:173
DATASRCAPI void ds_add_page_field_by_name(ds_data_t *data, const char *field, const char *value)
Add an arbitrary field to a page.
Definition: page.c:153
DATASRCAPI void ds_add_data_int16(ds_data_t *data, int32_t fieldnum, int16_t value)
Add a value to a data object in the form of a 16 bit integer.
Definition: api.c:261
DATASRCAPI sock_t ds_client_socket_nonblocking(const char *serv, unsigned short port)
Creates a client socket with which to connect to a host.
Definition: net.c:816
DATASRCAPI ds5_subscription_t * ds5_create_active_subscription(const char *subject, ds5_subscriptionlistener_t *listener, void *context)
Create a subscription that matches a single subject.
Definition: dsv5_subscription.c:131
DATASRCAPI void ds_config_add_bounded_array_option_enum(const char *longopt, const char *help, int type, void *value, int *num, ds_config_enum_t *enums, void *min, void *max)
Add an enumerated option to the configuration context.
Definition: config.c:695
DATASRCAPI int ds_isequal(ds_set_t *p1, ds_set_t *p2)
Check 2 peersets are equal.
Definition: peerset.c:182
DATASRCAPI int ds_replay_by_field_from_file(int fieldnum, char *value, recv_replay_t callback, char *filename)
Replays all data in a file that arrived after an update with the specified value for the specified fi...
Definition: replay.c:416
DATASRCAPI void ds5_publish_status(ds5_publisher_t *pub, const char *subject, int status, const char *message)
Publishes a subscription status event for a subject.
Definition: dsv5_publisher.c:330
unsigned short flags
Definition: datasrc.h:2490
void ds_printf(ds_log_t *log, const char *fmt,...)
Write a formatted string to a log object.
Definition: log.c:1109
Defines the DataSource initialisation object.
Definition: datasrc.h:357
DATASRCAPI void ds_add_container_symbol(ds_data_t *data, const char *symbol)
Add an object to the container.
Definition: container.c:54
DATASRCAPI void ds_write(ds_log_t *log, void *data, size_t len)
Write binary data to a log object.
Definition: log.c:1062
DATASRCAPI int ds_and_iszero(ds_set_t *p1, ds_set_t *p2)
Check if the bitwise and of 2 peer sets is 0.
Definition: peerset.c:123
DATASRCAPI int ds_replay_from_file(recv_replay_t callback, char *filename)
Replays all data in a file.
Definition: replay.c:141
DATASRCAPI int ds_fields_add(int num, const char *name, int flags, int dp, const char *fmt)
Add a new field to the field list.
Definition: fields.c:377
DATASRCAPI ds_config_ctx_t * ds_config_new_ctx(void)
Create a new configuration context.
Definition: config.c:199
struct _ds5_publisher_s ds5_publisher_t
Represents a data publisher that publishers to remote DataSource peers on behalf of a ds5_dataprovide...
Definition: datasrc.h:501
void(* recv_request_t)(int peer, int count, char **subjects, unsigned short flags)
Definition of the function type used for handling data requests.
Definition: datasrc.h:273
DATASRCAPI void DATASRCAPI void DATASRCAPI void ds_config_add_error_message(const char *msg)
Add a configuration error to the logfile.
Definition: config.c:3502
DATASRCAPI int ds5_init(int argc, char **argv)
Parses the DataSource configuration files and initialises the DataSource library. The configuration i...
Definition: dsv5.c:108
DATASRCAPI void ds_monitor_update_string(const char *templatename, const char *key, const char *propertyname, const char *value)
Post an update to the monitoring system for a string value.
Definition: monitor.c:1420
DATASRCAPI void ds_monitor_free_data(ds_monitor_t *data)
Deallocate memory used by the contents of a ds_monitor_t object.
Definition: monitor.c:541
DATASRCAPI int32_t ds_add_record_char(ds_data_t *data, const char *field, char value)
Add a character value to a record object.
Definition: record.c:123
DATASRCAPI void ds_config_init(const char *file, int argc, char **argv)
Set up the configuration of the DataSource.
Definition: datasrc.c:234
int(* ds_monitor_authenticator_t)(ds_monauth_t *credentials)
Definition of the function type used for monitoring authentication callback.
Definition: datasrc.h:1501
void(* ds_loglevelchange_t)(ds_log_t *log, int new_level)
Callback used when the logging level of a log file is changed.
Definition: datasrc.h:1204
DATASRCAPI int ds_required_services_status(char *buf, size_t buflen)
Return whether all required services are ready.
Definition: advmap.c:5689
DATASRCAPI void ds_monitor_add_template_subscription(const char *templatename, const char *propertyname, const char *targettemplate, const char *description, const char *singleton, ds_monitor_active_cb callback_fn)
Add a subscription info into the template.
Definition: monitor.c:1175
DATASRCAPI ds_monitor_t * ds_monitor_new_double(const char *templatename, const char *key, const char *propertyname, double value)
Create a new ds_monitor_t object from an input double.
Definition: monitor.c:1823
char * application_root
Definition: datasrc.h:360
DATASRCAPI int ds_fields_max(void)
Return the number of fields that have been defined.
Definition: fields.c:359
DATASRCAPI void ds_send_data_to_peer(int peer, ds_data_t *data)
Send the data object to a specific peer.
Definition: api.c:589
DATASRCAPI int32_t ds_add_record_int(ds_data_t *data, const char *field, int value)
Add an integer value to a record object.
Definition: record.c:87
DATASRCAPI int ds_pipe(sock_t fds[2])
Creates a UNIX-style pipe.
Definition: net.c:1046
DATASRCAPI void ds_add_binary_float32(ds_data_t *data, int32_t fieldnum, float value)
Add a value to a data object in the form of a floating point number.
Definition: binary.c:223
DATASRCAPI double ds_timed_event_get_fire_time(ds_timed_event_t *ev)
Return the time the event is due to fire.
Definition: event.c:1265
DATASRCAPI ds_data_t * ds_clone_data(ds_data_t *data)
Create a clone of a data object.
Definition: api.c:1089
DATASRCAPI void ds_setnonblocking(sock_t fd)
Set a socket to be non-blocking.
Definition: net.c:1012
char * subject
Definition: datasrc.h:2473
DATASRCAPI void ds_monitor_add_template_relation(const char *templatename, const char *propertyname, const char *targettemplate, const char *description, int thisend_multiple, int thatend_multiple)
Add a relationship to a template.
Definition: monitor.c:1096
DATASRCAPI int ds_signature_check(char *key_id, char *token)
Provides a mechanism for validating a KeyMaster-generated encrypted single-use token.
Definition: signature.c:495
DATASRCAPI int32_t ds_add_record_str(ds_data_t *data, const char *field, const char *value)
Add a string value to a record object.
Definition: record.c:49
DATASRCAPI void ds5_publish_to_peer(ds5_publisher_t *publisher, int peernum, ds_data_t *dsdata)
Publish an update for a subject to the specified peer.
Definition: dsv5_publisher.c:263
DATASRCAPI void ds_set_status_down_to_peer(int peer)
Causes the DataSource to disconnect and not accept connections for this peer.
Definition: peer.c:4234
DATASRCAPI ds_data_t * ds_init_data(const char *subject, unsigned short type, unsigned short flags)
Initialise a data object for use.
Definition: api.c:60
DATASRCAPI void DATASRCAPI int ds_log_set_log_level(ds_log_t *log, const char *level)
Set the log level for a particular logfile.
Definition: log.c:2438
DATASRCAPI void ds_config_add_optional_file(const char *file)
Add an optional configuration file to the current configuration context.
Definition: config.c:354
DATASRCAPI void ds_config_add_section(const char *longopt, const char *help)
Adds a new configuration section to the current configuration context.
Definition: config.c:912
DATASRCAPI sock_t ds_listen_socket(const char *addr, int port, int backlog)
Creates a listen socket on the specified local address and TCP port.
Definition: net.c:517
DATASRCAPI void ds_config_add_array_option_enum(const char *longopt, const char *help, int type, void *value, int *num, ds_config_enum_t *enums)
Add an enumerated option to the configuration context.
Definition: config.c:659
unsigned short seq
Definition: datasrc.h:2470
DATASRCAPI ds_write_event_t * ds_add_write_event(sock_t fd, ds_io_event_cb cb, int val, void *data)
Add a socket write event.
Definition: event.c:498
DATASRCAPI ds_timed_event_t * ds_add_periodic_event(int starttime, int period, int id, ds_timed_event_cb cb, int val, void *data)
Add a timed event, starting at a particular time.
Definition: event.c:1774
DATASRCAPI int ds_del_timed_event(ds_timed_event_t *ev)
Remove a timed event.
Definition: event.c:1231
DATASRCAPI char * ds_peer_name_r(int peer, char *buffer, size_t buflen)
Gets the name of a peer.
Definition: peer.c:7373
DATASRCAPI char * ds_peer_label_byindex_r(int peer, char *buffer, size_t buflen)
Get the peer label for a peer index.
Definition: peer.c:7442
DATASRCAPI ds_read_event_t * ds_add_read_event(sock_t fd, ds_io_event_cb cb, int val, void *data)
Add a socket read event.
Definition: event.c:467
DATASRCAPI void ds_replay_by_time(time_t t, recv_replay_t callback)
Replays all data in the current packet log file that arrived after a specified time.
Definition: replay.c:297
DATASRCAPI void ds_and(ds_set_t *p1, ds_set_t *p2, ds_set_t *a)
Combine 2 peersets using bitwise and.
Definition: peerset.c:98
DATASRCAPI void ds_add_news_topic_code(ds_data_t *data, const char *code)
Add a topic code to the news headline message.
Definition: news.c:141
DATASRCAPI char * ds_config_get_filename(void)
Return the current line number being parsed in the configuration file.
Definition: config.c:3649
DATASRCAPI void ds5_publish_to_peer_no_free(ds5_publisher_t *publisher, int peernum, ds_data_t *dsdata)
Publish an update for a subject to the specified peer. The update will not be freed.
Definition: dsv5_publisher.c:281
DATASRCAPI int ds_object_can_contrib(const char *name)
Determine whether contributions can be sent for this object.
Definition: advmap.c:5412
ds_monitor_t *(* ds_monitor_active_cb)(char *templatename, char *key, char *propertyname)
Definition of the function type used for active request callbacks.
Definition: datasrc.h:1476
DATASRCAPI void ds_add_data_uint32(ds_data_t *data, int32_t fieldnum, uint32_t value)
Add a value to a data object in the form of a 32 bit unsigned integer.
Definition: api.c:411
DATASRCAPI void ds_add_container_symbol_and_request(ds_data_t *data, const char *symbol, const int request)
Add an object to the container, indicating whether it should then be requested.
Definition: container.c:73
DATASRCAPI void ds_config_set_option(const char *name, const char *value)
Set a particular configuration option.
Definition: config.c:2252
DATASRCAPI void ds_config_add_file(const char *file)
Add a mandatory configuration file to the current configuration context.
Definition: config.c:336
DATASRCAPI void ds_free_data(ds_data_t *data)
Deallocates the memory used by a data object.
Definition: api.c:887
void(* recv_update_t)(int peer, ds_data_t *pkt)
Definition of the function type used for receiving updates from a DataSource peer.
Definition: datasrc.h:191
DATASRCAPI ds_except_event_t * ds_add_except_event(sock_t fd, ds_io_event_cb cb, int val, void *data)
Add a socket exception event.
Definition: event.c:535
DATASRCAPI ds_data_t * ds_init_permission(const char *subject, const char *key, unsigned short flags)
Initialise a data object as a permission object.
Definition: permission.c:77
DATASRCAPI ds5_namespace_t * ds5_create_regex_namespace(const char *expr)
Creates a DataSource namespace which will match subject names using a regular expression.
Definition: dsv5_namespace.c:276
DATASRCAPI char * ds_get_service(const char *name)
Return the service for an object.
Definition: advmap.c:5190
DATASRCAPI void ds_udpsignal_send_argv(const char *message, char *argv[])
Send a UDP message.
Definition: udpsignal.c:384
DATASRCAPI void ds_monitor_update_double(const char *templatename, const char *key, const char *propertyname, double value)
Post an update to the monitoring system for a double value.
Definition: monitor.c:1600
DATASRCAPI struct tm * ds_gmtime(void)
Get the current time in GMT.
Definition: event.c:1115
DATASRCAPI void ds_add_binary_int8(ds_data_t *data, int32_t fieldnum, int8_t value)
Add a value to a data object in the form of an 8 bit integer.
Definition: binary.c:281
DATASRCAPI void ds_monitor_end_template(const char *templatename)
End the definition of a template.
Definition: monitor.c:1067
DATASRCAPI void ds_config_add_group(const char *longopt, const char *help, void *base, void *def, size_t size, int *num)
Add a configuration group to the current configuration context.
Definition: config.c:791
DATASRCAPI int ds_peer_by_label(const char *label)
Return the peer index for a label.
Definition: peer.c:5672
DATASRCAPI void ds_config_free_ctx(ds_config_ctx_t *ctx)
Free a configuration context.
Definition: config.c:225
Enumerated types structure.
Definition: datasrc.h:924
DATASRCAPI void ds5_config_init(const char *configfile, int argc, char **argv)
Sets up the configuration of the DataSource.
Definition: dsv5.c:79
DATASRCAPI void ds_add_binary_int32(ds_data_t *data, int32_t fieldnum, int32_t value)
Add a value to a data object in the form of a 32 bit integer.
Definition: binary.c:328
DATASRCAPI void ds_send_data_no_free(ds_data_t *data)
Send the data object to all connected DataSource peers.
Definition: api.c:652
DATASRCAPI ds_data_t * ds_init_news(const char *subject, unsigned short flags)
Create a news headline message.
Definition: news.c:35
A field within a data update.
Definition: datasrc.h:2485
DATASRCAPI void ds_add_binary_timespec(ds_data_t *data, int32_t fieldnum, struct timespec value)
Add a value to a data object in the form of a timestamp.
Definition: binary.c:605
DATASRCAPI int ds_config_get_enum(const char *value, ds_config_enum_t *enums)
Get the value of an enumerated member.
Definition: config.c:1490
char * application_name
Definition: datasrc.h:359
DATASRCAPI int ds_peer_flags(int peer)
Gets the flags of a peer.
Definition: peer.c:1407
DATASRCAPI void ds_write_event_set_callback(ds_write_event_t *ev, ds_io_event_cb cb, int val, void *data)
Change the callback and callback values for a socket write event.
Definition: event.c:831
DATASRCAPI int32_t ds_add_record_fmt(ds_data_t *data, const char *field, const char *fmt,...)
Add a formatted string to a record object.
Definition: record.c:197
DATASRCAPI ds_monitor_t * ds_monitor_new_long(const char *templatename, const char *key, const char *propertyname, int32_t value)
Create a new ds_monitor_t object from an input long.
Definition: monitor.c:1733
DATASRCAPI ds5_namespace_t * ds5_create_prefix_namespace(const char *prefix)
Creates a DataSource namespace which will match subject names based on their prefix.
Definition: dsv5_namespace.c:86
DATASRCAPI char * ds_fields_namebyindex(int index)
Return the field name of this index.
Definition: fields.c:622
DATASRCAPI void ds_monitor_create_group(const char *templatename, const char *key, const char *brief, const char *description)
Create a new monitoring group.
Definition: monitor.c:1348
DATASRCAPI void ds_add_data_uint64(ds_data_t *data, int32_t fieldnum, uint64_t value)
Add a value to a data object in the form of a 64 bit unsigned integer.
Definition: api.c:441
DATASRCAPI void DATASRCAPI void ds_cycle_all_logs(const char *suffix, long maxsize)
Cycle all log files in the application.
Definition: log.c:1394
DATASRCAPI int ds_udp_send(const char *data, int len, const char *addr, int port)
Sends data to a UDP address.
Definition: net.c:860
DATASRCAPI int ds_fields_getflags(int index)
Return the field flags of this index.
Definition: fields.c:662
DATASRCAPI void ds_monitor_start_template(const char *templatename, const char *description)
Start the defintion of a template.
Definition: monitor.c:976
DATASRCAPI void ds_add_permission_key(ds_data_t *data, const char *key)
Set the key for a permission object. Must be called either first, or immediately after inserting a se...
Definition: permission.c:101
DATASRCAPI void ds_config_add_bounded_option_enum(char sopt, const char *longopt, const char *help, int type, void *value, ds_config_enum_t *enums, void *min, void *max)
Add an enumerated option to the configuration context.
Definition: config.c:482
DATASRCAPI sock_t ds_udp_listen_socket(const char *p_interface, int port)
Creates a UDP listen socket.
Definition: net.c:691
DATASRCAPI void ds_config_add_option(char opt, const char *longopt, const char *help, int type, void *value)
Add a configuration option to the current configuration context.
Definition: config.c:387
DATASRCAPI void ds_add_binary_uint8(ds_data_t *data, int32_t fieldnum, uint8_t value)
Add a value to a data object in the form of an unsigned 8 bit integer.
Definition: binary.c:384
DATASRCAPI void ds_monitor_del_subscription(const char *templatename, const char *key, const char *propertyname, const char *value)
Delete a subscription between two groups.
Definition: monitor.c:1322
int(* ds_timed_event_cb)(int id, int val, void *data)
Definition of the callback for use with timed events.
Definition: datasrc.h:1047
DATASRCAPI void ds_add_news_datetime(ds_data_t *data, const char *datestr)
Add a date stamp to the news headline message.
Definition: news.c:87
The container object for monitoring array types.
Definition: datasrc.h:1395
DATASRCAPI void ds_monitor_delete_group(const char *templatename, const char *key)
Delete a group from the monitoring system.
Definition: monitor.c:1367
DATASRCAPI void ds_config_parse_args(int argc, char **argv, int *retargc)
Parse the configuration options from the command line arguments given.
Definition: config.c:2349
DATASRCAPI int ds_set_request_hint(const char *name, int num, char **hints)
Set the objects hint peers.
Definition: advmap.c:5493
DATASRCAPI void ds_config_set_test(const char *tag, char **value)
Adds a conditional test to the configuration file.
Definition: config.c:1043
DATASRCAPI void ds_config_list_options(void)
Print the options in the current configuration context to standard output.
Definition: config.c:3353
DATASRCAPI int ds_peer_local_type(int peer)
Gets the local type of a DataSource peer.
Definition: peer.c:1463
DATASRCAPI ds_udp_event_t * ds_add_udp_event(const char *command, ds_udp_event_cb cb, int val, void *data)
Add a udp event.
Definition: test_license.c:57
void(* recv_nodata_t)(int peer, char *subject, unsigned short flags)
Definition of the function type used for receiving "nodata" messages.
Definition: datasrc.h:229
DATASRCAPI char * ds_peer_name(int peer)
Gets the name of a peer.
Definition: peer.c:1379
DATASRCAPI void ds_set_subject(ds_data_t *data, const char *subject)
Sets a new name for the data object.
Definition: api.c:83
DATASRCAPI ds_log_t * ds_new_log(const char *name, const char *logname)
Create a new log object.
Definition: log.c:557
DATASRCAPI void ds5_add_connectionlistener(ds5_connectionlistener_t *connection_listener, void *context)
Adds a connection listener. The listener receives status events about the state of the DataSource app...
Definition: dsv5.c:261
void ds_config_add_config_reading_message_fmt(const char *fmt,...)
Handle a configuration loading message. Add a formatted message to the list of messages to be logged...
Definition: config.c:3452
void(* ds_logcycled_t)(ds_log_t *log)
Callback used when the log has cycled.
Definition: datasrc.h:1212
DATASRCAPI int ds_check_subnet(const char *s_address, const char *s_network, const char *s_netmask)
Check whether an address falls into a given network and netmask.
Definition: net.c:1152
int typeflags
Definition: datasrc.h:1443
DATASRCAPI ds5_namespace_t * ds5_create_globbed_namespace(const char *globbed)
Creates a DataSource namespace which will match subject names using globbing.
Definition: dsv5_namespace.c:138
DATASRCAPI void ds_monitor_del_relation(const char *templatename, const char *key, const char *propertyname, const char *targetkey)
Delete a relationship between two groups.
Definition: monitor.c:1263
void(* recv_peer_status_t)(int peer, int status, int val, void *data)
Definition of the function type used for receiving peer status messages.
Definition: datasrc.h:253
DATASRCAPI int ds_num_peers
The number of DataSource peers in your configuration. If discovery is enabled then this is set to be ...
Definition: peer.c:295
DATASRCAPI void ds_add_data_uint16(ds_data_t *data, int32_t fieldnum, uint16_t value)
Add a value to a data object in the form of a 16 bit unsigned integer.
Definition: api.c:381
DATASRCAPI void ds_add_binary_uint16(ds_data_t *data, int32_t fieldnum, uint16_t value)
Add a value to a data object in the form of an unsigned 16 bit integer.
Definition: binary.c:407
DATASRCAPI void ds_add_news_company_code(ds_data_t *data, const char *code)
Add a company code to the news headline message.
Definition: news.c:158
DATASRCAPI char * ds_debug_string(int level)
This function will convert a debug level into an appropriate string.
Definition: log.c:2055
DATASRCAPI void ds_add_data_uint8(ds_data_t *data, int32_t fieldnum, uint8_t value)
Add a value to a data object in the form of an 8 bit unsigned integer.
Definition: api.c:351
DATASRCAPI int ds_udp_sendto(const char *data, int len, struct sockaddr_storage *serv_addr)
Sends data to a UDP address.
Definition: net.c:892
DATASRCAPI int ds_object_available(const char *name)
Determine whether this object can theoretically be requested.
Definition: advmap.c:5320
DATASRCAPI int ds_fields_numbyname(const char *name)
Return the field number of this field.
Definition: fields.c:489
DATASRCAPI void ds_add_data_fmt(ds_data_t *data, int32_t fieldnum, const char *fmt,...)
Add a sprintf style format string to a data object.
Definition: api.c:127
DATASRCAPI void ds_set_timed_delay_next(ds_timed_event_t *ev, double delay)
Alter the next fire time for an existing timed event.
Definition: event.c:1377
DATASRCAPI int ds_request_objects(int count, char **obs, char ***services)
Request a number of objects in one go.
Definition: advmap.c:4873
DATASRCAPI char * ds_getnameinfo(const struct sockaddr_storage *addr, char *buf, size_t buflen)
return the string representation of the address passed in
Definition: net.c:295
DATASRCAPI int ds_peer_type(int peer)
Gets the type of a DataSource peer.
Definition: peer.c:1435
DATASRCAPI void ds_monitor_update_llong(const char *templatename, const char *key, const char *propertyname, int64_t value)
Post an update to the monitoring system for a long long value.
Definition: monitor.c:1558
DATASRCAPI void ds5_publish_subject_map(ds5_publisher_t *publisher, const char *subject, const char *mapped_to, int flags)
Publishes a subscription map event for a subject.
Definition: dsv5_publisher.c:361
DATASRCAPI void ds_add_data_int32(ds_data_t *data, int32_t fieldnum, int32_t value)
Add a value to a data object in the form of a 32 bit integer.
Definition: api.c:291
Monitoring credentials object.
Definition: datasrc.h:1484
An implementation of this interface allows applications to receive events raised for a ds5_subscripti...
Definition: datasrc.h:649
DATASRCAPI ds_monitor_t * ds_monitor_new(const char *propertyname, int type, int datasize, const void *datum)
Create a new ds_monitor_t object from input parameters.
Definition: monitor.c:591
DATASRCAPI void ds_add_binary_int64(ds_data_t *data, int32_t fieldnum, int64_t value)
Add a value to a data object in the form of a 64 bit integer.
Definition: binary.c:352
DATASRCAPI void ds_send_status_direct(const char *subject, unsigned short flags, unsigned short code, const char *msgstr)
Sends a user defined status message about a particular object.
Definition: api.c:939
DATASRCAPI void ds_add_binary(ds_data_t *data, int32_t fieldnum, char *value, int len, char type)
Adds a binary value to a data object.
Definition: binary.c:198
void ds_monitor_update_boolean(const char *templatename, const char *key, const char *propertyname, unsigned char value)
Post an update to the monitoring system for a boolean value.
Definition: monitor.c:1461
DATASRCAPI void ds_add_binary_int16(ds_data_t *data, int32_t fieldnum, int16_t value)
Add a value to a data object in the form of a 16 bit integer.
Definition: binary.c:304
DATASRCAPI int ds_peer_up(int peer)
Check to see if a peer is up.
Definition: peer.c:1524
DATASRCAPI void ds_add_data_char(ds_data_t *data, int32_t fieldnum, char value)
Add a value to a data object in the form of a character.
Definition: api.c:468
DATASRCAPI void ds_config_end_section(const char *longopt, const char *help)
Ends a configuration section.
Definition: config.c:954
DATASRCAPI ds_logcycled_t ds_log_cycled_callback(ds_log_t *log, ds_logcycled_t cycle_cb)
Set the cycle callback for a given logfile.
Definition: log.c:2562
unsigned short count
Definition: datasrc.h:2474
DATASRCAPI void ds_config_add_array_option(const char *longopt, const char *help, int type, void *value, int *num)
Adds a configuration option to the current configuration context.
Definition: config.c:590
DATASRCAPI char * ds_request_object(const char *name)
Request an object.
Definition: advmap.c:4817
DATASRCAPI void ds_monitor_add_server_type(const char *type, const char *root)
Define The Server Type.
Definition: monitor.c:930
DATASRCAPI int ds_config_get_linenumber(void)
Return the name of current configuration file being parsed.
Definition: config.c:3679
struct _ds5_subscription_s ds5_subscription_t
Represents a subscription to a DataSource subject (see ds_create_active_subscription()) or to a names...
Definition: datasrc.h:634
DATASRCAPI int ds_udp_bind_client_socket(sock_t sock, const char *addr, int port)
Binds a UDP socket to a local address.
Definition: net.c:969
DATASRCAPI void ds_monitor_add_subscription(const char *templatename, const char *key, const char *propertyname, const char *value)
Add a subscription between two groups.
Definition: monitor.c:1298
DATASRCAPI int ds_signature_verify_username(char *expected_username, char *token)
Verify that the supplied token is for the expected username.
Definition: signature.c:885
recv_object_status_t recv_object_status
Definition: datasrc.h:372
DATASRCAPI void ds_set_status_down(void)
Causes the DataSource to disconnect and stop listening for connections.
Definition: peer.c:4126
DATASRCAPI void ds_reserve_std_fds(void)
Reserves the standard sockets for the std streams.
Definition: datasrc.c:188
DATASRCAPI void ds_cache_add_object(char *subject)
Add a new object to the cache.
Definition: cache.c:293
char * name
Definition: datasrc.h:926
char * docstring
Definition: datasrc.h:1446
recv_service_status_t recv_service_status
Definition: datasrc.h:377
DATASRCAPI void ds_send_nodata_direct(const char *subject, unsigned short flags)
Send a "no data" message to all connected DataSource peers.
Definition: api.c:800
DATASRCAPI void DATASRCAPI void DATASRCAPI void ds_printf_time_ap(ds_log_t *log, const char *extra, const char *fmt, va_list ap)
Write a formatted string prefixed with a timestamp string to a log object.
Definition: log.c:1180
DATASRCAPI int ds_del_timed_event_free_data(ds_timed_event_t *ev, void(*free_data)(int, void *))
Remove a timed event.
Definition: event.c:1286
DATASRCAPI int ds_peer_by_local_label(const char *label)
Return the peer index for a local label.
Definition: peer.c:5692
DATASRCAPI void ds_add_binary_uint32(ds_data_t *data, int32_t fieldnum, uint32_t value)
Add a value to a data object in the form of an unsigned 32 bit integer.
Definition: binary.c:431
DATASRCAPI void ds_log_change_level_callback(ds_log_t *log, ds_loglevelchange_t change_cb)
Set the level change callback for a given logfile.
Definition: log.c:2546
DATASRCAPI void ds_monitor_add_template_member(const char *templatename, const char *propertyname, const char *description, int typeflags, ds_arguments_t *args, void *ptr)
Add a memeber to a template.
Definition: monitor.c:1012
char * docstring
Definition: datasrc.h:928
int sock_t
The network socket datatype.
Definition: datasrc.h:128
char * description
Definition: datasrc.h:1445
Implement this interface to receive connection status information when using the DSv5 API...
Definition: datasrc.h:595
DATASRCAPI int ds_fields_indexbynum(int num)
Return the index of this field.
Definition: fields.c:579
void(* recv_replay_t)(int peer, ds_data_t *pkt, time_t tm)
Definition of the function type used for receiving updates from a the DataSource library when calling...
Definition: datasrc.h:209
DATASRCAPI void ds_monitor_add_data(ds_monitor_t *data, const void *datum)
Add an element to an array within a ds_monitor_t.
Definition: monitor.c:453
DATASRCAPI sock_t ds_client_socket(const char *serv, unsigned short port)
Creates a client socket with which to connect to a host.
Definition: net.c:844
DATASRCAPI void ds_add_latency_chain2(ds_data_t *dsdata, char suffix, struct timespec tp, char suffix2, struct timespec *tp2)
Function used to add two measurement points to latency chain data.
Definition: lty_chain.c:299
ds_field_t * fields
Definition: datasrc.h:2475
DATASRCAPI void ds_discard_object(const char *name)
Discard an object.
Definition: advmap.c:5005
unsigned short flags
Definition: datasrc.h:362
DATASRCAPI void ds_replay(recv_replay_t callback)
Replays all data in the current packet log file.
Definition: replay.c:177
DATASRCAPI void ds_set_status_up_to_peer(int peer)
Causes the DataSource to connect and accept connections.
Definition: peer.c:4519
DATASRCAPI int ds_replay_by_time_from_file(time_t t, recv_replay_t callback, char *filename)
Replays all data in a file that arrived after a specified time.
Definition: replay.c:323
DATASRCAPI char * ds_peer_label_byindex(int index)
Return the peer label for a peer index.
Definition: peer.c:5735
DATASRCAPI void ds_monitor_update(const char *templatename, const char *key, ds_monitor_t *mondata)
Post an update to the monitoring system for a string value.
Definition: monitor.c:1392
DATASRCAPI void ds_config_end_group(const char *longopt, const char *help)
Ends a configuration group.
Definition: config.c:871
DATASRCAPI char * ds_fields_namebynum(int num)
Return the field name of this field number.
Definition: fields.c:519
DATASRCAPI void ds_send_nodata(const char *subject, unsigned short flags)
Send a "no data" message to all connected DataSource peers.
Definition: api.c:777
DATASRCAPI void ds_config_add_bounded_array_option(const char *longopt, const char *help, int type, void *value, int *num, void *min, void *max)
Adds a configuration option to the current configuration context.
Definition: config.c:624
DATASRCAPI void ds_monitor_add_relation(const char *templatename, const char *key, const char *propertyname, const char *targetkey)
Add a relationship between two groups.
Definition: monitor.c:1238
DATASRCAPI void ds_thread_init(int event_module, int flags)
Initialise the event loop for this thread.
Definition: datasrc.c:972
char * name
Definition: datasrc.h:1444
Definition of the interface that you should implement if you require custom subject matching logic...
Definition: datasrc.h:432
DATASRCAPI int ds_del_write_event_free_data(ds_write_event_t *ev, void(*free_data)(int, void *))
Remove a socket write event.
Definition: event.c:728
DATASRCAPI void ds5_publish_status_all(ds5_publisher_t *pub, int status, const char *message)
Publishes a subscription status event for all requested subjects.
Definition: dsv5_publisher.c:344
DATASRCAPI void ds_monitor_update_ullong(const char *templatename, const char *key, const char *propertyname, uint64_t value)
Post an update to the monitoring system for an unsigned long long value.
Definition: monitor.c:1539
DATASRCAPI void ds_set_timed_delay(ds_timed_event_t *ev, double delay)
Alter the delay for an existing timed event.
Definition: event.c:1357
DATASRCAPI void ds_config_del_test(const char *tag)
Delete a conditional test.
Definition: config.c:1077
DATASRCAPI void ds_add_news_headline(ds_data_t *data, const char *headline)
Add a news headline to the news headline message.
Definition: news.c:53
DATASRCAPI ds5_subscription_t * ds5_create_broadcast_subscription(ds5_namespace_t *nspace, ds5_subscriptionlistener_t *listener, void *context)
Create a subscription that matches multiple subjects.
Definition: dsv5_subscription.c:98
DATASRCAPI void ds_send_status(const char *subject, unsigned short flags, unsigned short code, const char *msgstr)
Sends a user defined status message about a particular object.
Definition: api.c:912
struct _ds_udp_event ds_udp_event_t
Opaque type defining a udp event.
Definition: datasrc.h:2515
DATASRCAPI void ds_delay_data(ds_delay_t *delay, ds_data_t *dsdata)
Add a data object to a delay channel.
Definition: delay.c:290
void(* recv_object_status_t)(int peer, char *subject, int status, unsigned short code, char *msgstr)
Definition of the function type used for handling objectstatus messages.
Definition: datasrc.h:314
DATASRCAPI ds_log_t * ds_new_level_log(const char *name, const char *logname, ds_loglevelchange_t change_cb)
Create a new log object.
Definition: log.c:580
DATASRCAPI void ds_add_news_storycode(ds_data_t *data, const char *story)
Add a story code to the news object.
Definition: news.c:70
DATASRCAPI void ds_send_data_direct(ds_data_t *data)
Send the data object to all connected DataSource peers.
Definition: api.c:524
DATASRCAPI void ds_add_data_float64(ds_data_t *data, int32_t fieldnum, double value)
Add a value to a data object in the form of a floating point number.
Definition: api.c:201
DATASRCAPI void ds_add_binary_time(ds_data_t *data, int32_t fieldnum, time_t value)
Add a value to a data object in the form of a timestamp.
Definition: binary.c:533
DATASRCAPI ds_monitor_t * ds_monitor_new_llong(const char *templatename, const char *key, const char *propertyname, int64_t value)
Create a new ds_monitor_t object from an input long long.
Definition: monitor.c:1777
DATASRCAPI void ds_config_del_option(const char *longopt)
Remove an option from the current configuration context.
Definition: config.c:732
char * propertyname
Definition: datasrc.h:1418
void(* recv_discard_t)(int peer, int count, char **subjects, unsigned short flags)
Definition of the function type used for handling data discard requests.
Definition: datasrc.h:293
The container object for all monitoring values.
Definition: datasrc.h:1416
DATASRCAPI void * ds_get_object_data(const char *name)
Get an objects user data.
Definition: advmap.c:5663
DATASRCAPI void ds5_publish_subject_error(ds5_publisher_t *publisher, const char *subject, int flags)
Publishes a subscription error event for a subject.
Definition: dsv5_publisher.c:377
DATASRCAPI void ds_read_event_set_callback(ds_read_event_t *ev, ds_io_event_cb cb, int val, void *data)
Change the callback and callback values for a socket read event.
Definition: event.c:814
DATASRCAPI void ds_add_news_field(ds_data_t *dsdata, const char *fieldname, const char *value)
Add a custom field to a news headline message.
Definition: news.c:200
unsigned short flags
Definition: datasrc.h:2471
DATASRCAPI char * ds_log_getname(ds_log_t *log)
Get the name of a log object.
Definition: log.c:1589
DATASRCAPI int ds_peer_host_details(int peer, char **addr)
Gets details of the remote side of a peer.
Definition: peer.c:1320
Structure defining the arguments for Monitoring methods.
Definition: datasrc.h:1441
void(* ds_delay_send_cb)(void *context, ds_data_t *dsdata)
Definition of the callback for sending delayed data.
Definition: datasrc.h:2313
DATASRCAPI int ds_cycle_log(ds_log_t *log, const char *suffix, long maxsize)
Cycle a specific log file.
Definition: log.c:1425
struct _ds_log ds_log_t
The log file object.
Definition: datasrc.h:175
unsigned short type
Definition: datasrc.h:363
DATASRCAPI void ds_add_news_authstr(ds_data_t *data, const char *authstr)
Add an authorisation string to the news headline message.
Definition: news.c:107
DATASRCAPI ds_monitor_t * ds_monitor_new_short(const char *templatename, const char *key, const char *propertyname, int16_t value)
Create a new ds_monitor_t object from an input short.
Definition: monitor.c:1689
DATASRCAPI void ds_add_data_str(ds_data_t *data, int32_t fieldnum, const char *value)
Adds a string value to a data object.
Definition: api.c:154
void(* free)(ds5_namespace_t *nspace)
Invoked when the namespace should be deleted.
Definition: datasrc.h:439
DATASRCAPI void ds_replay_by_field(int fieldnum, char *value, recv_replay_t callback)
Replays all data in the current packet log file that arrived after an update with the specified value...
Definition: replay.c:388
DATASRCAPI ds_timed_event_t * ds_add_timed_event(int id, double delay, ds_timed_event_cb cb, int val, void *data)
Add a timed event.
Definition: event.c:1162
DATASRCAPI void ds_send_data(ds_data_t *data)
Send the data object to all connected DataSource peers.
Definition: api.c:499
struct _ds_peer_set ds_set_t
Defines a set of DataSource peers.
Definition: datasrc.h:153
DATASRCAPI void ds_not(ds_set_t *p)
Apply logical not to each peer in group.
Definition: peerset.c:25
DATASRCAPI void ds_writev(ds_log_t *log, struct iovec *vector, int count)
Write binary data to a log object.
Definition: log.c:1089
DATASRCAPI void ds_send_data_to_peer_no_free(int peer, ds_data_t *data)
Send the data object to a specific peer.
Definition: api.c:716
DATASRCAPI void ds_stop(void)
Definition: event.c:1059
DATASRCAPI void ds_config_add_group_with_info(const char *longopt, const char *help, void *base, void *def, size_t size, int *num, int file_offset, int line_offset)
Add a configuration group to the current configuration context.
Definition: config.c:819
ds_monitor_t * ds_monitor_new_boolean(const char *templatename, const char *key, const char *propertyname, unsigned char value)
Create a new ds_monitor_t object from an input boolean value.
Definition: monitor.c:1667
DATASRCAPI int ds_fields_getdp(int index)
Return the decimal precision of this index.
Definition: fields.c:679
DATASRCAPI void ds_set_status_msg_to_peer(int peer, unsigned short msgid, const char *msgstr)
Send a user-defined status message to peer.
Definition: peer.c:4361
struct _ds_timed_event ds_timed_event_t
Opaque type defining a timed event.
Definition: datasrc.h:993
DATASRCAPI void ds_monitor_update_short(const char *templatename, const char *key, const char *propertyname, int16_t value)
Post an update to the monitoring system for a short value.
Definition: monitor.c:1480
void ds_config_add_error_message_fmt(const char *fmt,...)
Add a formatted error message to the logfile.
Definition: config.c:3420
DATASRCAPI sock_t ds_udp_client_socket(const char *addr, int port, struct sockaddr_storage *serv_addr)
Creates a UDP client socket.
Definition: net.c:925
DATASRCAPI void ds_monitor_free(ds_monitor_t *data)
Deallocate memory used by a ds_monitor_t object.
Definition: monitor.c:519
DATASRCAPI void ds_add_binary_timeval(ds_data_t *data, int32_t fieldnum, struct timeval value)
Add a value to a data object in the form of a timestamp.
Definition: binary.c:581
DATASRCAPI ds_log_t * ds_new_headed_log(const char *name, const char *logname, const char *header)
Create a new log object with a header.
Definition: log.c:947
DATASRCAPI void ds_send_status_to_peer(int peer, const char *subject, unsigned short flags, unsigned short code, const char *msgstr)
Sends a user defined status message about a particular object.
Definition: api.c:1000
DATASRCAPI int ds5_regex_namespace_add_expr(ds5_namespace_t *nspace, const char *expr, int exclude)
Adds a regular expression to a namespace.
Definition: dsv5_namespace.c:241
DATASRCAPI char ** ds_get_request_hints(const char *name, int *ret)
Return an objects request hints.
Definition: advmap.c:5572
DATASRCAPI ds_monitor_t * ds_monitor_new_ullong(const char *templatename, const char *key, const char *propertyname, uint64_t value)
Create a new ds_monitor_t object from an input unsigned long long.
Definition: monitor.c:1755
size_t size
Definition: datasrc.h:1396
DATASRCAPI void ds_set_status_up(void)
Causes the DataSource to connect and listen for connections.
Definition: peer.c:4468
DATASRCAPI int ds_check_periodic_event(int period, ds_timed_event_t **tev)
Check a periodic to ensure that it runs at the appropriate time regardless of summertime.
Definition: event.c:2055
DATASRCAPI void ds_loop(void)
Start the DataSource event loop.
Definition: event.c:1028
DATASRCAPI void ds_udpsignal_send(const char *message)
Send a udp message.
Definition: udpsignal.c:366
A data update object.
Definition: datasrc.h:2468
DATASRCAPI void ds_add_news_product_code(ds_data_t *data, const char *code)
Add a product code to the news headline message.
Definition: news.c:124
DATASRCAPI void ds5_unsubscribe(ds5_subscription_t *sub)
Unsubscribe from the DataSource subject or namespace of DataSource subjects.
Definition: dsv5_subscription.c:536
DATASRCAPI int ds_debug_level(const char *text)
This function will convert a string into an appropriate debug level.
Definition: log.c:2029
DATASRCAPI int ds_iszero(ds_set_t *p)
Check if any peer is set.
Definition: peerset.c:48
DATASRCAPI void ds5_publish_to_subscribed_peers_no_free(ds5_publisher_t *pub, ds_data_t *dsdata)
Publish an update for a subject to all peers that have subscribed. The update will not be freed...
Definition: dsv5_publisher.c:247
DATASRCAPI ds_delay_t * ds_new_delay(double delay_time, char *prefix, double batch_time)
Create a new delay channel.
Definition: delay.c:200
DATASRCAPI void ds_purge_object(const char *name)
Purge an object from our cache.
Definition: advmap.c:5461
DATASRCAPI int ds_log_flush(ds_log_t *log)
flush log buffers to disk
Definition: log.c:2409
DATASRCAPI int ds_request_objects_with_flags(int count, char **obs, int flags, char ***services)
Request a number of objects in one go.
Definition: advmap.c:4898
void(* recv_map_t)(int peer, char *from, char *to)
Definition of the function type used for handling map messages.
Definition: datasrc.h:337
DATASRCAPI int ds_peer_enabled_state(int peer)
Gets the enabled/disabled state of a DataSource peer.
Definition: peer.c:1495
void(* recv_service_status_t)(char *service, int status)
Definition of the function type used for handling service status messages.
Definition: datasrc.h:325
DATASRCAPI int ds_fields_indexbyname(const char *name)
Return the index of this field.
Definition: fields.c:546
DATASRCAPI void ds5_publish_to_subscribed_peers(ds5_publisher_t *pub, ds_data_t *dsdata)
Publish an update for a subject to all peers that have subscribed.
Definition: dsv5_publisher.c:230
DATASRCAPI ds_monitor_t * ds_monitor_new_string(const char *templatename, const char *key, const char *propertyname, const char *value)
Create a new ds_monitor_t object from an input string.
Definition: monitor.c:1623
DATASRCAPI void ds_add_news_user_code(ds_data_t *data, int codenum, const char *code)
Add a user defined code to the news headline message.
Definition: news.c:178
char * value
Definition: datasrc.h:2489
DATASRCAPI void ds_config_parse_files(void)
Parse all configuration files within the current configuration context.
Definition: config.c:2173
DATASRCAPI void ds_config_add_option_enum(char opt, const char *longopt, const char *help, int type, void *value, ds_config_enum_t *enums)
Add an enumerated option to the configuration context.
Definition: config.c:454
DATASRCAPI int ds_get_is_contrib_source(const char *name, int peer)
Check if the given peer is a contribution source for the symbol.
Definition: advmap.c:5219
DATASRCAPI void ds5_publish_response(ds5_publisher_t *pub, ds_data_t *dsdata)
Publish an initial response (for example, an image of the subject&#39;s data) following a request for a s...
Definition: dsv5_publisher.c:298
DATASRCAPI void ds_daemon_redirect(void)
Redirects the std* streams.
Definition: daemon.c:140
DATASRCAPI void ds_remove_container_symbol(ds_data_t *data, const char *symbol)
Remove an object from the container.
Definition: container.c:100
char * username
Definition: datasrc.h:1486
DATASRCAPI sock_t ds_accept_socket(sock_t fd)
Accepts a connection from a listen socket.
Definition: net.c:549
int(* ds_io_event_cb)(sock_t sock, int val, void *data)
Definition of the callback for use with read and write events.
Definition: datasrc.h:1035
DATASRCAPI ds5_publisher_t * ds5_create_broadcast_publisher(ds5_namespace_t *nspace)
Creates a data publisher that allows a DataSource application to broadcast updates to remote DataSour...
Definition: dsv5_publisher.c:806
DATASRCAPI void ds_add_data_int64(ds_data_t *data, int32_t fieldnum, int64_t value)
Add a value to a data object in the form of a 64 bit integer.
Definition: api.c:321
DATASRCAPI ds_monitor_t * ds_monitor_new_array(const char *propertyname, int type)
Create a new ds_monitor_t of an array type.
Definition: monitor.c:431
DATASRCAPI void ds5_publish_response_no_free(ds5_publisher_t *pub, ds_data_t *dsdata)
Publish an initial response (for example, an image of the subject&#39;s data) following a request for a s...
Definition: dsv5_publisher.c:314
DATASRCAPI void ds_config_add_search(const char *path)
Add a directory in which to search for configuration files.
Definition: config.c:279
unsigned short type
Definition: datasrc.h:2472
DATASRCAPI ds5_publisher_t * ds5_create_compatibility_publisher(ds5_namespace_t *nspace, ds5_dataprovider_t *provider, void *context)
Creates a data publisher that, for a given subject sends multiple subscription requests and multiple ...
Definition: dsv5_publisher.c:183
DATASRCAPI void ds_replay_by_time_from_log(time_t t, recv_replay_t callback, ds_log_t *log)
Replays all data in a log object that arrived after a specified time.
Definition: replay.c:342
DATASRCAPI void ds_replay_from_log(recv_replay_t callback, ds_log_t *log)
Replays all data in a packet log file.
Definition: replay.c:155
DATASRCAPI ds_monitor_t * ds_monitor_new_timestamp(const char *templatename, const char *key, const char *propertyname, int64_t value)
Create a new ds_monitor_t object from an input timestamp.
Definition: monitor.c:1799
DATASRCAPI void ds_set_status_msg(unsigned short msgid, const char *msgstr)
Send a user-defined status message to all connected peers.
Definition: peer.c:4290
struct _ds_io_event ds_write_event_t
Opaque type defining a write event.
Definition: datasrc.h:1015
DATASRCAPI char * ds_filename_expand(const char *format, char *buffer, size_t bufsize)
Expand a filename pattern into a fully qualified filename.
Definition: datasrc.c:1233
double value
Definition: datasrc.h:927
DATASRCAPI ds_log_t * ds_get_event_log(void)
Returns a handle to the event log used by Datasource for C.
Definition: datasrc.c:1401
recv_request_t recv_request
Definition: datasrc.h:364
DATASRCAPI ds_config_ctx_t * ds_config_set_ctx(ds_config_ctx_t *ctx)
Sets a configuration context as the current one.
Definition: config.c:258
char * password
Definition: datasrc.h:1487
struct _config_ctx ds_config_ctx_t
The configuration context data type.
Definition: datasrc.h:170
DATASRCAPI void ds_del_udp_event(ds_udp_event_t *event)
Remove a timed event.
Definition: udpsignal.c:189
DATASRCAPI int ds_send_contribution(ds_data_t *dsdata)
Contribute an object back to the peers that supplied it and support it.
Definition: advmap.c:5112
recv_map_t recv_map
Definition: datasrc.h:378
DATASRCAPI void ds_config_list_values(void)
Print the options and values in the current configuration context to standard output.
Definition: config.c:3367
Interface that must be implemented in order to receive subscirption request and subscription discard ...
Definition: datasrc.h:519
DATASRCAPI int ds_peer_all_type(int flag)
Checks if a DataSource peer of the given type is in your configuration file.
Definition: peer.c:1649
int32_t fieldnum
Definition: datasrc.h:2487
recv_peer_status_t recv_peer_status
Definition: datasrc.h:368
char * logfile
Definition: datasrc.h:381
DATASRCAPI void ds_monitor_update_ulong(const char *templatename, const char *key, const char *propertyname, uint32_t value)
Post an update to the monitoring system for an unsigned long value.
Definition: monitor.c:1500
ds_log_t * log
Definition: datasrc.h:382
DATASRCAPI ds_monitor_authenticator_t ds_monitor_set_auth(ds_monitor_authenticator_t authenticator)
Register a new authentication handler.
Definition: monitor.c:1844
struct _ds_io_event ds_except_event_t
Opaque type defining an exception event.
Definition: datasrc.h:1000
DATASRCAPI char * ds_request_object_with_flags(const char *name, int flags)
Request an object.
Definition: advmap.c:4836
struct _ds_io_event ds_read_event_t
Opaque type defining a read event.
Definition: datasrc.h:1008
DATASRCAPI void ds_add_latency_initial_timestamp(ds_data_t *dsdata)
Sets the initial time for latency chaining.
Definition: lty_chain.c:352
DATASRCAPI void ds_add_data_int8(ds_data_t *data, int32_t fieldnum, int8_t value)
Add a value to a data object in the form of an 8 bit integer.
Definition: api.c:231
DATASRCAPI void ds_add_latency_chain(ds_data_t *dsdata, char suffix, struct timespec *tp)
function used to add a measurement point to latency chain data
Definition: lty_chain.c:247
DATASRCAPI ds_timed_event_t * ds_add_periodic_event_from_time(time_t then, int starttime, int period, int id, ds_timed_event_cb cb, int val, void *data)
Add a timed event, starting at a particular offset from a given time.
Definition: event.c:1960
DATASRCAPI void ds_add_binary_string(ds_data_t *data, int32_t fieldnum, char *value)
Add a value to a data object in the form of a string.
Definition: binary.c:484
DATASRCAPI char * ds_debug_config_string(int level)
This function will convert a debug level into an appropriate string.
Definition: log.c:2087
void(* ds_config_func)(char *name, int num, char **values)
Definition of function type used for configuration callbacks.
Definition: datasrc.h:945
DATASRCAPI int ds_config_parse_file(const char *unresolved_filename)
Parse a single configuration file within the configuration context.
Definition: config.c:2525
DATASRCAPI void ds_cleardown_container_with_prefix(ds_data_t *data, const char *prefix)
Remove a set of symbols from the container.
Definition: container.c:139
DATASRCAPI int ds_get_gmt_offset(time_t t)
Calculate offset between local time and gmt.
Definition: event.c:1795
DATASRCAPI void ds_add_binary_uint64(ds_data_t *data, int32_t fieldnum, uint64_t value)
Add a value to a data object in the form of an unsigned 64 bit integer.
Definition: binary.c:455
DATASRCAPI int ds_and3_iszero(ds_set_t *p1, ds_set_t *p2, ds_set_t *p3)
Check if the bitwise and of 3 peer sets is 0.
Definition: peerset.c:153
DATASRCAPI int ds_del_read_event(ds_read_event_t *ev)
Remove a socket read event.
Definition: event.c:633
int32_t len
Definition: datasrc.h:2488
DATASRCAPI int ds_log_get_level(ds_log_t *log)
Get the current loglevel for the given logfile.
Definition: log.c:2578
DATASRCAPI void ds_or(ds_set_t *p1, ds_set_t *p2, ds_set_t *o)
Combine 2 peersets using bitwise or.
Definition: peerset.c:75
struct _ds_io_event ds_generic_event_t
Opaque type defining a generic read/write event.
Definition: datasrc.h:1022
void ds_log(ds_log_t *log, int level, const char *fmt,...)
Write a formatted string prefixed with log level and timestamp to the log object. ...
Definition: log.c:2191
DATASRCAPI int ds_daemon_disabled(void)
Check whether the application is running in daemon mode.
Definition: daemon.c:160
recv_nodata_t recv_nodata
Definition: datasrc.h:367
DATASRCAPI int ds_peer_host_details_r(int peer, char *buffer, size_t buflen)
Gets details of the remote side of a peer. User must provide buffer for the address.
Definition: peer.c:7333
DATASRCAPI int ds_init(ds_init_t *init, int argc, char **argv)
Parse the configuration files and initialise the DataSource library.
Definition: datasrc.c:455
DATASRCAPI int ds_peer_details(int peer, char **name)
Gets the ID and name of a peer.
Definition: peer.c:1290
char * ipaddress
Definition: datasrc.h:1488
DATASRCAPI int32_t ds_add_record_float(ds_data_t *data, const char *field, double value)
Add a floating point value to a record object.
Definition: record.c:160
void ds_printf_time(ds_log_t *log, const char *fmt,...)
Write a formatted string prefixed with a timestamp string to a log object.
Definition: log.c:1155
DATASRCAPI void ds_send_nodata_to_peer(int peer, const char *subject, unsigned short flags)
Send a "no data" message to a specific DataSource pper.
Definition: api.c:848
DATASRCAPI void ds_discard_objects(int count, char **obs)
Discard a number of objects.
Definition: advmap.c:5047
DATASRCAPI int ds_del_write_event(ds_write_event_t *ev)
Remove a socket write event.
Definition: event.c:693
DATASRCAPI void ds_timed_event_set_callback(ds_timed_event_t *ev, ds_timed_event_cb cb, int val, void *data)
Change the callback and callback values for a timed eent.
Definition: event.c:1531
DATASRCAPI int ds_get_service_by_index(int index, char **name_ptr)
Return the name/state of a service by index.
Definition: advmap.c:5294
DATASRCAPI void ds_replay_by_field_from_log(int fieldnum, char *value, recv_replay_t callback, ds_log_t *log)
Replays all data in the log object that arrived after an update with the specified value for the spec...
Definition: replay.c:440
struct _ds_delay ds_delay_t
The delay channel object type.
Definition: datasrc.h:164
DATASRCAPI ds_monitor_t * ds_monitor_new_ushort(const char *templatename, const char *key, const char *propertyname, uint16_t value)
Create a new ds_monitor_t object from an input unsigned short.
Definition: monitor.c:1645
DATASRCAPI void ds_config_add_bounded_option(char sopt, const char *longopt, const char *help, int type, void *value, void *min, void *max)
Add a bounded configuration option to the current configuration context.
Definition: config.c:425
DATASRCAPI void ds_add_container_symbol_at_position(ds_data_t *data, int position, const char *symbol)
Insert an object within a container at a particular position.
Definition: container.c:119
int(* ds_udp_event_cb)(int argc, char *argv[], int val, void *data)
Definition of the callback for use with udp events.
Definition: datasrc.h:2528
DATASRCAPI struct sockaddr_storage * ds_gethostsockaddr(const char *name, struct sockaddr_storage *populate)
Return the socket address for a given hostname.
Definition: net.c:247
DATASRCAPI time_t ds_get_time(void)
Gets the current time in seconds.
Definition: event.c:1102
void ds_syslog(ds_log_t *log, int level, const char *fmt,...)
Write a formatted string to a log object and to the system log.
Definition: log.c:1253
DATASRCAPI int ds_del_except_event_free_data(ds_except_event_t *ev, void(*free_data)(int, void *))
Remove a socket except event.
Definition: event.c:787
int(* match)(ds5_namespace_t *nspace, const char *subject)
Tests a subject to see if it falls within this namespace.
Definition: datasrc.h:449
DATASRCAPI void ds_add_binary_float64(ds_data_t *data, int32_t fieldnum, double value)
Add a value to a data object in the form of a floating point number.
Definition: binary.c:249
DATASRCAPI ds5_publisher_t * ds5_create_active_publisher(ds5_namespace_t *nspace, ds5_dataprovider_t *provider, void *context)
Creates a data publisher that for a given subject sends multiple subscription requests and a single s...
Definition: dsv5_publisher.c:125
DATASRCAPI int ds_peer_details_r(int peer, char *buffer, size_t buflen)
Gets the ID and name of a peer. User must provide buffer for the name.
Definition: peer.c:7295
DATASRCAPI ds_delay_t * ds_new_delay_with_callback(double delay_time, char *prefix, double batch_time, void *callback_param, ds_delay_send_cb callback_func)
Create a new delay channel.
Definition: delay.c:238
DATASRCAPI ds_data_t * ds_init_page(const char *subject, int rows, int cols, const char *type, unsigned short flags)
Initialise a data object as a page.
Definition: page.c:62
DATASRCAPI void ds_add_page_field(ds_data_t *data, int32_t fieldnum, const char *value)
Add an arbitrary field to a page.
Definition: page.c:126
int datatype
Definition: datasrc.h:1419
DATASRCAPI void ds_monitor_update_timestamp(const char *templatename, const char *key, const char *propertyname, int64_t value)
Post an update to the monitoring system for a timestamp value.
Definition: monitor.c:1577
recv_discard_t recv_discard
Definition: datasrc.h:365
DATASRCAPI void ds_add_page_row(ds_data_t *data, int row, int col, const char *str)
Add a row of data to a page data object.
Definition: page.c:100
DATASRCAPI sock_t ds_multicast_listen_socket(const char *p_interface, const char *addr, int port)
Creates a multicast listen socket.
Definition: net.c:571
DATASRCAPI int ds_get_num_services(void)
Return the number of services.
Definition: advmap.c:5277
DATASRCAPI ds_monitor_t * ds_monitor_new_ulong(const char *templatename, const char *key, const char *propertyname, uint32_t value)
Create a new ds_monitor_t object from an input unsigned long.
Definition: monitor.c:1711
DATASRCAPI int ds_del_read_event_free_data(ds_read_event_t *ev, void(*free_data)(int, void *))
Remove a socket read event.
Definition: event.c:668
DATASRCAPI int ds_fields_numbyindex(int index)
Return the field number of this index.
Definition: fields.c:604
DATASRCAPI void ds_free_log(ds_log_t *log)
Destroy a log object.
Definition: log.c:977
DATASRCAPI void ds_monitor_update_ushort(const char *templatename, const char *key, const char *propertyname, uint16_t)
Post an update to the monitoring system for an unsigned short value.
Definition: monitor.c:1441
DATASRCAPI struct tm * ds_localtime(void)
Get the current time in the local timezone.
Definition: event.c:1128
DATASRCAPI void ds_set_object_data(const char *name, void *data)
Set an objects user data.
Definition: advmap.c:5619
DATASRCAPI int ds_peer_id(int peer)
Gets the ID of a peer.
Definition: peer.c:1348
DATASRCAPI void ds_add_data(ds_data_t *data, int32_t fieldnum, const char *value)
Adds a string value to a data object.
Definition: api.c:108

Generated on Wed Jul 6 2022 16:57:17 for DataSource for C SDK