Apama  9.10.0.4.289795
 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 288963 2016-08-10 18:59:18Z dfo $
9  */
10 
16 #ifndef ENGINE_CLIENT_C_H
17 #define ENGINE_CLIENT_C_H
18 
19 
20 #include <AP_Types.h>
21 #include <AP_Platform.h>
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif /* __cplusplus */
26 
27 
28  struct AP_Event_API;
29  struct AP_EventSupplier_API;
30  struct AP_EventConsumer_API;
32  struct AP_MonitorScript_API;
33  struct AP_EngineStatus_API;
34  struct AP_NameInfo_API;
38  struct AP_NamedTimerInfo_API;
43  struct AP_EngineInfo_API;
45 
46 #ifdef __cplusplus
47  struct AP_Event_Stubs;
48  struct AP_EventSupplier_Stubs;
49  struct AP_EventConsumer_Stubs;
50  struct AP_DisconnectableEventConsumer_Stubs;
51  struct AP_MonitorScript_Stubs;
52  struct AP_EngineStatus_Stubs;
53  struct AP_NameInfo_Stubs;
54  struct AP_NamedMonitorInfo_Stubs;
55  struct AP_NamedJavaApplicationInfo_Stubs;
56  struct AP_NamedEventTypeInfo_Stubs;
57  struct AP_NamedTimerInfo_Stubs;
58  struct AP_NamedContextInfo_Stubs;
59  struct AP_NamedAggregateInfo_Stubs;
60  struct AP_NamedReceiverInfo_Stubs;
61  struct AP_NamedPluginReceiverInfo_Stubs;
62  struct AP_EngineInfo_Stubs;
63  struct AP_EngineManagement_Stubs;
64 
68  typedef struct AP_Event_Stubs AP_Event;
69 
79  typedef struct AP_EventSupplier_Stubs AP_EventSupplier;
80 
89  typedef struct AP_EventConsumer_Stubs AP_EventConsumer;
90 
103  typedef struct AP_DisconnectableEventConsumer_Stubs AP_DisconnectableEventConsumer;
104 
110  typedef struct AP_MonitorScript_Stubs AP_MonitorScript;
111 
115  typedef struct AP_EngineStatus_Stubs AP_EngineStatus;
116 
123  typedef struct AP_NameInfo_Stubs AP_NameInfo;
124 
129  typedef struct AP_NamedMonitorInfo_Stubs AP_NamedMonitorInfo;
130 
135  typedef struct AP_NamedJavaApplicationInfo_Stubs AP_NamedJavaApplicationInfo;
136 
141  typedef struct AP_NamedEventTypeInfo_Stubs AP_NamedEventTypeInfo;
142 
147  typedef struct AP_NamedTimerInfo_Stubs AP_NamedTimerInfo;
148 
153  typedef struct AP_NamedContextInfo_Stubs AP_NamedContextInfo;
154 
160  typedef struct AP_NamedAggregateInfo_Stubs AP_NamedAggregateInfo;
161 
167  typedef struct AP_NamedReceiverInfo_Stubs AP_NamedReceiverInfo;
168 
174  typedef struct AP_NamedPluginReceiverInfo_Stubs AP_NamedPluginReceiverInfo;
175 
189  typedef struct AP_EngineInfo_Stubs AP_EngineInfo;
190 
200  typedef struct AP_EngineManagement_Stubs AP_EngineManagement;
201 
202 #else
203  typedef struct AP_Event_API AP_Event;
204  typedef struct AP_EventSupplier_API AP_EventSupplier;
205  typedef struct AP_EventConsumer_API AP_EventConsumer;
207  typedef struct AP_MonitorScript_API AP_MonitorScript;
208  typedef struct AP_EngineStatus_API AP_EngineStatus;
209  typedef struct AP_NameInfo_API AP_NameInfo;
218  typedef struct AP_EngineInfo_API AP_EngineInfo;
220 #endif /* __cplusplus */
221 
222 
227  {
234  const AP_char8* (AP_ENGINE_CLIENT_CALL* getText)(AP_Event* event);
243  const AP_char8* (AP_ENGINE_CLIENT_CALL* getChannel)(AP_Event* event);
254  double (AP_ENGINE_CLIENT_CALL* getTime)(AP_Event* event);
255  };
256 
261  {
262  void* reserved;
265  };
266 
267  struct AP_Event_Stubs
268  {
269  struct AP_Event_API api;
270 
271 #ifdef __cplusplus
272  const AP_char8* getText() {
273  return api.functions->getText(this);
274  }
275 
276  const AP_char8* getChannel() {
277  return api.functions->getChannel(this);
278  }
279 
280  double getTime() {
281  return api.functions->getTime(this);
282  }
283 #endif /* __cplusplus */
284  };
285 
286 
291  {
301  void (AP_ENGINE_CLIENT_CALL* disconnect)(AP_EventSupplier* supplier);
302  };
303 
308  {
309  void* reserved;
312  };
313 
314  struct AP_EventSupplier_Stubs {
315  struct AP_EventSupplier_API api;
316 
317 #ifdef __cplusplus
318  void disconnect() {
319  api.functions->disconnect(this);
320  }
321 #endif /*__cplusplus */
322  };
323 
328  {
341  void (AP_ENGINE_CLIENT_CALL* sendEvents)(AP_EventConsumer* consumer, AP_Event** events);
342  };
343 
348  {
349  void* reserved;
352  };
353 
354  struct AP_EventConsumer_Stubs
355  {
356  struct AP_EventConsumer_API api;
357 
358 #ifdef __cplusplus
359  void sendEvents(AP_Event** events) {
360  api.functions->sendEvents(this, events);
361  }
362 #endif /* __cplusplus */
363  };
364 
369  {
377  void (AP_ENGINE_CLIENT_CALL* disconnect)(AP_DisconnectableEventConsumer* consumer, const AP_char8* reason);
378  };
379 
384  {
385  void *reserved;
390  };
391 
392  struct AP_DisconnectableEventConsumer_Stubs
393  {
395 
396 #ifdef __cplusplus
397  void disconnect(const AP_char8* reason) {
398  api.functions->disconnect(this, reason);
399  }
400 
401  void sendEvents(AP_Event** events) {
402  api.s_EventConsumer->api.functions->sendEvents(api.s_EventConsumer, events);
403  }
404 #endif /* __cplusplus */
405  };
406 
411  {
419  const AP_char8* (AP_ENGINE_CLIENT_CALL* getText)(AP_MonitorScript* script);
420  };
421 
426  {
427  void* reserved;
430  };
431 
432  struct AP_MonitorScript_Stubs
433  {
434  struct AP_MonitorScript_API api;
435 
436 #ifdef __cplusplus
437  const AP_char8* getText() {
438  return api.functions->getText(this);
439  };
440 #endif /*__cplusplus */
441  };
442 
443 
448  {
452  AP_bool (AP_ENGINE_CLIENT_CALL* print)(AP_EngineStatus* status, AP_char8* buf, AP_uint32 size);
453 
458  AP_uint64 (AP_ENGINE_CLIENT_CALL* getUptime)(AP_EngineStatus* status);
459 
463  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumMonitors)(AP_EngineStatus* status);
464 
470  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumProcesses)(AP_EngineStatus* status);
471 
475  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumListeners)(AP_EngineStatus* status);
476 
480  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumEventTypes)(AP_EngineStatus* status);
481 
486  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumQueuedFastTrack)(AP_EngineStatus* status);
487 
492  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumQueuedInput)(AP_EngineStatus* status);
493 
499  AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumReceived)(AP_EngineStatus* status);
500 
505  AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumFastTracked)(AP_EngineStatus* status);
506 
511  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumConsumers)(AP_EngineStatus* status);
512 
516  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumOutputEventsQueued)(AP_EngineStatus* status);
517 
523  AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumOutputEventsCreated)(AP_EngineStatus* status);
524 
531  AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumOutputEventsSent)(AP_EngineStatus* status);
532 
536  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumJavaApplications)(AP_EngineStatus* status);
537 
542  AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumProcessed)(AP_EngineStatus* status);
543 
547  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumSubListeners)(AP_EngineStatus* status);
548 
552  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumContexts)(AP_EngineStatus* status);
553 
557  const AP_char8* (AP_ENGINE_CLIENT_CALL* getMostBackedUpInput)(AP_EngineStatus* status);
558 
562  AP_uint32 (AP_ENGINE_CLIENT_CALL* getMostBackedUpQueueSize)(AP_EngineStatus* status);
563 
567  const AP_char8* (AP_ENGINE_CLIENT_CALL* getSlowestReceiver)(AP_EngineStatus* status);
568 
572  AP_uint32 (AP_ENGINE_CLIENT_CALL* getSlowestReceiverQueueSize)(AP_EngineStatus* status);
573 
597  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNextStatusItem)(AP_EngineStatus* status, const char **name, const char **value, void **opaque_state);
598 
602  const AP_char8* (AP_ENGINE_CLIENT_CALL* getStatusValue)(AP_EngineStatus* status, const char *key);
603 
607  AP_uint64 (AP_ENGINE_CLIENT_CALL* getStatusIntValue)(AP_EngineStatus* status, const char *key);
608 
612  void (AP_ENGINE_CLIENT_CALL* deleteStatus)(AP_EngineStatus *status);
613 
617  AP_EngineStatus *(AP_ENGINE_CLIENT_CALL* copyStatus)(AP_EngineStatus *status);
618 
622  void *(AP_ENGINE_CLIENT_CALL* copyIterator)(AP_EngineStatus* status, void *opaque_state);
623 
627  void (AP_ENGINE_CLIENT_CALL* disposeIterator)(AP_EngineStatus* status, void *opaque_state);
628 
635  AP_int64 (AP_ENGINE_CLIENT_CALL* getUserInt)(AP_EngineStatus* status, const char* key);
636 
643  AP_int64 (AP_ENGINE_CLIENT_CALL* getUserIntOr)(AP_EngineStatus* status, const char* key, AP_int64 alt);
644 
651  AP_float64(AP_ENGINE_CLIENT_CALL* getUserFloat)(AP_EngineStatus* status, const char* key);
658  AP_float64(AP_ENGINE_CLIENT_CALL* getUserFloatOr)(AP_EngineStatus* status, const char* key, AP_float64 alt);
659 
666  AP_bool(AP_ENGINE_CLIENT_CALL* getUserBool)(AP_EngineStatus* status, const char* key);
667 
674  AP_bool(AP_ENGINE_CLIENT_CALL* getUserBoolOr)(AP_EngineStatus* status, const char* key, AP_bool alt);
675 
682  const AP_char8*(AP_ENGINE_CLIENT_CALL* getUserString)(AP_EngineStatus* status, const char* key);
683 
690  const AP_char8*(AP_ENGINE_CLIENT_CALL* getUserStringOr)(AP_EngineStatus* status, const char* key, const AP_char8* alt);
691  };
692 
697  {
698  void* reserved;
701  };
702 
703  struct AP_EngineStatus_Stubs
704  {
705  struct AP_EngineStatus_API api;
706 
707 #ifdef __cplusplus
708  AP_bool print(AP_char8* buf, AP_uint32 size) {
709  return api.functions->print(this,buf,size);
710  }
711 
712  AP_uint64 getUptime() {
713  return api.functions->getUptime(this);
714  }
715 
716  AP_uint32 getNumMonitors() {
717  return api.functions->getNumMonitors(this);
718  }
719 
720  AP_uint32 getNumProcesses() {
721  return api.functions->getNumProcesses(this);
722  }
723 
724  AP_uint32 getNumJavaApplications() {
725  return api.functions->getNumJavaApplications(this);
726  }
727 
728  AP_uint32 getNumListeners() {
729  return api.functions->getNumListeners(this);
730  }
731 
732  AP_uint32 getNumEventTypes() {
733  return api.functions->getNumEventTypes(this);
734  }
735 
736  AP_uint32 getNumQueuedFastTrack() {
737  return api.functions->getNumQueuedFastTrack(this);
738  }
739 
740  AP_uint32 getNumQueuedInput() {
741  return api.functions->getNumQueuedInput(this);
742  }
743 
744  AP_uint64 getNumReceived() {
745  return api.functions->getNumReceived(this);
746  }
747 
748  AP_uint64 getNumFastTracked() {
749  return api.functions->getNumFastTracked(this);
750  }
751 
752  AP_uint32 getNumConsumers() {
753  return api.functions->getNumConsumers(this);
754  }
755 
756  AP_uint32 getNumOutputEventsQueued() {
757  return api.functions->getNumOutputEventsQueued(this);
758  }
759 
760  AP_uint64 getNumOutputEventsCreated() {
761  return api.functions->getNumOutputEventsCreated(this);
762  }
763 
764  AP_uint64 getNumOutputEventsSent() {
765  return api.functions->getNumOutputEventsSent(this);
766  }
767 
768  AP_uint64 getNumProcessed() {
769  return api.functions->getNumProcessed(this);
770  }
771 
772  AP_uint32 getNumSubListeners() {
773  return api.functions->getNumSubListeners(this);
774  }
775 
776  AP_uint32 getNumContexts() {
777  return api.functions->getNumContexts(this);
778  }
779 
780  AP_uint32 getNextStatusItem(const char **name, const char **value, void **opaque_state) {
781  return api.functions->getNextStatusItem(this, name, value, opaque_state);
782  }
783 
784  AP_int64 getUserInt(const char* key) {
785  return api.functions->getUserInt(this, key);
786  }
787  AP_int64 getUserIntOr(const char* key, AP_int64 alt) {
788  return api.functions->getUserIntOr(this, key, alt);
789  }
790 
791  AP_float64 getUserFloat(const char* key) {
792  return api.functions->getUserFloat(this, key);
793  }
794  AP_float64 getUserFloatOr(const char* key, AP_float64 alt) {
795  return api.functions->getUserFloatOr(this, key, alt);
796  }
797 
798  AP_bool getUserBool(AP_EngineStatus* status, const char* key) {
799  return api.functions->getUserBool(this, key);
800  }
801  AP_bool getUserBoolOr(AP_EngineStatus* status, const char* key, AP_bool alt) {
802  return api.functions->getUserBoolOr(this, key, alt);
803  }
804 
805  const AP_char8* getUserString(AP_EngineStatus* status, const char* key) {
806  return api.functions->getUserString(this, key);
807  }
808  const AP_char8* getUserStringOr(AP_EngineStatus* status, const char* key, const AP_char8* alt) {
809  return api.functions->getUserStringOr(this, key, alt);
810  }
811 
812  void disposeIterator(void *opaque_state) {
813  api.functions->disposeIterator(this, opaque_state);
814  }
815  const AP_char8* getMostBackedUpInput() {
816  return api.functions->getMostBackedUpInput(this);
817  }
818  AP_uint32 getMostBackedUpQueueSize() {
819  return api.functions->getMostBackedUpQueueSize(this);
820  }
821 
822  const AP_char8* getSlowestReceiver() {
823  return api.functions->getSlowestReceiver(this);
824  }
825 
826  AP_uint32 getSlowestReceiverQueueSize() {
827  return api.functions->getSlowestReceiverQueueSize(this);
828  }
829 
830 
831 #endif /*__cplusplus */
832  };
833 
838  {
842  const AP_char8* (AP_ENGINE_CLIENT_CALL* getName)(AP_NameInfo* info);
843 
848  const AP_char8* (AP_ENGINE_CLIENT_CALL* getPackage)(AP_NameInfo* info);
849 
853  const AP_char8* (AP_ENGINE_CLIENT_CALL* getFullyQualifiedName)(AP_NameInfo* info);
854  };
855 
860  {
861  void* reserved;
864  };
865 
866  struct AP_NameInfo_Stubs
867  {
868  struct AP_NameInfo_API api;
869 
870 #ifdef __cplusplus
871  const AP_char8* getName() {
872  return api.functions->getName(this);
873  }
874 
875  const AP_char8* getPackage() {
876  return api.functions->getPackage(this);
877  }
878 
879  const AP_char8* getFullyQualifiedName() {
880  return api.functions->getFullyQualifiedName(this);
881  }
882 #endif /*__cplusplus */
883  };
884 
885 
890  {
894  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumSubMonitors)(AP_NamedMonitorInfo* info);
895  };
896 
901  {
902  void* reserved;
907  };
908 
909  struct AP_NamedMonitorInfo_Stubs
910  {
911  struct AP_NamedMonitorInfo_API api;
912 
913 #ifdef __cplusplus
914  AP_uint32 getNumSubMonitors() {
915  return api.functions->getNumSubMonitors(this);
916  }
917 
918  const AP_char8* getName() {
919  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
920  }
921 
922  const AP_char8* getPackage() {
923  return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
924  }
925 
926  const AP_char8* getFullyQualifiedName() {
928  }
929 #endif /*__cplusplus */
930  };
931 
932 
937  {
941  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumListeners)(AP_NamedJavaApplicationInfo* info);
942  };
943 
948  {
949  void* reserved;
954  };
955 
956  struct AP_NamedJavaApplicationInfo_Stubs
957  {
959 
960 #ifdef __cplusplus
961  AP_uint32 getNumListeners() {
962  return api.functions->getNumListeners(this);
963  }
964 
965  const AP_char8* getName() {
966  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
967  }
968 
969  const AP_char8* getPackage() {
970  return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
971  }
972 
973  const AP_char8* getFullyQualifiedName() {
975  }
976 #endif /*__cplusplus */
977  };
978 
979 
984  {
988  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumEventTemplates)(AP_NamedEventTypeInfo* info);
989  };
990 
995  {
996  void* reserved;
1001  };
1002 
1003  struct AP_NamedEventTypeInfo_Stubs
1004  {
1005  struct AP_NamedEventTypeInfo_API api;
1006 
1007 #ifdef __cplusplus
1008  AP_uint32 getNumEventTemplates() {
1009  return api.functions->getNumEventTemplates(this);
1010  }
1011 
1012  const AP_char8* getName() {
1013  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1014  }
1015 
1016  const AP_char8* getPackage() {
1017  return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
1018  }
1019 
1020  const AP_char8* getFullyQualifiedName() {
1021  return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
1022  }
1023 #endif /*__cplusplus */
1024  };
1025 
1026 
1031  {
1035  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumTimers)(AP_NamedTimerInfo* info);
1036  };
1037 
1042  {
1043  void* reserved;
1048  };
1049 
1050  struct AP_NamedTimerInfo_Stubs
1051  {
1052  struct AP_NamedTimerInfo_API api;
1053 
1054 #ifdef __cplusplus
1055  AP_uint32 getNumTimers() {
1056  return api.functions->getNumTimers(this);
1057  }
1058 
1059  const AP_char8* getName() {
1060  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1061  }
1062 
1063  const AP_char8* getPackage() {
1064  return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
1065  }
1066 
1067  const AP_char8* getFullyQualifiedName() {
1068  return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
1069  }
1070 #endif /*__cplusplus */
1071  };
1072 
1073 
1081  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumSubMonitors)(AP_NamedContextInfo* info);
1082 
1086  AP_uint32 (AP_ENGINE_CLIENT_CALL* getQueueSize)(AP_NamedContextInfo* info);
1087 
1091  char const *const *(AP_ENGINE_CLIENT_CALL *getChannels)(AP_NamedContextInfo *info);
1092  };
1093 
1098  {
1099  void* reserved;
1104  };
1105 
1106  struct AP_NamedContextInfo_Stubs
1107  {
1108  struct AP_NamedContextInfo_API api;
1109 
1110 #ifdef __cplusplus
1111  const AP_char8* getName() {
1112  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1113  }
1114 
1115  AP_uint32 getNumSubMonitors() {
1116  return api.functions->getNumSubMonitors(this);
1117  }
1118 
1119  AP_uint32 getQueueSize() {
1120  return api.functions->getQueueSize(this);
1121  }
1122 
1123  char const *const *getChannels() {
1124  return api.functions->getChannels(this);
1125  }
1126 
1127 #endif /*__cplusplus */
1128  };
1129 
1134  {
1135  void** placeholder;
1136  };
1137 
1142  {
1143  void* reserved;
1148  };
1149 
1150  struct AP_NamedAggregateInfo_Stubs
1151  {
1152  struct AP_NamedAggregateInfo_API api;
1153 
1154 #ifdef __cplusplus
1155  const AP_char8* getName() {
1156  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1157  }
1158 
1159  const AP_char8* getPackage() {
1160  return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
1161  }
1162 
1163  const AP_char8* getFullyQualifiedName() {
1164  return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
1165  }
1166 #endif /*__cplusplus */
1167  };
1168 
1173  {
1177  AP_uint32 (AP_ENGINE_CLIENT_CALL* getQueueSize)(AP_NamedReceiverInfo* info);
1178 
1182  char const *const *(AP_ENGINE_CLIENT_CALL *getChannels)(AP_NamedReceiverInfo *info);
1183 
1187  const AP_char8 *(AP_ENGINE_CLIENT_CALL *getAddress)(AP_NamedReceiverInfo *info);
1188  };
1189 
1194  {
1195  void* reserved;
1200  };
1201 
1202  struct AP_NamedReceiverInfo_Stubs
1203  {
1204  struct AP_NamedReceiverInfo_API api;
1205 
1206 #ifdef __cplusplus
1207  const AP_char8 *getName() {
1208  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1209  }
1210 
1211  const AP_char8 *getAddress() {
1212  return api.functions->getAddress(this);
1213  }
1214 
1215  AP_uint32 getQueueSize() {
1216  return api.functions->getQueueSize(this);
1217  }
1218 
1219  char const *const *getChannels() {
1220  return api.functions->getChannels(this);
1221  }
1222 
1223 #endif /*__cplusplus */
1224  };
1225 
1230  {
1234  AP_uint32 (AP_ENGINE_CLIENT_CALL* getQueueSize)(AP_NamedPluginReceiverInfo* info);
1235 
1239  char const *const *(AP_ENGINE_CLIENT_CALL *getChannels)(AP_NamedPluginReceiverInfo *info);
1240  };
1241 
1246  {
1247  void* reserved;
1252  };
1253 
1254  struct AP_NamedPluginReceiverInfo_Stubs
1255  {
1256  struct AP_NamedPluginReceiverInfo_API api;
1257 
1258 #ifdef __cplusplus
1259  const AP_char8 *getName() {
1260  return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
1261  }
1262 
1263  AP_uint32 getQueueSize() {
1264  return api.functions->getQueueSize(this);
1265  }
1266 
1267  char const *const *getChannels() {
1268  return api.functions->getChannels(this);
1269  }
1270 
1271 #endif /*__cplusplus */
1272  };
1273 
1278  {
1282  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumMonitors)(AP_EngineInfo* info);
1283 
1287  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumEventTypes)(AP_EngineInfo* info);
1288 
1292  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumTimers)(AP_EngineInfo* info);
1293 
1301  AP_NamedMonitorInfo** (AP_ENGINE_CLIENT_CALL* getMonitors)(AP_EngineInfo* info);
1302 
1310  AP_NamedEventTypeInfo** (AP_ENGINE_CLIENT_CALL* getEventTypes)(AP_EngineInfo* info);
1311 
1319  AP_NamedTimerInfo** (AP_ENGINE_CLIENT_CALL* getTimers)(AP_EngineInfo* info);
1320 
1324  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumJavaApplications)(AP_EngineInfo* info);
1325 
1333  AP_NamedJavaApplicationInfo** (AP_ENGINE_CLIENT_CALL* getJavaApplications)(AP_EngineInfo* info);
1334 
1338  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumContexts)(AP_EngineInfo* info);
1339 
1347  AP_NamedContextInfo** (AP_ENGINE_CLIENT_CALL* getContexts)(AP_EngineInfo* info);
1348 
1352  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumAggregates)(AP_EngineInfo* info);
1353 
1361  AP_NamedAggregateInfo** (AP_ENGINE_CLIENT_CALL* getAggregates)(AP_EngineInfo* info);
1362 
1366  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumReceivers)(AP_EngineInfo* info);
1367 
1375  AP_NamedReceiverInfo** (AP_ENGINE_CLIENT_CALL* getReceivers)(AP_EngineInfo* info);
1376 
1380  AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumPluginReceivers)(AP_EngineInfo* info);
1381 
1389  AP_NamedPluginReceiverInfo** (AP_ENGINE_CLIENT_CALL* getPluginReceivers)(AP_EngineInfo* info);
1390  };
1391 
1396  {
1397  void* reserved;
1400  };
1401 
1402  struct AP_EngineInfo_Stubs
1403  {
1404  struct AP_EngineInfo_API api;
1405 
1406 #ifdef __cplusplus
1407  AP_uint32 getNumMonitors() {
1408  return api.functions->getNumMonitors(this);
1409  }
1410 
1411  AP_uint32 getNumEventTypes() {
1412  return api.functions->getNumEventTypes(this);
1413  }
1414 
1415  AP_uint32 getNumTimers() {
1416  return api.functions->getNumTimers(this);
1417  }
1418 
1419  AP_NamedMonitorInfo** getMonitors() {
1420  return api.functions->getMonitors(this);
1421  }
1422 
1423  AP_NamedEventTypeInfo** getEventTypes() {
1424  return api.functions->getEventTypes(this);
1425  }
1426 
1427  AP_NamedTimerInfo** getTimers() {
1428  return api.functions->getTimers(this);
1429  }
1430 
1431  AP_uint32 getNumJavaApplications() {
1432  return api.functions->getNumJavaApplications(this);
1433  }
1434 
1435  AP_NamedJavaApplicationInfo** getJavaApplications() {
1436  return api.functions->getJavaApplications(this);
1437  }
1438 
1439  AP_uint32 getNumContexts() {
1440  return api.functions->getNumContexts(this);
1441  }
1442 
1443  AP_NamedContextInfo** getContexts() {
1444  return api.functions->getContexts(this);
1445  }
1446 
1447  AP_uint32 getNumAggregates() {
1448  return api.functions->getNumAggregates(this);
1449  }
1450 
1451  AP_NamedAggregateInfo** getAggregates() {
1452  return api.functions->getAggregates(this);
1453  }
1454 
1455  AP_uint32 getNumReceivers() {
1456  return api.functions->getNumReceivers(this);
1457  }
1458 
1459  AP_NamedReceiverInfo** getReceivers() {
1460  return api.functions->getReceivers(this);
1461  }
1462 
1463  AP_uint32 getNumPluginReceivers() {
1464  return api.functions->getNumPluginReceivers(this);
1465  }
1466 
1467  AP_NamedPluginReceiverInfo** getPluginReceivers() {
1468  return api.functions->getPluginReceivers(this);
1469  }
1470 
1471 #endif /*__cplusplus */
1472  };
1473 
1474 
1479  };
1480 
1482 
1483 
1488  {
1495  void (AP_ENGINE_CLIENT_CALL* injectMonitorScript)(AP_EngineManagement* engine, AP_MonitorScript* script);
1496 
1505  void (AP_ENGINE_CLIENT_CALL* injectJava)(AP_EngineManagement* engine, const AP_uint8* jarbytes, AP_uint32 size);
1506 
1516  void (AP_ENGINE_CLIENT_CALL* injectCDP)(AP_EngineManagement* engine, const AP_uint8* cdpbytes, AP_uint32 size, const char*filename);
1517 
1524  void (AP_ENGINE_CLIENT_CALL* deleteName)(AP_EngineManagement* engine, const AP_char8* name);
1525 
1532  void (AP_ENGINE_CLIENT_CALL* forceDeleteName)(AP_EngineManagement* engine, const AP_char8* name);
1533 
1540  void (AP_ENGINE_CLIENT_CALL* killName)(AP_EngineManagement* engine, const AP_char8* name);
1541 
1545  void (AP_ENGINE_CLIENT_CALL* deleteAll)(AP_EngineManagement* engine);
1546 
1554  AP_EngineStatus* (AP_ENGINE_CLIENT_CALL* getStatus)(AP_EngineManagement* engine);
1555 
1570  AP_EventSupplier* (AP_ENGINE_CLIENT_CALL* connectEventConsumer)(AP_EngineManagement* engine, AP_EventConsumer* consumer, const AP_char8* const* channels);
1571 
1586  AP_EventSupplier* (AP_ENGINE_CLIENT_CALL* connectDisconnectableEventConsumer)(AP_EngineManagement* engine, AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels);
1587 
1607  AP_EventSupplier* (AP_ENGINE_CLIENT_CALL* connectDisconnectableSlowEventConsumer)(AP_EngineManagement* engine, AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels, AP_bool disconnectIfSlow);
1608 
1625  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);
1626 
1644  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);
1645 
1657  void (AP_ENGINE_CLIENT_CALL* detachAsEventConsumerFrom)(AP_EngineManagement* engine, AP_EngineManagement* target, const AP_char8* const* channels, AP_EngineManagement_ConnectMode mode);
1658 
1671  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);
1672 
1681  AP_EngineInfo* (AP_ENGINE_CLIENT_CALL* inspectEngine)(AP_EngineManagement* engine);
1682 
1692  void (AP_ENGINE_CLIENT_CALL* ping)(AP_EngineManagement* engine);
1693 
1699  AP_bool (AP_ENGINE_CLIENT_CALL* isConnected)(AP_EngineManagement* engine);
1700 
1716  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectMonitorScriptWithWarnings)(AP_EngineManagement* engine, AP_MonitorScript* script);
1717 
1734  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectMonitorScriptWithWarningsFilename)(AP_EngineManagement* engine, AP_MonitorScript* script, const char *filename);
1735 
1750  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectJavaWithWarnings)(AP_EngineManagement* engine, const AP_uint8* jarbytes, AP_uint32 size);
1751 
1766  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectJavaWithWarningsFilename)(AP_EngineManagement* engine, const AP_uint8* jarbytes, AP_uint32 size, const char *filename);
1767 
1782  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectCDPWithWarnings)(AP_EngineManagement* engine, const AP_uint8* cdpbytes, AP_uint32 size);
1783 
1798  const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectCDPWithWarningsFilename)(AP_EngineManagement* engine, const AP_uint8* cdpbytes, AP_uint32 size, const char *filename);
1799 
1807  void (AP_ENGINE_CLIENT_CALL* sendEventsNoBatching)(AP_EngineManagement* engine, AP_Event** events);
1808 
1819  void (AP_ENGINE_CLIENT_CALL* sendEvents)(AP_EngineManagement* engine, AP_Event** events);
1820 
1824  void (AP_ENGINE_CLIENT_CALL* flushEvents)(AP_EngineManagement* engine);
1825  };
1826 
1831  {
1832  void *reserved;
1837  };
1838 
1839  struct AP_EngineManagement_Stubs
1840  {
1841  struct AP_EngineManagement_API api;
1842 
1843 #ifdef __cplusplus
1844  void injectMonitorScript(AP_MonitorScript* script) {
1845  api.functions->injectMonitorScript(this, script);
1846  }
1847 
1848  void injectJava(const AP_uint8* jarbytes, AP_uint32 size) {
1849  api.functions->injectJava(this, jarbytes, size);
1850  }
1851 
1852  void injectCDP(const AP_uint8* cdpbytes, AP_uint32 size, const char* filename) {
1853  api.functions->injectCDP(this, cdpbytes, size, filename);
1854  }
1855 
1856  const AP_char8* const* injectMonitorScriptWithWarnings(AP_MonitorScript* script) {
1857  return api.functions->injectMonitorScriptWithWarnings(this, script);
1858  }
1859 
1860  const AP_char8* const* injectMonitorScriptWithWarningsFilename(AP_MonitorScript* script, const char *filename) {
1861  return api.functions->injectMonitorScriptWithWarningsFilename(this, script, filename);
1862  }
1863 
1864  const AP_char8* const* injectJavaWithWarnings(const AP_uint8* jarbytes, AP_uint32 size) {
1865  return api.functions->injectJavaWithWarnings(this, jarbytes, size);
1866  }
1867 
1868  const AP_char8* const* injectJavaWithWarningsFilename(const AP_uint8* jarbytes, AP_uint32 size, const char *filename) {
1869  return api.functions->injectJavaWithWarningsFilename(this, jarbytes, size, filename);
1870  }
1871 
1872  const AP_char8* const* injectCDPWithWarnings(const AP_uint8* cdpbytes, AP_uint32 size) {
1873  return api.functions->injectCDPWithWarnings(this, cdpbytes, size);
1874  }
1875 
1876  const AP_char8* const* injectCDPWithWarningsFilename(const AP_uint8* cdpbytes, AP_uint32 size, const char *filename) {
1877  return api.functions->injectCDPWithWarningsFilename(this, cdpbytes, size, filename);
1878  }
1879  void deleteName(const AP_char8* name) {
1880  api.functions->deleteName(this, name);
1881  }
1882 
1883  void forceDeleteName(const AP_char8* name) {
1884  api.functions->forceDeleteName(this, name);
1885  };
1886 
1887  void killName(const AP_char8* name) {
1888  api.functions->killName(this, name);
1889  }
1890 
1891  void deleteAll() {
1892  api.functions->deleteAll(this);
1893  }
1894 
1895  AP_EngineStatus* getStatus() {
1896  return api.functions->getStatus(this);
1897  }
1898 
1899  AP_EventSupplier* connectEventConsumer(AP_EventConsumer* consumer, const AP_char8* const* channels) {
1900  return api.functions->connectEventConsumer(this, consumer, channels);
1901  }
1902 
1903  AP_EventSupplier* connectDisconnectableEventConsumer(AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels) {
1904  return api.functions->connectDisconnectableEventConsumer(this, consumer, channels);
1905  }
1906 
1907  AP_EventSupplier* connectDisconnectableSlowEventConsumer(AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels, bool disconnectSlow) {
1908  return api.functions->connectDisconnectableSlowEventConsumer(this, consumer, channels, disconnectSlow);
1909  }
1910 
1911  AP_bool attachAsEventConsumerTo(AP_EngineManagement* target, const AP_char8* const* channels, AP_bool disconnectSlow, AP_EngineManagement_ConnectMode mode) {
1912  return api.functions->attachAsEventConsumerTo(this, target, channels, disconnectSlow, mode);
1913  }
1914 
1915  AP_bool attachAsEventConsumerToHost(const AP_char8* hostname, AP_uint16 port, const AP_char8* const* channels, AP_bool disconnectSlow, AP_EngineManagement_ConnectMode mode) {
1916  return api.functions->attachAsEventConsumerToHost(this, hostname, port, channels, disconnectSlow, mode);
1917  }
1918 
1919  void detachAsEventConsumerFrom(AP_EngineManagement* target, const AP_char8* const* channels, AP_EngineManagement_ConnectMode mode) {
1920  api.functions->detachAsEventConsumerFrom(this, target, channels, mode);
1921  }
1922 
1923  void detachAsEventConsumerFromHost(const AP_char8* hostname, AP_uint16 port, const AP_char8* const* channels, AP_EngineManagement_ConnectMode mode) {
1924  api.functions->detachAsEventConsumerFromHost(this, hostname, port, channels, mode);
1925  }
1926 
1927  AP_EngineInfo* inspectEngine() {
1928  return api.functions->inspectEngine(this);
1929  }
1930 
1931  void ping() {
1932  api.functions->ping(this);
1933  }
1934 
1935  AP_bool isConnected() {
1936  return api.functions->isConnected(this);
1937  }
1938 
1939  void sendEvents(AP_Event** events) {
1940  api.functions->sendEvents(this, events);
1941  }
1942  void sendEventsNoBatching(AP_Event** events) {
1943  api.functions->sendEventsNoBatching(this, events);
1944  }
1945  void flushEvents(AP_Event** events) {
1946  api.functions->flushEvents(this);
1947  }
1948 #endif /* __cplusplus */
1949  };
1950 
1951 
1952  /* Static functions from C++ API */
1953 
1960  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineInit(const char *processName);
1961 
1968  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineInitNoMessaging(const char *processName);
1969 
1975  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineShutdown();
1976 
1989  AP_ENGINE_CLIENT_API AP_EngineManagement* AP_ENGINE_CLIENT_CALL AP_ConnectToEngine(const AP_char8* hostname, AP_uint16 port);
1990 
2003  AP_ENGINE_CLIENT_API AP_EngineManagement* AP_ENGINE_CLIENT_CALL AP_connectToEngineReceiveOnly(const AP_char8* hostname, AP_uint16 port);
2004 
2016  AP_ENGINE_CLIENT_API AP_EngineManagement* AP_ENGINE_CLIENT_CALL AP_connectToEngineMonitorOnly(const AP_char8* hostname, AP_uint16 port);
2017 
2018  /* Move to a private header ? */
2019  AP_ENGINE_CLIENT_API AP_EngineStatus* AP_ENGINE_CLIENT_CALL engineManagement_getStatusOpaque(void *opaque_EngineManagement, char **errmsg);
2020 
2030  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DisconnectFromEngine(AP_EngineManagement* engine);
2031 
2038  AP_ENGINE_CLIENT_API AP_MonitorScript* AP_ENGINE_CLIENT_CALL AP_CreateMonitorScript(const AP_char8* text);
2039 
2045  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteMonitorScript(AP_MonitorScript* script);
2046 
2055  AP_ENGINE_CLIENT_API AP_Event* AP_ENGINE_CLIENT_CALL AP_CreateEvent(const AP_char8* text, const AP_char8* channel);
2056 
2062  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEvent(AP_Event* event);
2063 
2072  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEventSupplier(AP_EventSupplier* supplier);
2073 
2079  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEngineStatus(AP_EngineStatus* status);
2080 
2090  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEngineInfo(AP_EngineInfo* info);
2091 
2097  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteWarnings(const AP_char8* const* warnings);
2098 
2100  typedef enum {
2111 
2117  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogLevel(AP_EngineClientLogLevel level);
2118 
2128  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFile(const AP_char8* filename, int truncate);
2129 
2141  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFileUTF8(const AP_char8* filename, int truncate);
2142 
2148  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFD(int fd);
2149 
2154  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogMutex(void *);
2155 
2160  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_ReOpenLog();
2161 
2162  /* Convert a string in local encoding to UTF-8, as required by most of the Apama API */
2163  AP_ENGINE_CLIENT_API AP_char8* AP_ENGINE_CLIENT_CALL AP_ConvertToUTF8(const AP_char8* s);
2164 
2165  /* Convert a string in UTF-8 to the local encoding, since most of the Apama API returns UTF-8 */
2166  AP_ENGINE_CLIENT_API AP_char8* AP_ENGINE_CLIENT_CALL AP_ConvertFromUTF8(const AP_char8* s);
2167 
2168 
2169  /* Exception checking/handling functions -- these don't appear in the C++ API */
2170 
2171  typedef enum {
2174 
2180  AP_ENGINE_CLIENT_API AP_bool AP_ENGINE_CLIENT_CALL AP_CheckException();
2181 
2187  AP_ENGINE_CLIENT_API AP_EngineClientExceptionType AP_ENGINE_CLIENT_CALL AP_GetExceptionType();
2188 
2195  AP_ENGINE_CLIENT_API const AP_char8* AP_ENGINE_CLIENT_CALL AP_GetExceptionMessage();
2196 
2204  AP_ENGINE_CLIENT_API const AP_char8* const* AP_ENGINE_CLIENT_CALL AP_GetExceptionWarnings();
2205 
2210  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_ClearException();
2211 
2226  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetEngineParams(const AP_char8* params);
2227 
2234  AP_ENGINE_CLIENT_API int AP_ENGINE_CLIENT_CALL AP_IsOutOfBandEvent(const AP_char8* eventName);
2235 
2239  AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_char8free(char *string);
2240 
2241 #ifdef __cplusplus
2242 } /* extern "C" */
2243 #endif /* __cplusplus */
2244 
2245 
2246 #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:1836
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:889
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:2171
NamedMonitorInfo facade for NamedInfo object.
Definition: engine_client_c.h:900
EngineStatus function API.
Definition: engine_client_c.h:447
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:947
struct AP_NamedReceiverInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1197
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:2103
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:347
const AP_char8 *AP_ENGINE_CLIENT_CALL * getAddress(AP_NamedReceiverInfo *info)
Get the address of this receiver.
struct AP_NamedJavaApplicationInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:951
struct AP_MonitorScript_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:429
struct AP_NameInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:863
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:1145
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:1147
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:226
DisconnectableEventConsumer function API.
Definition: engine_client_c.h:368
struct AP_EngineStatus_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:700
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:953
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_ClearException()
Clears the pending exception.
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:2104
struct AP_EngineInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1399
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:1097
Event supplier.
Definition: engine_client_c.h:307
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:998
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:1487
An exception in the client library.
Definition: engine_client_c.h:2172
struct AP_NamedContextInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1101
struct AP_NamedPluginReceiverInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1249
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".
Allow parallel connections on multiple channels.
Definition: engine_client_c.h:1478
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:389
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:1133
EventSupplier function API.
Definition: engine_client_c.h:290
For backwards compatibility, single serial connection.
Definition: engine_client_c.h:1477
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:696
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:327
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEngineStatus(AP_EngineStatus *status)
This function allows deletion of an AP_EngineStatus instance.
AP_uint32(AP_ENGINE_CLIENT_CALL *getNumSubMonitors)(AP_NamedMonitorInfo *info)
Gets the number of sub-monitors belonging to this monitor.
EngineInfo function API.
Definition: engine_client_c.h:1277
NamedPluginReceiverInfo function API.
Definition: engine_client_c.h:1229
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.
EngineManagement.
Definition: engine_client_c.h:1830
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:1245
AP_uint32(AP_ENGINE_CLIENT_CALL *getNumListeners)(AP_NamedJavaApplicationInfo *info)
Gets the number of listeners belonging to this application.
MonitorScript function API.
Definition: engine_client_c.h:410
AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEventSupplier(AP_EventSupplier *supplier)
This function disconnects and deletes an AP_EventSupplier instance.
NameInfo.
Definition: engine_client_c.h:859
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:1199
struct AP_NamedMonitorInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:904
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:425
Nothing logged.
Definition: engine_client_c.h:2101
struct AP_NamedTimerInfo_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:1045
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:1141
NamedJavaApplicationInfo function API.
Definition: engine_client_c.h:936
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:1172
Information messages (default)
Definition: engine_client_c.h:2107
struct AP_DisconnectableEventConsumer_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:387
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.
DisconnectableEventConsumer.
Definition: engine_client_c.h:383
void *AP_ENGINE_CLIENT_CALL * copyIterator(AP_EngineStatus *status, void *opaque_state)
Copy an opaque_state as returned by getNextStatusItem.
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:1395
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:2109
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:264
Debugging messages.
Definition: engine_client_c.h:2108
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:2100
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_EventConsumer_Functions * functions
Pointer to function API.
Definition: engine_client_c.h:351
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:994
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:1251
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:311
NamedReceiverInfo facade for NamedInfo object.
Definition: engine_client_c.h:1193
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:906
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:1000
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:1476
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:1834
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:260
char const *const *AP_ENGINE_CLIENT_CALL * getChannels(AP_NamedReceiverInfo *info)
Gets the channels to which this context is subscribed.
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:1041
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:2105
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.
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:1047
NameInfo function API.
Definition: engine_client_c.h:837
AP_NameInfo * s_NameInfo
Pointer to NameInfo facade for this object.
Definition: engine_client_c.h:1103
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:2106
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:983
Startup and other important messages.
Definition: engine_client_c.h:2102
NamedContextInfo function API.
Definition: engine_client_c.h:1077
NamedTimerInfoInfo function API.
Definition: engine_client_c.h:1030