Apama  9.12.0.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
engine_client_c.h
Go to the documentation of this file.
1 /*
2  * engine_client_c.h
3  *
4  * $Copyright(c) 2002-2012 Progress Software Corporation and/or its subsidiaries and affiliates. All rights reserved.$
5  * $Copyright (c) 2013-2016 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.$
6  * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG
7  *
8  * $Id: engine_client_c.h 287963 2016-07-29 14:31:18Z matj $
9  */
10 
15 #ifndef ENGINE_CLIENT_C_H
16 #define ENGINE_CLIENT_C_H
17 
18 
19 #include <AP_Types.h>
20 #include <AP_Platform.h>
21 
22 #ifndef ENGINE_CLIENT_CPP_HPP
23 #ifdef __GNUC__
24 #warning The Apama Client C-API is deprecated. Please use the C++ API located in engine_client_cpp.hpp instead
25 #else
26 #pragma message("engine_client_c.h(0) Warning: The Apama Client C-API is deprecated. Please use the C++ API located in engine_client_cpp.hpp instead")
27 #endif
28 #endif
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif /* __cplusplus */
33 
34 
35  struct AP_Event_API;
36  struct AP_EventSupplier_API;
37  struct AP_EventConsumer_API;
39  struct AP_MonitorScript_API;
40  struct AP_EngineStatus_API;
41  struct AP_NameInfo_API;
45  struct AP_NamedTimerInfo_API;
50  struct AP_EngineInfo_API;
52 
53 #ifdef __cplusplus
54  struct AP_Event_Stubs;
55  struct AP_EventSupplier_Stubs;
56  struct AP_EventConsumer_Stubs;
57  struct AP_DisconnectableEventConsumer_Stubs;
58  struct AP_MonitorScript_Stubs;
59  struct AP_EngineStatus_Stubs;
60  struct AP_NameInfo_Stubs;
61  struct AP_NamedMonitorInfo_Stubs;
62  struct AP_NamedJavaApplicationInfo_Stubs;
63  struct AP_NamedEventTypeInfo_Stubs;
64  struct AP_NamedTimerInfo_Stubs;
65  struct AP_NamedContextInfo_Stubs;
66  struct AP_NamedAggregateInfo_Stubs;
67  struct AP_NamedReceiverInfo_Stubs;
68  struct AP_NamedPluginReceiverInfo_Stubs;
69  struct AP_EngineInfo_Stubs;
70  struct AP_EngineManagement_Stubs;
71 
76  typedef struct AP_Event_Stubs AP_Event;
77 
88  typedef struct AP_EventSupplier_Stubs AP_EventSupplier;
89 
99  typedef struct AP_EventConsumer_Stubs AP_EventConsumer;
100 
114  typedef struct AP_DisconnectableEventConsumer_Stubs AP_DisconnectableEventConsumer;
115 
122  typedef struct AP_MonitorScript_Stubs AP_MonitorScript;
123 
128  typedef struct AP_EngineStatus_Stubs AP_EngineStatus;
129 
137  typedef struct AP_NameInfo_Stubs AP_NameInfo;
138 
144  typedef struct AP_NamedMonitorInfo_Stubs AP_NamedMonitorInfo;
145 
151  typedef struct AP_NamedJavaApplicationInfo_Stubs AP_NamedJavaApplicationInfo;
152 
158  typedef struct AP_NamedEventTypeInfo_Stubs AP_NamedEventTypeInfo;
159 
165  typedef struct AP_NamedTimerInfo_Stubs AP_NamedTimerInfo;
166 
172  typedef struct AP_NamedContextInfo_Stubs AP_NamedContextInfo;
173 
180  typedef struct AP_NamedAggregateInfo_Stubs AP_NamedAggregateInfo;
181 
188  typedef struct AP_NamedReceiverInfo_Stubs AP_NamedReceiverInfo;
189 
196  typedef struct AP_NamedPluginReceiverInfo_Stubs AP_NamedPluginReceiverInfo;
197 
212  typedef struct AP_EngineInfo_Stubs AP_EngineInfo;
213 
224  typedef struct AP_EngineManagement_Stubs AP_EngineManagement;
225 
226 #else
227  typedef struct AP_Event_API AP_Event;
228  typedef struct AP_EventSupplier_API AP_EventSupplier;
229  typedef struct AP_EventConsumer_API AP_EventConsumer;
231  typedef struct AP_MonitorScript_API AP_MonitorScript;
232  typedef struct AP_EngineStatus_API AP_EngineStatus;
233  typedef struct AP_NameInfo_API AP_NameInfo;
242  typedef struct AP_EngineInfo_API AP_EngineInfo;
244 #endif /* __cplusplus */
245 
246 
252  {
260  const AP_char8* (AP_ENGINE_CLIENT_CALL* getText)(AP_Event* event);
270  const AP_char8* (AP_ENGINE_CLIENT_CALL* getChannel)(AP_Event* event);
282  double (AP_ENGINE_CLIENT_CALL* getTime)(AP_Event* event);
283  };
284 
290  {
291  void* reserved;
294  };
295 
296  struct AP_Event_Stubs
297  {
298  struct AP_Event_API api;
299 
300 #ifdef __cplusplus
301  const AP_char8* getText() {
302  return api.functions->getText(this);
303  }
304 
305  const AP_char8* getChannel() {
306  return api.functions->getChannel(this);
307  }
308 
309  double getTime() {
310  return api.functions->getTime(this);
311  }
312 #endif /* __cplusplus */
313  };
314 
315 
321  {
332  void (AP_ENGINE_CLIENT_CALL* disconnect)(AP_EventSupplier* supplier);
333  };
334 
340  {
341  void* reserved;
344  };
345 
346  struct AP_EventSupplier_Stubs {
347  struct AP_EventSupplier_API api;
348 
349 #ifdef __cplusplus
350  void disconnect() {
351  api.functions->disconnect(this);
352  }
353 #endif /*__cplusplus */
354  };
355 
361  {
375  void (AP_ENGINE_CLIENT_CALL* sendEvents)(AP_EventConsumer* consumer, AP_Event** events);
376  };
377 
383  {
384  void* reserved;
387  };
388 
389  struct AP_EventConsumer_Stubs
390  {
391  struct AP_EventConsumer_API api;
392 
393 #ifdef __cplusplus
394  void sendEvents(AP_Event** events) {
395  api.functions->sendEvents(this, events);
396  }
397 #endif /* __cplusplus */
398  };
399 
405  {
414  void (AP_ENGINE_CLIENT_CALL* disconnect)(AP_DisconnectableEventConsumer* consumer, const AP_char8* reason);
415  };
416 
422  {
423  void *reserved;
428  };
429 
430  struct AP_DisconnectableEventConsumer_Stubs
431  {
433 
434 #ifdef __cplusplus
435  void disconnect(const AP_char8* reason) {
436  api.functions->disconnect(this, reason);
437  }
438 
439  void sendEvents(AP_Event** events) {
440  api.s_EventConsumer->api.functions->sendEvents(api.s_EventConsumer, events);
441  }
442 #endif /* __cplusplus */
443  };
444 
450  {
459  const AP_char8* (AP_ENGINE_CLIENT_CALL* getText)(AP_MonitorScript* script);
460  };
461 
467  {
468  void* reserved;
471  };
472 
473  struct AP_MonitorScript_Stubs
474  {
475  struct AP_MonitorScript_API api;
476 
477 #ifdef __cplusplus
478  const AP_char8* getText() {
479  return api.functions->getText(this);
480  };
481 #endif /*__cplusplus */
482  };
483 
484 
490  {
495  AP_bool (AP_ENGINE_CLIENT_CALL* print)(AP_EngineStatus* status, AP_char8* buf, AP_uint32 size);
496 
502  AP_uint64 (AP_ENGINE_CLIENT_CALL* getUptime)(AP_EngineStatus* status);
503 
508  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumMonitors)(AP_EngineStatus* status);
509 
516  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumProcesses)(AP_EngineStatus* status);
517 
522  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumListeners)(AP_EngineStatus* status);
523 
528  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumEventTypes)(AP_EngineStatus* status);
529 
535  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumQueuedFastTrack)(AP_EngineStatus* status);
536 
542  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumQueuedInput)(AP_EngineStatus* status);
543 
550  AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumReceived)(AP_EngineStatus* status);
551 
556  AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumFastTracked)(AP_EngineStatus* status);
557 
563  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumConsumers)(AP_EngineStatus* status);
564 
569  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumOutputEventsQueued)(AP_EngineStatus* status);
570 
577  AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumOutputEventsCreated)(AP_EngineStatus* status);
578 
586  AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumOutputEventsSent)(AP_EngineStatus* status);
587 
591  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumJavaApplications)(AP_EngineStatus* status);
592 
598  AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumProcessed)(AP_EngineStatus* status);
599 
604  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumSubListeners)(AP_EngineStatus* status);
605 
610  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumContexts)(AP_EngineStatus* status);
611 
616  const AP_char8* (AP_ENGINE_CLIENT_CALL* getMostBackedUpInput)(AP_EngineStatus* status);
617 
622  AP_uint32 (AP_ENGINE_CLIENT_CALL* getMostBackedUpQueueSize)(AP_EngineStatus* status);
623 
628  const AP_char8* (AP_ENGINE_CLIENT_CALL* getSlowestReceiver)(AP_EngineStatus* status);
629 
634  AP_uint32 (AP_ENGINE_CLIENT_CALL* getSlowestReceiverQueueSize)(AP_EngineStatus* status);
635 
660  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNextStatusItem)(AP_EngineStatus* status, const char **name, const char **value, void **opaque_state);
661 
666  const AP_char8* (AP_ENGINE_CLIENT_CALL* getStatusValue)(AP_EngineStatus* status, const char *key);
667 
672  AP_uint64 (AP_ENGINE_CLIENT_CALL* getStatusIntValue)(AP_EngineStatus* status, const char *key);
673 
678  void (AP_ENGINE_CLIENT_CALL* deleteStatus)(AP_EngineStatus *status);
679 
684  AP_EngineStatus *(AP_ENGINE_CLIENT_CALL* copyStatus)(AP_EngineStatus *status);
685 
690  void *(AP_ENGINE_CLIENT_CALL* copyIterator)(AP_EngineStatus* status, void *opaque_state);
691 
696  void (AP_ENGINE_CLIENT_CALL* disposeIterator)(AP_EngineStatus* status, void *opaque_state);
697 
705  AP_int64 (AP_ENGINE_CLIENT_CALL* getUserInt)(AP_EngineStatus* status, const char* key);
706 
714  AP_int64 (AP_ENGINE_CLIENT_CALL* getUserIntOr)(AP_EngineStatus* status, const char* key, AP_int64 alt);
715 
723  AP_float64(AP_ENGINE_CLIENT_CALL* getUserFloat)(AP_EngineStatus* status, const char* key);
731  AP_float64(AP_ENGINE_CLIENT_CALL* getUserFloatOr)(AP_EngineStatus* status, const char* key, AP_float64 alt);
732 
740  AP_bool(AP_ENGINE_CLIENT_CALL* getUserBool)(AP_EngineStatus* status, const char* key);
741 
749  AP_bool(AP_ENGINE_CLIENT_CALL* getUserBoolOr)(AP_EngineStatus* status, const char* key, AP_bool alt);
750 
758  const AP_char8*(AP_ENGINE_CLIENT_CALL* getUserString)(AP_EngineStatus* status, const char* key);
759 
767  const AP_char8*(AP_ENGINE_CLIENT_CALL* getUserStringOr)(AP_EngineStatus* status, const char* key, const AP_char8* alt);
768  };
769 
775  {
776  void* reserved;
779  };
780 
781  struct AP_EngineStatus_Stubs
782  {
783  struct AP_EngineStatus_API api;
784 
785 #ifdef __cplusplus
786  AP_bool print(AP_char8* buf, AP_uint32 size) {
787  return api.functions->print(this,buf,size);
788  }
789 
790  AP_uint64 getUptime() {
791  return api.functions->getUptime(this);
792  }
793 
794  AP_uint32 getNumMonitors() {
795  return api.functions->getNumMonitors(this);
796  }
797 
798  AP_uint32 getNumProcesses() {
799  return api.functions->getNumProcesses(this);
800  }
801 
802  AP_uint32 getNumJavaApplications() {
803  return api.functions->getNumJavaApplications(this);
804  }
805 
806  AP_uint32 getNumListeners() {
807  return api.functions->getNumListeners(this);
808  }
809 
810  AP_uint32 getNumEventTypes() {
811  return api.functions->getNumEventTypes(this);
812  }
813 
814  AP_uint32 getNumQueuedFastTrack() {
815  return api.functions->getNumQueuedFastTrack(this);
816  }
817 
818  AP_uint32 getNumQueuedInput() {
819  return api.functions->getNumQueuedInput(this);
820  }
821 
822  AP_uint64 getNumReceived() {
823  return api.functions->getNumReceived(this);
824  }
825 
826  AP_uint64 getNumFastTracked() {
827  return api.functions->getNumFastTracked(this);
828  }
829 
830  AP_uint32 getNumConsumers() {
831  return api.functions->getNumConsumers(this);
832  }
833 
834  AP_uint32 getNumOutputEventsQueued() {
835  return api.functions->getNumOutputEventsQueued(this);
836  }
837 
838  AP_uint64 getNumOutputEventsCreated() {
839  return api.functions->getNumOutputEventsCreated(this);
840  }
841 
842  AP_uint64 getNumOutputEventsSent() {
843  return api.functions->getNumOutputEventsSent(this);
844  }
845 
846  AP_uint64 getNumProcessed() {
847  return api.functions->getNumProcessed(this);
848  }
849 
850  AP_uint32 getNumSubListeners() {
851  return api.functions->getNumSubListeners(this);
852  }
853 
854  AP_uint32 getNumContexts() {
855  return api.functions->getNumContexts(this);
856  }
857 
858  AP_uint32 getNextStatusItem(const char **name, const char **value, void **opaque_state) {
859  return api.functions->getNextStatusItem(this, name, value, opaque_state);
860  }
861 
862  AP_int64 getUserInt(const char* key) {
863  return api.functions->getUserInt(this, key);
864  }
865  AP_int64 getUserIntOr(const char* key, AP_int64 alt) {
866  return api.functions->getUserIntOr(this, key, alt);
867  }
868 
869  AP_float64 getUserFloat(const char* key) {
870  return api.functions->getUserFloat(this, key);
871  }
872  AP_float64 getUserFloatOr(const char* key, AP_float64 alt) {
873  return api.functions->getUserFloatOr(this, key, alt);
874  }
875 
876  AP_bool getUserBool(AP_EngineStatus* status, const char* key) {
877  return api.functions->getUserBool(this, key);
878  }
879  AP_bool getUserBoolOr(AP_EngineStatus* status, const char* key, AP_bool alt) {
880  return api.functions->getUserBoolOr(this, key, alt);
881  }
882 
883  const AP_char8* getUserString(AP_EngineStatus* status, const char* key) {
884  return api.functions->getUserString(this, key);
885  }
886  const AP_char8* getUserStringOr(AP_EngineStatus* status, const char* key, const AP_char8* alt) {
887  return api.functions->getUserStringOr(this, key, alt);
888  }
889 
890  void disposeIterator(void *opaque_state) {
891  api.functions->disposeIterator(this, opaque_state);
892  }
893  const AP_char8* getMostBackedUpInput() {
894  return api.functions->getMostBackedUpInput(this);
895  }
896  AP_uint32 getMostBackedUpQueueSize() {
897  return api.functions->getMostBackedUpQueueSize(this);
898  }
899 
900  const AP_char8* getSlowestReceiver() {
901  return api.functions->getSlowestReceiver(this);
902  }
903 
904  AP_uint32 getSlowestReceiverQueueSize() {
905  return api.functions->getSlowestReceiverQueueSize(this);
906  }
907 
908 
909 #endif /*__cplusplus */
910  };
911 
917  {
922  const AP_char8* (AP_ENGINE_CLIENT_CALL* getName)(AP_NameInfo* info);
923 
929  const AP_char8* (AP_ENGINE_CLIENT_CALL* getPackage)(AP_NameInfo* info);
930 
935  const AP_char8* (AP_ENGINE_CLIENT_CALL* getFullyQualifiedName)(AP_NameInfo* info);
936  };
937 
943  {
944  void* reserved;
947  };
948 
949  struct AP_NameInfo_Stubs
950  {
951  struct AP_NameInfo_API api;
952 
953 #ifdef __cplusplus
954  const AP_char8* getName() {
955  return api.functions->getName(this);
956  }
957 
958  const AP_char8* getPackage() {
959  return api.functions->getPackage(this);
960  }
961 
962  const AP_char8* getFullyQualifiedName() {
963  return api.functions->getFullyQualifiedName(this);
964  }
965 #endif /*__cplusplus */
966  };
967 
968 
974  {
979  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumSubMonitors)(AP_NamedMonitorInfo* info);
980  };
981 
987  {
988  void* reserved;
993  };
994 
995  struct AP_NamedMonitorInfo_Stubs
996  {
997  struct AP_NamedMonitorInfo_API api;
998 
999 #ifdef __cplusplus
1000  AP_uint32 getNumSubMonitors() {
1001  return api.functions->getNumSubMonitors(this);
1002  }
1003 
1004  const AP_char8* getName() {
1005  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1006  }
1007 
1008  const AP_char8* getPackage() {
1009  return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
1010  }
1011 
1012  const AP_char8* getFullyQualifiedName() {
1013  return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
1014  }
1015 #endif /*__cplusplus */
1016  };
1017 
1018 
1024  {
1029  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumListeners)(AP_NamedJavaApplicationInfo* info);
1030  };
1031 
1037  {
1038  void* reserved;
1043  };
1044 
1045  struct AP_NamedJavaApplicationInfo_Stubs
1046  {
1048 
1049 #ifdef __cplusplus
1050  AP_uint32 getNumListeners() {
1051  return api.functions->getNumListeners(this);
1052  }
1053 
1054  const AP_char8* getName() {
1055  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1056  }
1057 
1058  const AP_char8* getPackage() {
1059  return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
1060  }
1061 
1062  const AP_char8* getFullyQualifiedName() {
1063  return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
1064  }
1065 #endif /*__cplusplus */
1066  };
1067 
1068 
1074  {
1079  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumEventTemplates)(AP_NamedEventTypeInfo* info);
1080  };
1081 
1087  {
1088  void* reserved;
1093  };
1094 
1095  struct AP_NamedEventTypeInfo_Stubs
1096  {
1097  struct AP_NamedEventTypeInfo_API api;
1098 
1099 #ifdef __cplusplus
1100  AP_uint32 getNumEventTemplates() {
1101  return api.functions->getNumEventTemplates(this);
1102  }
1103 
1104  const AP_char8* getName() {
1105  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1106  }
1107 
1108  const AP_char8* getPackage() {
1109  return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
1110  }
1111 
1112  const AP_char8* getFullyQualifiedName() {
1113  return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
1114  }
1115 #endif /*__cplusplus */
1116  };
1117 
1118 
1124  {
1129  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumTimers)(AP_NamedTimerInfo* info);
1130  };
1131 
1137  {
1138  void* reserved;
1143  };
1144 
1145  struct AP_NamedTimerInfo_Stubs
1146  {
1147  struct AP_NamedTimerInfo_API api;
1148 
1149 #ifdef __cplusplus
1150  AP_uint32 getNumTimers() {
1151  return api.functions->getNumTimers(this);
1152  }
1153 
1154  const AP_char8* getName() {
1155  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1156  }
1157 
1158  const AP_char8* getPackage() {
1159  return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
1160  }
1161 
1162  const AP_char8* getFullyQualifiedName() {
1163  return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
1164  }
1165 #endif /*__cplusplus */
1166  };
1167 
1168 
1178  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumSubMonitors)(AP_NamedContextInfo* info);
1179 
1184  AP_uint32 (AP_ENGINE_CLIENT_CALL* getQueueSize)(AP_NamedContextInfo* info);
1185 
1190  char const *const *(AP_ENGINE_CLIENT_CALL *getChannels)(AP_NamedContextInfo *info);
1191  };
1192 
1198  {
1199  void* reserved;
1204  };
1205 
1206  struct AP_NamedContextInfo_Stubs
1207  {
1208  struct AP_NamedContextInfo_API api;
1209 
1210 #ifdef __cplusplus
1211  const AP_char8* getName() {
1212  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1213  }
1214 
1215  AP_uint32 getNumSubMonitors() {
1216  return api.functions->getNumSubMonitors(this);
1217  }
1218 
1219  AP_uint32 getQueueSize() {
1220  return api.functions->getQueueSize(this);
1221  }
1222 
1223  char const *const *getChannels() {
1224  return api.functions->getChannels(this);
1225  }
1226 
1227 #endif /*__cplusplus */
1228  };
1229 
1235  {
1236  void** placeholder;
1237  };
1238 
1244  {
1245  void* reserved;
1250  };
1251 
1252  struct AP_NamedAggregateInfo_Stubs
1253  {
1254  struct AP_NamedAggregateInfo_API api;
1255 
1256 #ifdef __cplusplus
1257  const AP_char8* getName() {
1258  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1259  }
1260 
1261  const AP_char8* getPackage() {
1262  return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
1263  }
1264 
1265  const AP_char8* getFullyQualifiedName() {
1266  return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
1267  }
1268 #endif /*__cplusplus */
1269  };
1270 
1276  {
1281  AP_uint32 (AP_ENGINE_CLIENT_CALL* getQueueSize)(AP_NamedReceiverInfo* info);
1282 
1287  char const *const *(AP_ENGINE_CLIENT_CALL *getChannels)(AP_NamedReceiverInfo *info);
1288 
1293  const AP_char8 *(AP_ENGINE_CLIENT_CALL *getAddress)(AP_NamedReceiverInfo *info);
1294  };
1295 
1301  {
1302  void* reserved;
1307  };
1308 
1309  struct AP_NamedReceiverInfo_Stubs
1310  {
1311  struct AP_NamedReceiverInfo_API api;
1312 
1313 #ifdef __cplusplus
1314  const AP_char8 *getName() {
1315  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1316  }
1317 
1318  const AP_char8 *getAddress() {
1319  return api.functions->getAddress(this);
1320  }
1321 
1322  AP_uint32 getQueueSize() {
1323  return api.functions->getQueueSize(this);
1324  }
1325 
1326  char const *const *getChannels() {
1327  return api.functions->getChannels(this);
1328  }
1329 
1330 #endif /*__cplusplus */
1331  };
1332 
1338  {
1343  AP_uint32 (AP_ENGINE_CLIENT_CALL* getQueueSize)(AP_NamedPluginReceiverInfo* info);
1344 
1349  char const *const *(AP_ENGINE_CLIENT_CALL *getChannels)(AP_NamedPluginReceiverInfo *info);
1350  };
1351 
1357  {
1358  void* reserved;
1363  };
1364 
1365  struct AP_NamedPluginReceiverInfo_Stubs
1366  {
1367  struct AP_NamedPluginReceiverInfo_API api;
1368 
1369 #ifdef __cplusplus
1370  const AP_char8 *getName() {
1371  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1372  }
1373 
1374  AP_uint32 getQueueSize() {
1375  return api.functions->getQueueSize(this);
1376  }
1377 
1378  char const *const *getChannels() {
1379  return api.functions->getChannels(this);
1380  }
1381 
1382 #endif /*__cplusplus */
1383  };
1384 
1390  {
1395  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumMonitors)(AP_EngineInfo* info);
1396 
1401  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumEventTypes)(AP_EngineInfo* info);
1402 
1407  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumTimers)(AP_EngineInfo* info);
1408 
1417  AP_NamedMonitorInfo** (AP_ENGINE_CLIENT_CALL* getMonitors)(AP_EngineInfo* info);
1418 
1427  AP_NamedEventTypeInfo** (AP_ENGINE_CLIENT_CALL* getEventTypes)(AP_EngineInfo* info);
1428 
1437  AP_NamedTimerInfo** (AP_ENGINE_CLIENT_CALL* getTimers)(AP_EngineInfo* info);
1438 
1443  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumJavaApplications)(AP_EngineInfo* info);
1444 
1453  AP_NamedJavaApplicationInfo** (AP_ENGINE_CLIENT_CALL* getJavaApplications)(AP_EngineInfo* info);
1454 
1459  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumContexts)(AP_EngineInfo* info);
1460 
1469  AP_NamedContextInfo** (AP_ENGINE_CLIENT_CALL* getContexts)(AP_EngineInfo* info);
1470 
1475  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumAggregates)(AP_EngineInfo* info);
1476 
1485  AP_NamedAggregateInfo** (AP_ENGINE_CLIENT_CALL* getAggregates)(AP_EngineInfo* info);
1486 
1491  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumReceivers)(AP_EngineInfo* info);
1492 
1501  AP_NamedReceiverInfo** (AP_ENGINE_CLIENT_CALL* getReceivers)(AP_EngineInfo* info);
1502 
1507  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumPluginReceivers)(AP_EngineInfo* info);
1508 
1517  AP_NamedPluginReceiverInfo** (AP_ENGINE_CLIENT_CALL* getPluginReceivers)(AP_EngineInfo* info);
1518  };
1519 
1525  {
1526  void* reserved;
1529  };
1530 
1531  struct AP_EngineInfo_Stubs
1532  {
1533  struct AP_EngineInfo_API api;
1534 
1535 #ifdef __cplusplus
1536  AP_uint32 getNumMonitors() {
1537  return api.functions->getNumMonitors(this);
1538  }
1539 
1540  AP_uint32 getNumEventTypes() {
1541  return api.functions->getNumEventTypes(this);
1542  }
1543 
1544  AP_uint32 getNumTimers() {
1545  return api.functions->getNumTimers(this);
1546  }
1547 
1548  AP_NamedMonitorInfo** getMonitors() {
1549  return api.functions->getMonitors(this);
1550  }
1551 
1552  AP_NamedEventTypeInfo** getEventTypes() {
1553  return api.functions->getEventTypes(this);
1554  }
1555 
1556  AP_NamedTimerInfo** getTimers() {
1557  return api.functions->getTimers(this);
1558  }
1559 
1560  AP_uint32 getNumJavaApplications() {
1561  return api.functions->getNumJavaApplications(this);
1562  }
1563 
1564  AP_NamedJavaApplicationInfo** getJavaApplications() {
1565  return api.functions->getJavaApplications(this);
1566  }
1567 
1568  AP_uint32 getNumContexts() {
1569  return api.functions->getNumContexts(this);
1570  }
1571 
1572  AP_NamedContextInfo** getContexts() {
1573  return api.functions->getContexts(this);
1574  }
1575 
1576  AP_uint32 getNumAggregates() {
1577  return api.functions->getNumAggregates(this);
1578  }
1579 
1580  AP_NamedAggregateInfo** getAggregates() {
1581  return api.functions->getAggregates(this);
1582  }
1583 
1584  AP_uint32 getNumReceivers() {
1585  return api.functions->getNumReceivers(this);
1586  }
1587 
1588  AP_NamedReceiverInfo** getReceivers() {
1589  return api.functions->getReceivers(this);
1590  }
1591 
1592  AP_uint32 getNumPluginReceivers() {
1593  return api.functions->getNumPluginReceivers(this);
1594  }
1595 
1596  AP_NamedPluginReceiverInfo** getPluginReceivers() {
1597  return api.functions->getPluginReceivers(this);
1598  }
1599 
1600 #endif /*__cplusplus */
1601  };
1602 
1603 
1613  };
1614 
1616 
1617 
1623  {
1631  void (AP_ENGINE_CLIENT_CALL* injectMonitorScript)(AP_EngineManagement* engine, AP_MonitorScript* script);
1632 
1642  void (AP_ENGINE_CLIENT_CALL* injectJava)(AP_EngineManagement* engine, const AP_uint8* jarbytes, AP_uint32 size);
1643 
1654  void (AP_ENGINE_CLIENT_CALL* injectCDP)(AP_EngineManagement* engine, const AP_uint8* cdpbytes, AP_uint32 size, const char*filename);
1655 
1663  void (AP_ENGINE_CLIENT_CALL* deleteName)(AP_EngineManagement* engine, const AP_char8* name);
1664 
1672  void (AP_ENGINE_CLIENT_CALL* forceDeleteName)(AP_EngineManagement* engine, const AP_char8* name);
1673 
1681  void (AP_ENGINE_CLIENT_CALL* killName)(AP_EngineManagement* engine, const AP_char8* name);
1682 
1687  void (AP_ENGINE_CLIENT_CALL* deleteAll)(AP_EngineManagement* engine);
1688 
1697  AP_EngineStatus* (AP_ENGINE_CLIENT_CALL* getStatus)(AP_EngineManagement* engine);
1698 
1714  AP_EventSupplier* (AP_ENGINE_CLIENT_CALL* connectEventConsumer)(AP_EngineManagement* engine, AP_EventConsumer* consumer, const AP_char8* const* channels);
1715 
1731  AP_EventSupplier* (AP_ENGINE_CLIENT_CALL* connectDisconnectableEventConsumer)(AP_EngineManagement* engine, AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels);
1732 
1753  AP_EventSupplier* (AP_ENGINE_CLIENT_CALL* connectDisconnectableSlowEventConsumer)(AP_EngineManagement* engine, AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels, AP_bool disconnectIfSlow);
1754 
1772  AP_bool (AP_ENGINE_CLIENT_CALL* attachAsEventConsumerTo)(AP_EngineManagement* engine, AP_EngineManagement* target, const AP_char8* const* channels, AP_bool disconnectSlow, AP_EngineManagement_ConnectMode mode);
1773 
1792  AP_bool (AP_ENGINE_CLIENT_CALL* attachAsEventConsumerToHost)(AP_EngineManagement* engine, const AP_char8* hostname, AP_uint16 port, const AP_char8* const* channels, AP_bool disconnectSlow, AP_EngineManagement_ConnectMode mode);
1793 
1806  void (AP_ENGINE_CLIENT_CALL* detachAsEventConsumerFrom)(AP_EngineManagement* engine, AP_EngineManagement* target, const AP_char8* const* channels, AP_EngineManagement_ConnectMode mode);
1807 
1821  void (AP_ENGINE_CLIENT_CALL* detachAsEventConsumerFromHost)(AP_EngineManagement* engine, const AP_char8* hostname, AP_uint16 port, const AP_char8* const* channels, AP_EngineManagement_ConnectMode mode);
1822 
1832  AP_EngineInfo* (AP_ENGINE_CLIENT_CALL* inspectEngine)(AP_EngineManagement* engine);
1833 
1844  void (AP_ENGINE_CLIENT_CALL* ping)(AP_EngineManagement* engine);
1845 
1852  AP_bool (AP_ENGINE_CLIENT_CALL* isConnected)(AP_EngineManagement* engine);
1853 
1870  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectMonitorScriptWithWarnings)(AP_EngineManagement* engine, AP_MonitorScript* script);
1871 
1889  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectMonitorScriptWithWarningsFilename)(AP_EngineManagement* engine, AP_MonitorScript* script, const char *filename);
1890 
1906  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectJavaWithWarnings)(AP_EngineManagement* engine, const AP_uint8* jarbytes, AP_uint32 size);
1907 
1923  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectJavaWithWarningsFilename)(AP_EngineManagement* engine, const AP_uint8* jarbytes, AP_uint32 size, const char *filename);
1924 
1940  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectCDPWithWarnings)(AP_EngineManagement* engine, const AP_uint8* cdpbytes, AP_uint32 size);
1941 
1957  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectCDPWithWarningsFilename)(AP_EngineManagement* engine, const AP_uint8* cdpbytes, AP_uint32 size, const char *filename);
1958 
1967  void (AP_ENGINE_CLIENT_CALL* sendEventsNoBatching)(AP_EngineManagement* engine, AP_Event** events);
1968 
1980  void (AP_ENGINE_CLIENT_CALL* sendEvents)(AP_EngineManagement* engine, AP_Event** events);
1981 
1986  void (AP_ENGINE_CLIENT_CALL* flushEvents)(AP_EngineManagement* engine);
1987  };
1988 
1994  {
1995  void *reserved;
2000  };
2001 
2002  struct AP_EngineManagement_Stubs
2003  {
2004  struct AP_EngineManagement_API api;
2005 
2006 #ifdef __cplusplus
2007  void injectMonitorScript(AP_MonitorScript* script) {
2008  api.functions->injectMonitorScript(this, script);
2009  }
2010 
2011  void injectJava(const AP_uint8* jarbytes, AP_uint32 size) {
2012  api.functions->injectJava(this, jarbytes, size);
2013  }
2014 
2015  void injectCDP(const AP_uint8* cdpbytes, AP_uint32 size, const char* filename) {
2016  api.functions->injectCDP(this, cdpbytes, size, filename);
2017  }
2018 
2019  const AP_char8* const* injectMonitorScriptWithWarnings(AP_MonitorScript* script) {
2020  return api.functions->injectMonitorScriptWithWarnings(this, script);
2021  }
2022 
2023  const AP_char8* const* injectMonitorScriptWithWarningsFilename(AP_MonitorScript* script, const char *filename) {
2024  return api.functions->injectMonitorScriptWithWarningsFilename(this, script, filename);
2025  }
2026 
2027  const AP_char8* const* injectJavaWithWarnings(const AP_uint8* jarbytes, AP_uint32 size) {
2028  return api.functions->injectJavaWithWarnings(this, jarbytes, size);
2029  }
2030 
2031  const AP_char8* const* injectJavaWithWarningsFilename(const AP_uint8* jarbytes, AP_uint32 size, const char *filename) {
2032  return api.functions->injectJavaWithWarningsFilename(this, jarbytes, size, filename);
2033  }
2034 
2035  const AP_char8* const* injectCDPWithWarnings(const AP_uint8* cdpbytes, AP_uint32 size) {
2036  return api.functions->injectCDPWithWarnings(this, cdpbytes, size);
2037  }
2038 
2039  const AP_char8* const* injectCDPWithWarningsFilename(const AP_uint8* cdpbytes, AP_uint32 size, const char *filename) {
2040  return api.functions->injectCDPWithWarningsFilename(this, cdpbytes, size, filename);
2041  }
2042  void deleteName(const AP_char8* name) {
2043  api.functions->deleteName(this, name);
2044  }
2045 
2046  void forceDeleteName(const AP_char8* name) {
2047  api.functions->forceDeleteName(this, name);
2048  };
2049 
2050  void killName(const AP_char8* name) {
2051  api.functions->killName(this, name);
2052  }
2053 
2054  void deleteAll() {
2055  api.functions->deleteAll(this);
2056  }
2057 
2058  AP_EngineStatus* getStatus() {
2059  return api.functions->getStatus(this);
2060  }
2061 
2062  AP_EventSupplier* connectEventConsumer(AP_EventConsumer* consumer, const AP_char8* const* channels) {
2063  return api.functions->connectEventConsumer(this, consumer, channels);
2064  }
2065 
2066  AP_EventSupplier* connectDisconnectableEventConsumer(AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels) {
2067  return api.functions->connectDisconnectableEventConsumer(this, consumer, channels);
2068  }
2069 
2070  AP_EventSupplier* connectDisconnectableSlowEventConsumer(AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels, bool disconnectSlow) {
2071  return api.functions->connectDisconnectableSlowEventConsumer(this, consumer, channels, disconnectSlow);
2072  }
2073 
2074  AP_bool attachAsEventConsumerTo(AP_EngineManagement* target, const AP_char8* const* channels, AP_bool disconnectSlow, AP_EngineManagement_ConnectMode mode) {
2075  return api.functions->attachAsEventConsumerTo(this, target, channels, disconnectSlow, mode);
2076  }
2077 
2078  AP_bool attachAsEventConsumerToHost(const AP_char8* hostname, AP_uint16 port, const AP_char8* const* channels, AP_bool disconnectSlow, AP_EngineManagement_ConnectMode mode) {
2079  return api.functions->attachAsEventConsumerToHost(this, hostname, port, channels, disconnectSlow, mode);
2080  }
2081 
2082  void detachAsEventConsumerFrom(AP_EngineManagement* target, const AP_char8* const* channels, AP_EngineManagement_ConnectMode mode) {
2083  api.functions->detachAsEventConsumerFrom(this, target, channels, mode);
2084  }
2085 
2086  void detachAsEventConsumerFromHost(const AP_char8* hostname, AP_uint16 port, const AP_char8* const* channels, AP_EngineManagement_ConnectMode mode) {
2087  api.functions->detachAsEventConsumerFromHost(this, hostname, port, channels, mode);
2088  }
2089 
2090  AP_EngineInfo* inspectEngine() {
2091  return api.functions->inspectEngine(this);
2092  }
2093 
2094  void ping() {
2095  api.functions->ping(this);
2096  }
2097 
2098  AP_bool isConnected() {
2099  return api.functions->isConnected(this);
2100  }
2101 
2102  void sendEvents(AP_Event** events) {
2103  api.functions->sendEvents(this, events);
2104  }
2105  void sendEventsNoBatching(AP_Event** events) {
2106  api.functions->sendEventsNoBatching(this, events);
2107  }
2108  void flushEvents(AP_Event** events) {
2109  api.functions->flushEvents(this);
2110  }
2111 #endif /* __cplusplus */
2112  };
2113 
2114 
2115  /* Static functions from C++ API */
2116 
2124  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineInit(const char *processName);
2125 
2133  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineInitNoMessaging(const char *processName);
2134 
2141  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineShutdown();
2142 
2156  AP_ENGINE_CLIENT_API AP_EngineManagement* AP_ENGINE_CLIENT_CALL AP_ConnectToEngine(const AP_char8* hostname, AP_uint16 port);
2157 
2171  AP_ENGINE_CLIENT_API AP_EngineManagement* AP_ENGINE_CLIENT_CALL AP_connectToEngineReceiveOnly(const AP_char8* hostname, AP_uint16 port);
2172 
2185  AP_ENGINE_CLIENT_API AP_EngineManagement* AP_ENGINE_CLIENT_CALL AP_connectToEngineMonitorOnly(const AP_char8* hostname, AP_uint16 port);
2186 
2187  /* Move to a private header ? */
2188  AP_ENGINE_CLIENT_API AP_EngineStatus* AP_ENGINE_CLIENT_CALL engineManagement_getStatusOpaque(void *opaque_EngineManagement, char **errmsg);
2189 
2200  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DisconnectFromEngine(AP_EngineManagement* engine);
2201 
2209  AP_ENGINE_CLIENT_API AP_MonitorScript* AP_ENGINE_CLIENT_CALL AP_CreateMonitorScript(const AP_char8* text);
2210 
2217  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteMonitorScript(AP_MonitorScript* script);
2218 
2228  AP_ENGINE_CLIENT_API AP_Event* AP_ENGINE_CLIENT_CALL AP_CreateEvent(const AP_char8* text, const AP_char8* channel);
2229 
2236  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEvent(AP_Event* event);
2237 
2247  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEventSupplier(AP_EventSupplier* supplier);
2248 
2255  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEngineStatus(AP_EngineStatus* status);
2256 
2267  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEngineInfo(AP_EngineInfo* info);
2268 
2275  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteWarnings(const AP_char8* const* warnings);
2276 
2281  typedef enum {
2301 
2308  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogLevel(AP_EngineClientLogLevel level);
2309 
2320  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFile(const AP_char8* filename, int truncate);
2321 
2334  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFileUTF8(const AP_char8* filename, int truncate);
2335 
2342  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFD(int fd);
2343 
2349  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogMutex(void *);
2350 
2356  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_ReOpenLog();
2357 
2358  /* Convert a string in local encoding to UTF-8, as required by most of the Apama API */
2359  AP_ENGINE_CLIENT_API AP_char8* AP_ENGINE_CLIENT_CALL AP_ConvertToUTF8(const AP_char8* s);
2360 
2361  /* Convert a string in UTF-8 to the local encoding, since most of the Apama API returns UTF-8 */
2362  AP_ENGINE_CLIENT_API AP_char8* AP_ENGINE_CLIENT_CALL AP_ConvertFromUTF8(const AP_char8* s);
2363 
2364 
2365  /* Exception checking/handling functions -- these don't appear in the C++ API */
2366 
2367  typedef enum {
2371 
2378  AP_ENGINE_CLIENT_API AP_bool AP_ENGINE_CLIENT_CALL AP_CheckException();
2379 
2386  AP_ENGINE_CLIENT_API AP_EngineClientExceptionType AP_ENGINE_CLIENT_CALL AP_GetExceptionType();
2387 
2395  AP_ENGINE_CLIENT_API const AP_char8* AP_ENGINE_CLIENT_CALL AP_GetExceptionMessage();
2396 
2405  AP_ENGINE_CLIENT_API const AP_char8* const* AP_ENGINE_CLIENT_CALL AP_GetExceptionWarnings();
2406 
2412  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_ClearException();
2413 
2429  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetEngineParams(const AP_char8* params);
2430 
2438  AP_ENGINE_CLIENT_API int AP_ENGINE_CLIENT_CALL AP_IsOutOfBandEvent(const AP_char8* eventName);
2439 
2444  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_char8free(char *string);
2445 
2446 #ifdef __cplusplus
2447 } /* extern "C" */
2448 #endif /* __cplusplus */
2449 
2450 
2451 #endif /* ENGINE_CLIENT_C_H */
const AP_char8 *AP_ENGINE_CLIENT_CALL * getChannel(AP_Event *event)
Retrieve the event's channel.
AP_EventConsumer * s_EventConsumer
Pointer to this object with an EventConsumer facade.
Definition: engine_client_c.h:1999
AP_uint32(AP_ENGINE_CLIENT_CALL *getNumMonitors)(AP_EngineStatus *status)
Get the number of monitors defined in the Engine.
AP_ENGINE_CLIENT_API AP_bool AP_ENGINE_CLIENT_CALL AP_CheckException()
Checks if an exeption was thrown and saved by the library.
NamedMonitorInfo function API.
Definition: engine_client_c.h:973
AP_EngineStatus *AP_ENGINE_CLIENT_CALL * copyStatus(AP_EngineStatus *status)
Copy the supplied AP_EngineStatus (returned from a previous call to AP_EngineManagement->getStatus())...
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEvent(AP_Event *event)
This function allows deletion of an AP_Event instance.
AP_bool(AP_ENGINE_CLIENT_CALL *print)(AP_EngineStatus *status
Format the status into the given buffer.
AP_EngineClientExceptionType
Definition: engine_client_c.h:2367
NamedMonitorInfo facade for NamedInfo object.
Definition: engine_client_c.h:986
EngineStatus function API.
Definition: engine_client_c.h:489
const AP_char8 *AP_ENGINE_CLIENT_CALL * getSlowestReceiver(AP_EngineStatus *status)
Get the name of the slowest receiver.
NamedJavaApplicationInfo facade for NamedInfo object.
Definition: engine_client_c.h:1036
struct AP_NamedReceiverInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1304
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteWarnings(const AP_char8 *const *warnings)
This function allows deletion of warnings.
AP_NamedTimerInfo **AP_ENGINE_CLIENT_CALL * getTimers(AP_EngineInfo *info)
Returns information about the timers in the engine, in the form of a NULL terminated array of pointer...
Critical messages.
Definition: engine_client_c.h:2287
AP_NamedMonitorInfo **AP_ENGINE_CLIENT_CALL * getMonitors(AP_EngineInfo *info)
Returns information about the monitors in the engine, in the form of a NULL terminated array of point...
double(AP_ENGINE_CLIENT_CALL *getTime)(AP_Event *event)
Retrieve the event's timestamp.
EventConsumer.
Definition: engine_client_c.h:382
const AP_char8 *AP_ENGINE_CLIENT_CALL * getAddress(AP_NamedReceiverInfo *info)
Get the address of this receiver.
struct AP_NamedAggregateInfo_Stubs AP_NamedAggregateInfo
Information about an aggregate function returned by an engine inspection.
Definition: engine_client_c.h:180
struct AP_NamedJavaApplicationInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1040
struct AP_MonitorScript_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:470
struct AP_NameInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:946
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetEngineParams(const AP_char8 *params)
Set custom parameters for this instance of the client library.
void(AP_ENGINE_CLIENT_CALL *sendEvents)(AP_EventConsumer *consumer
This function must be defined by the client to enable receiving of events.
struct AP_NamedAggregateInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1247
const AP_char8 *AP_ENGINE_CLIENT_CALL * getMostBackedUpInput(AP_EngineStatus *status)
Get the name of the most backed up (slowest) context.
AP_ENGINE_CLIENT_API const AP_char8 *AP_ENGINE_CLIENT_CALL AP_GetExceptionMessage()
Retrieve the message enclosed within the exception.
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:1249
AP_uint32(AP_ENGINE_CLIENT_CALL *getNumSubMonitors)(AP_NamedContextInfo *info)
Gets the number of sub-monitors belonging to this context.
Event functions API.
Definition: engine_client_c.h:251
DisconnectableEventConsumer function API.
Definition: engine_client_c.h:404
struct AP_EngineStatus_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:778
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:1042
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_ClearException()
Clears the pending exception.
struct AP_NamedTimerInfo_Stubs AP_NamedTimerInfo
Information about a timer type returned by an engine inspection.
Definition: engine_client_c.h:165
const AP_char8 *const *AP_ENGINE_CLIENT_CALL * injectMonitorScriptWithWarningsFilename(AP_EngineManagement *engine, AP_MonitorScript *script, const char *filename)
Inject MonitorScript text into the Engine, supplying the filename it was injected from and returning ...
Fatal messages.
Definition: engine_client_c.h:2289
struct AP_EngineInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1528
void(AP_ENGINE_CLIENT_CALL *deleteStatus)(AP_EngineStatus *status)
Delete the supplied AP_EngineStatus (returned from a previous call to AP_EngineManagement->getStatus(...
NamedContextInfo facade for NamedInfo object.
Definition: engine_client_c.h:1197
Event supplier.
Definition: engine_client_c.h:339
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineInitNoMessaging(const char *processName)
This function (or engineInit) must be called once per process first before any other Engine operation...
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineShutdown()
This function must be called once per process before the application closes down. ...
AP_EventSupplier *AP_ENGINE_CLIENT_CALL * connectDisconnectableEventConsumer(AP_EngineManagement *engine, AP_DisconnectableEventConsumer *consumer, const AP_char8 *const *channels)
Connect a disconnectable event receiver to the Engine.
void(AP_ENGINE_CLIENT_CALL *disconnect)(AP_DisconnectableEventConsumer *consumer
Used to inform the consumer that it is not going to be sent any more events.
const AP_char8 *AP_ENGINE_CLIENT_CALL * getUserString(AP_EngineStatus *status, const char *key)
Get a user value of type AP_char8*.
struct AP_NamedEventTypeInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1090
const AP_char8 *AP_ENGINE_CLIENT_CALL * getFullyQualifiedName(AP_NameInfo *info)
Fully qualified name, for example "com.apamax.MyEvent".
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEngineInfo(AP_EngineInfo *info)
This function allows deletion of an AP_EngineInfo instance.
EngineManagement function API.
Definition: engine_client_c.h:1622
An exception in the client library.
Definition: engine_client_c.h:2369
struct AP_MonitorScript_Stubs AP_MonitorScript
A AP_MonitorScript allows MonitorScript code fragment, containing package, event and monitor definiti...
Definition: engine_client_c.h:122
struct AP_NamedContextInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1201
struct AP_NamedPluginReceiverInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1360
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogMutex(void *)
Sets the mutex which the client library logger should use.
const AP_char8 *AP_ENGINE_CLIENT_CALL * getName(AP_NameInfo *info)
Name, excluding package, for example "MyEvent".
struct AP_NameInfo_Stubs AP_NameInfo
Allows access to a named object (i.e.
Definition: engine_client_c.h:137
Allow parallel connections on multiple channels.
Definition: engine_client_c.h:1612
AP_uint32(AP_ENGINE_CLIENT_CALL *getNumTimers)(AP_NamedTimerInfo *info)
Gets the number of timers for this timer type.
AP_EventConsumer * s_EventConsumer
Pointer to EventConsumer facade for this object.
Definition: engine_client_c.h:427
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteMonitorScript(AP_MonitorScript *script)
This function allows deletion of AP_MonitorScript instances.
const AP_char8 *AP_ENGINE_CLIENT_CALL * getText(AP_Event *event)
Retrieve the event's type and its contents as a string.
NamedAggregateInfo function API.
Definition: engine_client_c.h:1234
EventSupplier function API.
Definition: engine_client_c.h:320
For backwards compatibility, single serial connection.
Definition: engine_client_c.h:1610
char const *const *AP_ENGINE_CLIENT_CALL * getChannels(AP_NamedContextInfo *info)
Gets the channels to which this context is subscribed.
AP_EventSupplier *AP_ENGINE_CLIENT_CALL * connectDisconnectableSlowEventConsumer(AP_EngineManagement *engine, AP_DisconnectableEventConsumer *consumer, const AP_char8 *const *channels, AP_bool disconnectIfSlow)
Connect a disconnectable event receiver to the Engine.
EngineStatus.
Definition: engine_client_c.h:774
AP_float64(AP_ENGINE_CLIENT_CALL *getUserFloat)(AP_EngineStatus *status
Get a user value of type AP_float64.
void(AP_ENGINE_CLIENT_CALL *injectMonitorScript)(AP_EngineManagement *engine
Inject MonitorScript text into the Engine.
const AP_char8 *AP_ENGINE_CLIENT_CALL * getText(AP_MonitorScript *script)
Retrieve the text of a MonitorScript fragment as a string.
EventConsumer function API.
Definition: engine_client_c.h:360
struct AP_EventConsumer_Stubs AP_EventConsumer
An AP_EventConsumer allows to connect to the Engine through an AP_EventSupplier and register to recei...
Definition: engine_client_c.h:99
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEngineStatus(AP_EngineStatus *status)
This function allows deletion of an AP_EngineStatus instance.
struct AP_NamedContextInfo_Stubs AP_NamedContextInfo
Information about a context returned by an engine inspection.
Definition: engine_client_c.h:172
AP_uint32(AP_ENGINE_CLIENT_CALL *getNumSubMonitors)(AP_NamedMonitorInfo *info)
Gets the number of sub-monitors belonging to this monitor.
struct AP_NamedReceiverInfo_Stubs AP_NamedReceiverInfo
Information about a receiver returned by an engine inspection.
Definition: engine_client_c.h:188
EngineInfo function API.
Definition: engine_client_c.h:1389
NamedPluginReceiverInfo function API.
Definition: engine_client_c.h:1337
AP_uint32(AP_ENGINE_CLIENT_CALL *getQueueSize)(AP_NamedPluginReceiverInfo *info)
Gets the queue size of this receiver.
const AP_char8 *AP_ENGINE_CLIENT_CALL * getPackage(AP_NameInfo *info)
Package name, for example "com.apamax", or an empty string if in the default package.
AP_ENGINE_CLIENT_API AP_Event *AP_ENGINE_CLIENT_CALL AP_CreateEvent(const AP_char8 *text, const AP_char8 *channel)
This function allows creation of an AP_Event instance.
struct AP_EventSupplier_Stubs AP_EventSupplier
An AP_EventSupplier represents the resources created by the Engine to service a connection to an exte...
Definition: engine_client_c.h:88
EngineManagement.
Definition: engine_client_c.h:1993
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DisconnectFromEngine(AP_EngineManagement *engine)
This function allows disconnection from an Engine.
NamedPluginReceiverInfo facade for NamedInfo object.
Definition: engine_client_c.h:1356
AP_uint32(AP_ENGINE_CLIENT_CALL *getNumListeners)(AP_NamedJavaApplicationInfo *info)
Gets the number of listeners belonging to this application.
struct AP_Event_Stubs AP_Event
An Event represents an event instance.
Definition: engine_client_c.h:76
MonitorScript function API.
Definition: engine_client_c.h:449
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEventSupplier(AP_EventSupplier *supplier)
This function disconnects and deletes an AP_EventSupplier instance.
struct AP_EngineInfo_Stubs AP_EngineInfo
Information about the monitors and types currently in an engine.
Definition: engine_client_c.h:212
NameInfo.
Definition: engine_client_c.h:942
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:1306
struct AP_NamedMonitorInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:990
const AP_char8 *const *AP_ENGINE_CLIENT_CALL * injectMonitorScriptWithWarnings(AP_EngineManagement *engine, AP_MonitorScript *script)
Inject MonitorScript text into the Engine, returning any warnings produced by the MonitorScript compi...
Monitorscript.
Definition: engine_client_c.h:466
Nothing logged.
Definition: engine_client_c.h:2283
struct AP_NamedTimerInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1140
AP_NamedContextInfo **AP_ENGINE_CLIENT_CALL * getContexts(AP_EngineInfo *info)
Returns information about the contexts in the engine, in the form of a NULL terminated array of point...
NamedAggregateInfo facade for NamedInfo object.
Definition: engine_client_c.h:1243
NamedJavaApplicationInfo function API.
Definition: engine_client_c.h:1023
AP_ENGINE_CLIENT_API AP_EngineManagement *AP_ENGINE_CLIENT_CALL AP_connectToEngineMonitorOnly(const AP_char8 *hostname, AP_uint16 port)
Attempt to establish a monitor-only connection to an Engine listening on the named host and port...
NamedReceiverInfo function API.
Definition: engine_client_c.h:1275
Information messages (default)
Definition: engine_client_c.h:2295
struct AP_DisconnectableEventConsumer_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:425
const AP_char8 *AP_ENGINE_CLIENT_CALL * getUserStringOr(AP_EngineStatus *status, const char *key, const AP_char8 *alt)
Get a user value of type AP_char8* or the alt value if it cannot be found.
AP_EngineStatus *AP_ENGINE_CLIENT_CALL * getStatus(AP_EngineManagement *engine)
Get the Engine's current operational status.
const AP_char8 *const *AP_ENGINE_CLIENT_CALL * injectJavaWithWarningsFilename(AP_EngineManagement *engine, const AP_uint8 *jarbytes, AP_uint32 size, const char *filename)
Injects a Java application (a jar) into the engine.
struct AP_NamedJavaApplicationInfo_Stubs AP_NamedJavaApplicationInfo
Information about a java application returned by an engine inspection.
Definition: engine_client_c.h:151
DisconnectableEventConsumer.
Definition: engine_client_c.h:421
void *AP_ENGINE_CLIENT_CALL * copyIterator(AP_EngineStatus *status, void *opaque_state)
Copy an opaque_state as returned by getNextStatusItem.
struct AP_EngineManagement_Stubs AP_EngineManagement
The AP_EngineManagement structure allows access to the Engine.
Definition: engine_client_c.h:224
AP_NamedEventTypeInfo **AP_ENGINE_CLIENT_CALL * getEventTypes(AP_EngineInfo *info)
Returns information about the event types in the engine, in the form of a NULL terminated array of po...
EngineInfo.
Definition: engine_client_c.h:1524
AP_uint64(AP_ENGINE_CLIENT_CALL *getUptime)(AP_EngineStatus *status)
Get the time in ms that the Engine has been running for.
More-verbose debug messages.
Definition: engine_client_c.h:2299
AP_uint32(AP_ENGINE_CLIENT_CALL *getNumEventTemplates)(AP_NamedEventTypeInfo *info)
Gets the number of event templates for this event type.
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogLevel(AP_EngineClientLogLevel level)
Sets the level at which the client library will log information.
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineInit(const char *processName)
This function must be called once per process first before any other Engine operations are carried ou...
AP_bool(AP_ENGINE_CLIENT_CALL *attachAsEventConsumerTo)(AP_EngineManagement *engine
Connect this Engine as an event receiver to another Engine.
struct AP_Event_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:293
Debugging messages.
Definition: engine_client_c.h:2297
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFD(int fd)
Sets the file descriptor to which the client library should log information.
AP_int64(AP_ENGINE_CLIENT_CALL *getUserInt)(AP_EngineStatus *status
Get a user value of type AP_int64.
AP_EngineClientLogLevel
Available logging levels.
Definition: engine_client_c.h:2281
AP_NamedJavaApplicationInfo **AP_ENGINE_CLIENT_CALL * getJavaApplications(AP_EngineInfo *info)
Returns information about the Java applications in the engine, in the form of a NULL terminated array...
struct AP_EngineStatus_Stubs AP_EngineStatus
AP_EngineStatus allows access to the operational status of the Engine.
Definition: engine_client_c.h:128
struct AP_EventConsumer_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:386
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFile(const AP_char8 *filename, int truncate)
Sets the file to which the client library should log information.
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_char8free(char *string)
Free any char* string returned from the client API.
NamedEventTypeInfo facade for NamedInfo object.
Definition: engine_client_c.h:1086
const AP_char8 *const *AP_ENGINE_CLIENT_CALL * injectJavaWithWarnings(AP_EngineManagement *engine, const AP_uint8 *jarbytes, AP_uint32 size)
Injects a Java application (a jar) into the engine; maintained for compatibility only, please use injectJavaWithWarningsFilename instead of this function.
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:1362
void(AP_ENGINE_CLIENT_CALL *disconnect)(AP_EventSupplier *supplier)
Disconnect the EventSupplier from its consumer.
const AP_char8 *const *AP_ENGINE_CLIENT_CALL * injectCDPWithWarnings(AP_EngineManagement *engine, const AP_uint8 *cdpbytes, AP_uint32 size)
Injects a CDP (Correlator Deployment Package file) into the engine; maintained for compatibility only...
struct AP_EventSupplier_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:343
NamedReceiverInfo facade for NamedInfo object.
Definition: engine_client_c.h:1300
AP_NamedPluginReceiverInfo **AP_ENGINE_CLIENT_CALL * getPluginReceivers(AP_EngineInfo *info)
Returns information about the plugin receivers in the engine, in the form of a NULL terminated array ...
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:992
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:1092
AP_ENGINE_CLIENT_API AP_MonitorScript *AP_ENGINE_CLIENT_CALL AP_CreateMonitorScript(const AP_char8 *text)
This function allows creation of AP_MonitorScript instances.
AP_EngineManagement_ConnectMode
The mode that attachAsEventConsumerTo and detachAsEventConsumerFrom operate in.
Definition: engine_client_c.h:1608
AP_ENGINE_CLIENT_API AP_EngineManagement *AP_ENGINE_CLIENT_CALL AP_connectToEngineReceiveOnly(const AP_char8 *hostname, AP_uint16 port)
Attempt to establish a receive-only connection to an Engine listening on the named host and port...
AP_NamedReceiverInfo **AP_ENGINE_CLIENT_CALL * getReceivers(AP_EngineInfo *info)
Returns information about the receivers connected to the engine, in the form of a NULL terminated arr...
struct AP_EngineManagement_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1997
AP_ENGINE_CLIENT_API AP_EngineManagement *AP_ENGINE_CLIENT_CALL AP_ConnectToEngine(const AP_char8 *hostname, AP_uint16 port)
This function attempts to establish a connection to an Engine.
AP_uint32(AP_ENGINE_CLIENT_CALL *getNumMonitors)(AP_EngineInfo *info)
Gets the number of monitors in the engine.
Event.
Definition: engine_client_c.h:289
char const *const *AP_ENGINE_CLIENT_CALL * getChannels(AP_NamedReceiverInfo *info)
Gets the channels to which this context is subscribed.
struct AP_NamedMonitorInfo_Stubs AP_NamedMonitorInfo
Information about a monitor returned by an engine inspection.
Definition: engine_client_c.h:144
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFileUTF8(const AP_char8 *filename, int truncate)
Sets the file to which the client library should log information.
AP_NamedAggregateInfo **AP_ENGINE_CLIENT_CALL * getAggregates(AP_EngineInfo *info)
Returns information about the aggregate functions in the engine, in the form of a NULL terminated arr...
NamedTimerInfoInfo facade for NamedInfo object.
Definition: engine_client_c.h:1136
struct AP_NamedEventTypeInfo_Stubs AP_NamedEventTypeInfo
Information about a event type returned by an engine inspection.
Definition: engine_client_c.h:158
AP_EventSupplier *AP_ENGINE_CLIENT_CALL * connectEventConsumer(AP_EngineManagement *engine, AP_EventConsumer *consumer, const AP_char8 *const *channels)
Connect an event receiver to the Engine.
AP_EngineInfo *AP_ENGINE_CLIENT_CALL * inspectEngine(AP_EngineManagement *engine)
Returns information about the monitors, event types and container types which exist in the engine...
Error messages.
Definition: engine_client_c.h:2291
const AP_char8 *AP_ENGINE_CLIENT_CALL * getStatusValue(AP_EngineStatus *status, const char *key)
Get the status value with the specified key.
AP_ENGINE_CLIENT_API const AP_char8 *const *AP_ENGINE_CLIENT_CALL AP_GetExceptionWarnings()
Retrieve the set of warnings associated with the exception.
struct AP_DisconnectableEventConsumer_Stubs AP_DisconnectableEventConsumer
An AP_DisconnectableEventConsumer allows to connect to the Engine through an AP_EventSupplier and reg...
Definition: engine_client_c.h:114
AP_uint32(AP_ENGINE_CLIENT_CALL *getQueueSize)(AP_NamedReceiverInfo *info)
Gets the queue size of this receiver.
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:1142
NameInfo function API.
Definition: engine_client_c.h:916
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:1203
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_ReOpenLog()
Re-opens the log file.
char const *const *AP_ENGINE_CLIENT_CALL * getChannels(AP_NamedPluginReceiverInfo *info)
Gets the channels to which this context is subscribed.
AP_ENGINE_CLIENT_API AP_EngineClientExceptionType AP_ENGINE_CLIENT_CALL AP_GetExceptionType()
Returns the type of the pending exception.
Warning messages.
Definition: engine_client_c.h:2293
const AP_char8 *const *AP_ENGINE_CLIENT_CALL * injectCDPWithWarningsFilename(AP_EngineManagement *engine, const AP_uint8 *cdpbytes, AP_uint32 size, const char *filename)
Injects a CDP (Correlator Deployment Package file) into the engine.
NamedEventTypeInfo function API.
Definition: engine_client_c.h:1073
Startup and other important messages.
Definition: engine_client_c.h:2285
struct AP_NamedPluginReceiverInfo_Stubs AP_NamedPluginReceiverInfo
Information about a plugin receiver returned by an engine inspection.
Definition: engine_client_c.h:196
NamedContextInfo function API.
Definition: engine_client_c.h:1173
NamedTimerInfoInfo function API.
Definition: engine_client_c.h:1123