16 #ifndef ENGINE_CLIENT_C_H
17 #define ENGINE_CLIENT_C_H
21 #include <AP_Platform.h>
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;
68 typedef struct AP_Event_Stubs
AP_Event;
267 struct AP_Event_Stubs
272 const AP_char8* getText() {
276 const AP_char8* getChannel() {
314 struct AP_EventSupplier_Stubs {
354 struct AP_EventConsumer_Stubs
359 void sendEvents(
AP_Event** events) {
392 struct AP_DisconnectableEventConsumer_Stubs
397 void disconnect(
const AP_char8* reason) {
401 void sendEvents(
AP_Event** events) {
432 struct AP_MonitorScript_Stubs
437 const AP_char8* getText() {
597 AP_uint32 (AP_ENGINE_CLIENT_CALL* getNextStatusItem)(
AP_EngineStatus* status,
const char **name,
const char **value,
void **opaque_state);
627 void (AP_ENGINE_CLIENT_CALL* disposeIterator)(
AP_EngineStatus* status,
void *opaque_state);
703 struct AP_EngineStatus_Stubs
708 AP_bool print(AP_char8* buf, AP_uint32 size) {
709 return api.
functions->print(
this,buf,size);
712 AP_uint64 getUptime() {
716 AP_uint32 getNumMonitors() {
717 return api.
functions->getNumMonitors(
this);
720 AP_uint32 getNumProcesses() {
721 return api.
functions->getNumProcesses(
this);
724 AP_uint32 getNumJavaApplications() {
725 return api.
functions->getNumJavaApplications(
this);
728 AP_uint32 getNumListeners() {
729 return api.
functions->getNumListeners(
this);
732 AP_uint32 getNumEventTypes() {
733 return api.
functions->getNumEventTypes(
this);
736 AP_uint32 getNumQueuedFastTrack() {
737 return api.
functions->getNumQueuedFastTrack(
this);
740 AP_uint32 getNumQueuedInput() {
741 return api.
functions->getNumQueuedInput(
this);
744 AP_uint64 getNumReceived() {
745 return api.
functions->getNumReceived(
this);
748 AP_uint64 getNumFastTracked() {
749 return api.
functions->getNumFastTracked(
this);
752 AP_uint32 getNumConsumers() {
753 return api.
functions->getNumConsumers(
this);
756 AP_uint32 getNumOutputEventsQueued() {
757 return api.
functions->getNumOutputEventsQueued(
this);
760 AP_uint64 getNumOutputEventsCreated() {
761 return api.
functions->getNumOutputEventsCreated(
this);
764 AP_uint64 getNumOutputEventsSent() {
765 return api.
functions->getNumOutputEventsSent(
this);
768 AP_uint64 getNumProcessed() {
769 return api.
functions->getNumProcessed(
this);
772 AP_uint32 getNumSubListeners() {
773 return api.
functions->getNumSubListeners(
this);
776 AP_uint32 getNumContexts() {
777 return api.
functions->getNumContexts(
this);
780 AP_uint32 getNextStatusItem(
const char **name,
const char **value,
void **opaque_state) {
781 return api.
functions->getNextStatusItem(
this, name, value, opaque_state);
784 AP_int64 getUserInt(
const char* key) {
785 return api.
functions->getUserInt(
this, key);
787 AP_int64 getUserIntOr(
const char* key, AP_int64 alt) {
788 return api.
functions->getUserIntOr(
this, key, alt);
791 AP_float64 getUserFloat(
const char* key) {
792 return api.
functions->getUserFloat(
this, key);
794 AP_float64 getUserFloatOr(
const char* key, AP_float64 alt) {
795 return api.
functions->getUserFloatOr(
this, key, alt);
799 return api.
functions->getUserBool(
this, key);
801 AP_bool getUserBoolOr(
AP_EngineStatus* status,
const char* key, AP_bool alt) {
802 return api.
functions->getUserBoolOr(
this, key, alt);
805 const AP_char8* getUserString(
AP_EngineStatus* status,
const char* key) {
808 const AP_char8* getUserStringOr(
AP_EngineStatus* status,
const char* key,
const AP_char8* alt) {
812 void disposeIterator(
void *opaque_state) {
813 api.
functions->disposeIterator(
this, opaque_state);
815 const AP_char8* getMostBackedUpInput() {
818 AP_uint32 getMostBackedUpQueueSize() {
819 return api.
functions->getMostBackedUpQueueSize(
this);
822 const AP_char8* getSlowestReceiver() {
826 AP_uint32 getSlowestReceiverQueueSize() {
827 return api.
functions->getSlowestReceiverQueueSize(
this);
866 struct AP_NameInfo_Stubs
871 const AP_char8* getName() {
875 const AP_char8* getPackage() {
879 const AP_char8* getFullyQualifiedName() {
909 struct AP_NamedMonitorInfo_Stubs
914 AP_uint32 getNumSubMonitors() {
915 return api.
functions->getNumSubMonitors(
this);
918 const AP_char8* getName() {
922 const AP_char8* getPackage() {
926 const AP_char8* getFullyQualifiedName() {
956 struct AP_NamedJavaApplicationInfo_Stubs
961 AP_uint32 getNumListeners() {
962 return api.
functions->getNumListeners(
this);
965 const AP_char8* getName() {
969 const AP_char8* getPackage() {
973 const AP_char8* getFullyQualifiedName() {
1003 struct AP_NamedEventTypeInfo_Stubs
1008 AP_uint32 getNumEventTemplates() {
1009 return api.
functions->getNumEventTemplates(
this);
1012 const AP_char8* getName() {
1016 const AP_char8* getPackage() {
1020 const AP_char8* getFullyQualifiedName() {
1050 struct AP_NamedTimerInfo_Stubs
1055 AP_uint32 getNumTimers() {
1056 return api.
functions->getNumTimers(
this);
1059 const AP_char8* getName() {
1063 const AP_char8* getPackage() {
1067 const AP_char8* getFullyQualifiedName() {
1106 struct AP_NamedContextInfo_Stubs
1111 const AP_char8* getName() {
1115 AP_uint32 getNumSubMonitors() {
1116 return api.
functions->getNumSubMonitors(
this);
1119 AP_uint32 getQueueSize() {
1120 return api.
functions->getQueueSize(
this);
1123 char const *
const *getChannels() {
1150 struct AP_NamedAggregateInfo_Stubs
1155 const AP_char8* getName() {
1159 const AP_char8* getPackage() {
1163 const AP_char8* getFullyQualifiedName() {
1202 struct AP_NamedReceiverInfo_Stubs
1207 const AP_char8 *getName() {
1211 const AP_char8 *getAddress() {
1215 AP_uint32 getQueueSize() {
1216 return api.
functions->getQueueSize(
this);
1219 char const *
const *getChannels() {
1254 struct AP_NamedPluginReceiverInfo_Stubs
1259 const AP_char8 *getName() {
1263 AP_uint32 getQueueSize() {
1264 return api.
functions->getQueueSize(
this);
1267 char const *
const *getChannels() {
1402 struct AP_EngineInfo_Stubs
1407 AP_uint32 getNumMonitors() {
1408 return api.
functions->getNumMonitors(
this);
1411 AP_uint32 getNumEventTypes() {
1412 return api.
functions->getNumEventTypes(
this);
1415 AP_uint32 getNumTimers() {
1416 return api.
functions->getNumTimers(
this);
1431 AP_uint32 getNumJavaApplications() {
1432 return api.
functions->getNumJavaApplications(
this);
1439 AP_uint32 getNumContexts() {
1440 return api.
functions->getNumContexts(
this);
1447 AP_uint32 getNumAggregates() {
1448 return api.
functions->getNumAggregates(
this);
1455 AP_uint32 getNumReceivers() {
1456 return api.
functions->getNumReceivers(
this);
1463 AP_uint32 getNumPluginReceivers() {
1464 return api.
functions->getNumPluginReceivers(
this);
1505 void (AP_ENGINE_CLIENT_CALL* injectJava)(
AP_EngineManagement* engine,
const AP_uint8* jarbytes, AP_uint32 size);
1516 void (AP_ENGINE_CLIENT_CALL* injectCDP)(
AP_EngineManagement* engine,
const AP_uint8* cdpbytes, AP_uint32 size,
const char*filename);
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);
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);
1839 struct AP_EngineManagement_Stubs
1845 api.
functions->injectMonitorScript(
this, script);
1848 void injectJava(
const AP_uint8* jarbytes, AP_uint32 size) {
1849 api.
functions->injectJava(
this, jarbytes, size);
1852 void injectCDP(
const AP_uint8* cdpbytes, AP_uint32 size,
const char* filename) {
1853 api.
functions->injectCDP(
this, cdpbytes, size, filename);
1856 const AP_char8*
const* injectMonitorScriptWithWarnings(
AP_MonitorScript* script) {
1860 const AP_char8*
const* injectMonitorScriptWithWarningsFilename(
AP_MonitorScript* script,
const char *filename) {
1864 const AP_char8*
const* injectJavaWithWarnings(
const AP_uint8* jarbytes, AP_uint32 size) {
1868 const AP_char8*
const* injectJavaWithWarningsFilename(
const AP_uint8* jarbytes, AP_uint32 size,
const char *filename) {
1872 const AP_char8*
const* injectCDPWithWarnings(
const AP_uint8* cdpbytes, AP_uint32 size) {
1876 const AP_char8*
const* injectCDPWithWarningsFilename(
const AP_uint8* cdpbytes, AP_uint32 size,
const char *filename) {
1879 void deleteName(
const AP_char8* name) {
1883 void forceDeleteName(
const AP_char8* name) {
1884 api.
functions->forceDeleteName(
this, name);
1887 void killName(
const AP_char8* name) {
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);
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);
1919 void detachAsEventConsumerFrom(
AP_EngineManagement* target,
const AP_char8*
const* channels, AP_EngineManagement_ConnectMode mode) {
1920 api.
functions->detachAsEventConsumerFrom(
this, target, channels, mode);
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);
1935 AP_bool isConnected() {
1936 return api.
functions->isConnected(
this);
1939 void sendEvents(
AP_Event** events) {
1940 api.
functions->sendEvents(
this, events);
1942 void sendEventsNoBatching(
AP_Event** events) {
1943 api.
functions->sendEventsNoBatching(
this, events);
1945 void flushEvents(
AP_Event** events) {
1960 AP_ENGINE_CLIENT_API
void AP_ENGINE_CLIENT_CALL
AP_EngineInit(
const char *processName);
2019 AP_ENGINE_CLIENT_API
AP_EngineStatus* AP_ENGINE_CLIENT_CALL engineManagement_getStatusOpaque(
void *opaque_EngineManagement,
char **errmsg);
2055 AP_ENGINE_CLIENT_API
AP_Event* AP_ENGINE_CLIENT_CALL
AP_CreateEvent(
const AP_char8* text,
const AP_char8* channel);
2097 AP_ENGINE_CLIENT_API
void AP_ENGINE_CLIENT_CALL
AP_DeleteWarnings(
const AP_char8*
const* warnings);
2128 AP_ENGINE_CLIENT_API
void AP_ENGINE_CLIENT_CALL
AP_SetLogFile(
const AP_char8* filename,
int truncate);
2141 AP_ENGINE_CLIENT_API
void AP_ENGINE_CLIENT_CALL
AP_SetLogFileUTF8(
const AP_char8* filename,
int truncate);
2148 AP_ENGINE_CLIENT_API
void AP_ENGINE_CLIENT_CALL
AP_SetLogFD(
int fd);
2154 AP_ENGINE_CLIENT_API
void AP_ENGINE_CLIENT_CALL
AP_SetLogMutex(
void *);
2160 AP_ENGINE_CLIENT_API
void AP_ENGINE_CLIENT_CALL
AP_ReOpenLog();
2163 AP_ENGINE_CLIENT_API AP_char8* AP_ENGINE_CLIENT_CALL AP_ConvertToUTF8(
const AP_char8* s);
2166 AP_ENGINE_CLIENT_API AP_char8* AP_ENGINE_CLIENT_CALL AP_ConvertFromUTF8(
const AP_char8* s);
2226 AP_ENGINE_CLIENT_API
void AP_ENGINE_CLIENT_CALL
AP_SetEngineParams(
const AP_char8* params);
2234 AP_ENGINE_CLIENT_API
int AP_ENGINE_CLIENT_CALL AP_IsOutOfBandEvent(
const AP_char8* eventName);
2239 AP_ENGINE_CLIENT_API
void AP_ENGINE_CLIENT_CALL
AP_char8free(
char *
string);
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