engine_client_c.h

Go to the documentation of this file.

/*
 * engine_client_c.h
 *
 * $Copyright(c) 2002-2012 Progress Software Corporation and/or its subsidiaries and affiliates. All rights reserved.$
 * $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.$
 * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG
 *
 * $Id: engine_client_c.h 287963 2016-07-29 14:31:18Z matj $
 */

#ifndef ENGINE_CLIENT_C_H
#define ENGINE_CLIENT_C_H


#include <AP_Types.h>
#include <AP_Platform.h>

#ifndef ENGINE_CLIENT_CPP_HPP
#ifdef __GNUC__
#warning The Apama Client C-API is deprecated. Please use the C++ API located in engine_client_cpp.hpp instead
#else
#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")
#endif
#endif

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


        struct AP_Event_API;
        struct AP_EventSupplier_API;
        struct AP_EventConsumer_API;
        struct AP_DisconnectableEventConsumer_API;
        struct AP_MonitorScript_API;
        struct AP_EngineStatus_API;
        struct AP_NameInfo_API;
        struct AP_NamedMonitorInfo_API;
        struct AP_NamedJavaApplicationInfo_API;
        struct AP_NamedEventTypeInfo_API;
        struct AP_NamedTimerInfo_API;
        struct AP_NamedContextInfo_API;
        struct AP_NamedAggregateInfo_API;
        struct AP_NamedReceiverInfo_API;
        struct AP_NamedPluginReceiverInfo_API;
        struct AP_EngineInfo_API;
        struct AP_EngineManagement_API;

#ifdef __cplusplus
        struct AP_Event_Stubs;
        struct AP_EventSupplier_Stubs;
        struct AP_EventConsumer_Stubs;
        struct AP_DisconnectableEventConsumer_Stubs;
        struct AP_MonitorScript_Stubs;
        struct AP_EngineStatus_Stubs;
        struct AP_NameInfo_Stubs;
        struct AP_NamedMonitorInfo_Stubs;
        struct AP_NamedJavaApplicationInfo_Stubs;
        struct AP_NamedEventTypeInfo_Stubs;
        struct AP_NamedTimerInfo_Stubs;
        struct AP_NamedContextInfo_Stubs;
        struct AP_NamedAggregateInfo_Stubs;
        struct AP_NamedReceiverInfo_Stubs;
        struct AP_NamedPluginReceiverInfo_Stubs;
        struct AP_EngineInfo_Stubs;
        struct AP_EngineManagement_Stubs;

        typedef struct AP_Event_Stubs AP_Event;

        typedef struct AP_EventSupplier_Stubs AP_EventSupplier;

        typedef struct AP_EventConsumer_Stubs AP_EventConsumer;

        typedef struct AP_DisconnectableEventConsumer_Stubs AP_DisconnectableEventConsumer;

        typedef struct AP_MonitorScript_Stubs AP_MonitorScript;

        typedef struct AP_EngineStatus_Stubs AP_EngineStatus;

        typedef struct AP_NameInfo_Stubs AP_NameInfo;

        typedef struct AP_NamedMonitorInfo_Stubs AP_NamedMonitorInfo;

        typedef struct AP_NamedJavaApplicationInfo_Stubs AP_NamedJavaApplicationInfo;

        typedef struct AP_NamedEventTypeInfo_Stubs AP_NamedEventTypeInfo;

        typedef struct AP_NamedTimerInfo_Stubs AP_NamedTimerInfo;

        typedef struct AP_NamedContextInfo_Stubs AP_NamedContextInfo;

        typedef struct AP_NamedAggregateInfo_Stubs AP_NamedAggregateInfo;

        typedef struct AP_NamedReceiverInfo_Stubs AP_NamedReceiverInfo;

        typedef struct AP_NamedPluginReceiverInfo_Stubs AP_NamedPluginReceiverInfo;

        typedef struct AP_EngineInfo_Stubs AP_EngineInfo;

        typedef struct AP_EngineManagement_Stubs AP_EngineManagement;

#else
        typedef struct AP_Event_API AP_Event;
        typedef struct AP_EventSupplier_API AP_EventSupplier;
        typedef struct AP_EventConsumer_API AP_EventConsumer;
        typedef struct AP_DisconnectableEventConsumer_API AP_DisconnectableEventConsumer;
        typedef struct AP_MonitorScript_API AP_MonitorScript;
        typedef struct AP_EngineStatus_API AP_EngineStatus;
        typedef struct AP_NameInfo_API AP_NameInfo;
        typedef struct AP_NamedMonitorInfo_API AP_NamedMonitorInfo;
        typedef struct AP_NamedJavaApplicationInfo_API AP_NamedJavaApplicationInfo;
        typedef struct AP_NamedEventTypeInfo_API AP_NamedEventTypeInfo;
        typedef struct AP_NamedTimerInfo_API AP_NamedTimerInfo;
        typedef struct AP_NamedContextInfo_API AP_NamedContextInfo;
        typedef struct AP_NamedAggregateInfo_API AP_NamedAggregateInfo;
        typedef struct AP_NamedReceiverInfo_API AP_NamedReceiverInfo;
        typedef struct AP_NamedPluginReceiverInfo_API AP_NamedPluginReceiverInfo;
        typedef struct AP_EngineInfo_API AP_EngineInfo;
        typedef struct AP_EngineManagement_API AP_EngineManagement;
#endif /* __cplusplus */


        struct AP_Event_Functions
        {
                const AP_char8* (AP_ENGINE_CLIENT_CALL* getText)(AP_Event* event);
                const AP_char8* (AP_ENGINE_CLIENT_CALL* getChannel)(AP_Event* event);
                double (AP_ENGINE_CLIENT_CALL* getTime)(AP_Event* event);
        };

        struct AP_Event_API
        {
                void* reserved;
                struct AP_Event_Functions* functions;
        };

        struct AP_Event_Stubs
        {
                struct AP_Event_API api;

#ifdef __cplusplus
                const AP_char8* getText() {
                        return api.functions->getText(this);
                }

                const AP_char8* getChannel() {
                        return api.functions->getChannel(this);
                }

                double getTime() {
                        return api.functions->getTime(this);
                }
#endif /* __cplusplus */
        };


        struct AP_EventSupplier_Functions
        {
                void (AP_ENGINE_CLIENT_CALL* disconnect)(AP_EventSupplier* supplier);
        };

        struct AP_EventSupplier_API
        {
                void* reserved;
                struct AP_EventSupplier_Functions* functions;
        };

        struct AP_EventSupplier_Stubs {
                struct AP_EventSupplier_API api;

#ifdef __cplusplus
                void disconnect() {
                        api.functions->disconnect(this);
                }
#endif /*__cplusplus */
        };
        
        struct AP_EventConsumer_Functions
        {
                void (AP_ENGINE_CLIENT_CALL* sendEvents)(AP_EventConsumer* consumer, AP_Event** events);
        };

        struct AP_EventConsumer_API
        {
                void* reserved;
                struct AP_EventConsumer_Functions* functions;
        };

        struct AP_EventConsumer_Stubs
        {
                struct AP_EventConsumer_API api;

#ifdef __cplusplus
                void sendEvents(AP_Event** events) {
                        api.functions->sendEvents(this, events);
                }
#endif /* __cplusplus */
        };

        struct AP_DisconnectableEventConsumer_Functions
        {
                void (AP_ENGINE_CLIENT_CALL* disconnect)(AP_DisconnectableEventConsumer* consumer, const AP_char8* reason);
        };

        struct AP_DisconnectableEventConsumer_API
        {
                void *reserved;
                struct AP_DisconnectableEventConsumer_Functions* functions;
                AP_EventConsumer* s_EventConsumer;
        };

        struct AP_DisconnectableEventConsumer_Stubs
        {
          struct AP_DisconnectableEventConsumer_API api;

#ifdef __cplusplus
          void disconnect(const AP_char8* reason) {
            api.functions->disconnect(this, reason);
          }

          void sendEvents(AP_Event** events) {
            api.s_EventConsumer->api.functions->sendEvents(api.s_EventConsumer, events);
          }
#endif /* __cplusplus */
        };

        struct AP_MonitorScript_Functions
        {
                const AP_char8* (AP_ENGINE_CLIENT_CALL* getText)(AP_MonitorScript* script);
        };

        struct AP_MonitorScript_API
        {
                void* reserved;
                struct AP_MonitorScript_Functions* functions;
        };

        struct AP_MonitorScript_Stubs
        {
                struct AP_MonitorScript_API api;

#ifdef __cplusplus
                const AP_char8* getText() {
                        return api.functions->getText(this);
                };
#endif /*__cplusplus */
        };


        struct AP_EngineStatus_Functions
        {
                AP_bool (AP_ENGINE_CLIENT_CALL* print)(AP_EngineStatus* status, AP_char8* buf, AP_uint32 size);
        
                AP_uint64 (AP_ENGINE_CLIENT_CALL* getUptime)(AP_EngineStatus* status);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumMonitors)(AP_EngineStatus* status);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumProcesses)(AP_EngineStatus* status);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumListeners)(AP_EngineStatus* status);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumEventTypes)(AP_EngineStatus* status);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumQueuedFastTrack)(AP_EngineStatus* status);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumQueuedInput)(AP_EngineStatus* status);

                AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumReceived)(AP_EngineStatus* status);

                AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumFastTracked)(AP_EngineStatus* status);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumConsumers)(AP_EngineStatus* status);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumOutputEventsQueued)(AP_EngineStatus* status);

                AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumOutputEventsCreated)(AP_EngineStatus* status);

                AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumOutputEventsSent)(AP_EngineStatus* status);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumJavaApplications)(AP_EngineStatus* status);

                AP_uint64 (AP_ENGINE_CLIENT_CALL* getNumProcessed)(AP_EngineStatus* status);    

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumSubListeners)(AP_EngineStatus* status); 

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumContexts)(AP_EngineStatus* status);     

                const AP_char8* (AP_ENGINE_CLIENT_CALL* getMostBackedUpInput)(AP_EngineStatus* status);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getMostBackedUpQueueSize)(AP_EngineStatus* status);   

                const AP_char8* (AP_ENGINE_CLIENT_CALL* getSlowestReceiver)(AP_EngineStatus* status);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getSlowestReceiverQueueSize)(AP_EngineStatus* status);        

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNextStatusItem)(AP_EngineStatus* status, const char **name, const char **value, void **opaque_state);

                const AP_char8* (AP_ENGINE_CLIENT_CALL* getStatusValue)(AP_EngineStatus* status, const char *key);

                AP_uint64 (AP_ENGINE_CLIENT_CALL* getStatusIntValue)(AP_EngineStatus* status, const char *key);

                void (AP_ENGINE_CLIENT_CALL* deleteStatus)(AP_EngineStatus *status);

                AP_EngineStatus *(AP_ENGINE_CLIENT_CALL* copyStatus)(AP_EngineStatus *status);

                void *(AP_ENGINE_CLIENT_CALL* copyIterator)(AP_EngineStatus* status, void *opaque_state);

                void (AP_ENGINE_CLIENT_CALL* disposeIterator)(AP_EngineStatus* status, void *opaque_state);

                AP_int64 (AP_ENGINE_CLIENT_CALL* getUserInt)(AP_EngineStatus* status, const char* key);

                AP_int64 (AP_ENGINE_CLIENT_CALL* getUserIntOr)(AP_EngineStatus* status, const char* key, AP_int64 alt);

                AP_float64(AP_ENGINE_CLIENT_CALL* getUserFloat)(AP_EngineStatus* status, const char* key);
                AP_float64(AP_ENGINE_CLIENT_CALL* getUserFloatOr)(AP_EngineStatus* status, const char* key, AP_float64 alt);

                AP_bool(AP_ENGINE_CLIENT_CALL* getUserBool)(AP_EngineStatus* status, const char* key);

                AP_bool(AP_ENGINE_CLIENT_CALL* getUserBoolOr)(AP_EngineStatus* status, const char* key, AP_bool alt);

                const AP_char8*(AP_ENGINE_CLIENT_CALL* getUserString)(AP_EngineStatus* status, const char* key);

                const AP_char8*(AP_ENGINE_CLIENT_CALL* getUserStringOr)(AP_EngineStatus* status, const char* key, const AP_char8* alt);
        };

        struct AP_EngineStatus_API
        {
                void* reserved;
                struct AP_EngineStatus_Functions* functions;
        };

        struct AP_EngineStatus_Stubs
        {
                struct AP_EngineStatus_API api;

#ifdef __cplusplus
                AP_bool print(AP_char8* buf, AP_uint32 size) {
                        return api.functions->print(this,buf,size);
                }

                AP_uint64 getUptime() {
                        return api.functions->getUptime(this);
                }

                AP_uint32 getNumMonitors() {
                        return api.functions->getNumMonitors(this);
                }

                AP_uint32 getNumProcesses() {
                        return api.functions->getNumProcesses(this);
                }

                AP_uint32 getNumJavaApplications() {
                        return api.functions->getNumJavaApplications(this);
                }

                AP_uint32 getNumListeners() {
                        return api.functions->getNumListeners(this);
                }

                AP_uint32 getNumEventTypes() {
                        return api.functions->getNumEventTypes(this);
                }

                AP_uint32 getNumQueuedFastTrack() {
                        return api.functions->getNumQueuedFastTrack(this);
                }

                AP_uint32 getNumQueuedInput() {
                        return api.functions->getNumQueuedInput(this);
                }

                AP_uint64 getNumReceived() {
                        return api.functions->getNumReceived(this);
                }

                AP_uint64 getNumFastTracked() {
                        return api.functions->getNumFastTracked(this);
                }

                AP_uint32 getNumConsumers() {
                        return api.functions->getNumConsumers(this);
                }

                AP_uint32 getNumOutputEventsQueued() {
                        return api.functions->getNumOutputEventsQueued(this);
                }

                AP_uint64 getNumOutputEventsCreated() {
                        return api.functions->getNumOutputEventsCreated(this);
                }

                AP_uint64 getNumOutputEventsSent() {
                        return api.functions->getNumOutputEventsSent(this);
                }

                AP_uint64 getNumProcessed() {
                        return api.functions->getNumProcessed(this);
                }

                AP_uint32 getNumSubListeners() {
                        return api.functions->getNumSubListeners(this);
                }

                AP_uint32 getNumContexts() {
                        return api.functions->getNumContexts(this);
                }

                AP_uint32 getNextStatusItem(const char **name, const char **value, void **opaque_state) {
                        return api.functions->getNextStatusItem(this, name, value, opaque_state);
                }

                AP_int64 getUserInt(const char* key) {
                        return api.functions->getUserInt(this, key);
                }
                AP_int64 getUserIntOr(const char* key, AP_int64 alt) {
                        return api.functions->getUserIntOr(this, key, alt);
                }

                AP_float64 getUserFloat(const char* key) {
                        return api.functions->getUserFloat(this, key);
                }
                AP_float64 getUserFloatOr(const char* key, AP_float64 alt) {
                        return api.functions->getUserFloatOr(this, key, alt);
                }

                AP_bool getUserBool(AP_EngineStatus* status, const char* key) {
                        return api.functions->getUserBool(this, key);
                }
                AP_bool getUserBoolOr(AP_EngineStatus* status, const char* key, AP_bool alt) {
                        return api.functions->getUserBoolOr(this, key, alt);
                }

                const AP_char8* getUserString(AP_EngineStatus* status, const char* key) {
                        return api.functions->getUserString(this, key);
                }
                const AP_char8* getUserStringOr(AP_EngineStatus* status, const char* key, const AP_char8* alt) {
                        return api.functions->getUserStringOr(this, key, alt);
                }

                void disposeIterator(void *opaque_state) {
                        api.functions->disposeIterator(this, opaque_state);
                }
                const AP_char8* getMostBackedUpInput() {
                        return api.functions->getMostBackedUpInput(this);
                }
                AP_uint32 getMostBackedUpQueueSize() {
                        return api.functions->getMostBackedUpQueueSize(this);
                }
                
                const AP_char8* getSlowestReceiver() {
                        return api.functions->getSlowestReceiver(this);
                }

                AP_uint32 getSlowestReceiverQueueSize() {
                        return api.functions->getSlowestReceiverQueueSize(this);
                }
                

#endif /*__cplusplus */
        };

        struct AP_NameInfo_Functions
        {
                const AP_char8* (AP_ENGINE_CLIENT_CALL* getName)(AP_NameInfo* info);

                const AP_char8* (AP_ENGINE_CLIENT_CALL* getPackage)(AP_NameInfo* info);

                const AP_char8* (AP_ENGINE_CLIENT_CALL* getFullyQualifiedName)(AP_NameInfo* info);
        };

        struct AP_NameInfo_API
        {
                void* reserved;
                struct AP_NameInfo_Functions* functions;
        };

        struct AP_NameInfo_Stubs
        {
                struct AP_NameInfo_API api;

#ifdef __cplusplus
                const AP_char8* getName() {
                        return api.functions->getName(this);
                }

                const AP_char8* getPackage() {
                        return api.functions->getPackage(this);
                }

                const AP_char8* getFullyQualifiedName() {
                        return api.functions->getFullyQualifiedName(this);
                }
#endif /*__cplusplus */
        };


        struct AP_NamedMonitorInfo_Functions
        {
                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumSubMonitors)(AP_NamedMonitorInfo* info);
        };

        struct AP_NamedMonitorInfo_API
        {
                void* reserved;
                struct AP_NamedMonitorInfo_Functions* functions;
                AP_NameInfo* s_NameInfo;
        };

        struct AP_NamedMonitorInfo_Stubs
        {
                struct AP_NamedMonitorInfo_API api;

#ifdef __cplusplus
                AP_uint32 getNumSubMonitors() {
                        return api.functions->getNumSubMonitors(this);
                }

                const AP_char8* getName() {
                        return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
                }

                const AP_char8* getPackage() {
                        return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
                }

                const AP_char8* getFullyQualifiedName() {
                        return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
                }
#endif /*__cplusplus */
        };


        struct AP_NamedJavaApplicationInfo_Functions
        {
                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumListeners)(AP_NamedJavaApplicationInfo* info);
        };

        struct AP_NamedJavaApplicationInfo_API
        {
                void* reserved;
                struct AP_NamedJavaApplicationInfo_Functions* functions;
                AP_NameInfo* s_NameInfo;
        };

        struct AP_NamedJavaApplicationInfo_Stubs
        {
                struct AP_NamedJavaApplicationInfo_API api;

#ifdef __cplusplus
                AP_uint32 getNumListeners() {
                        return api.functions->getNumListeners(this);
                }

                const AP_char8* getName() {
                        return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
                }

                const AP_char8* getPackage() {
                        return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
                }

                const AP_char8* getFullyQualifiedName() {
                        return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
                }
#endif /*__cplusplus */
        };


        struct AP_NamedEventTypeInfo_Functions
        {
                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumEventTemplates)(AP_NamedEventTypeInfo* info);
        };

        struct AP_NamedEventTypeInfo_API
        {
                void* reserved;
                struct AP_NamedEventTypeInfo_Functions* functions;
                AP_NameInfo* s_NameInfo;
        };

        struct AP_NamedEventTypeInfo_Stubs
        {
                struct AP_NamedEventTypeInfo_API api;

#ifdef __cplusplus
                AP_uint32 getNumEventTemplates() {
                        return api.functions->getNumEventTemplates(this);
                }

                const AP_char8* getName() {
                        return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
                }

                const AP_char8* getPackage() {
                        return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
                }

                const AP_char8* getFullyQualifiedName() {
                        return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
                }
#endif /*__cplusplus */
        };


        struct AP_NamedTimerInfo_Functions
        {
                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumTimers)(AP_NamedTimerInfo* info);
        };

        struct AP_NamedTimerInfo_API
        {
                void* reserved;
                struct AP_NamedTimerInfo_Functions* functions;
                AP_NameInfo* s_NameInfo;
        };

        struct AP_NamedTimerInfo_Stubs
        {
                struct AP_NamedTimerInfo_API api;

#ifdef __cplusplus
                AP_uint32 getNumTimers() {
                        return api.functions->getNumTimers(this);
                }

                const AP_char8* getName() {
                        return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
                }

                const AP_char8* getPackage() {
                        return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
                }

                const AP_char8* getFullyQualifiedName() {
                        return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
                }
#endif /*__cplusplus */
        };


        struct AP_NamedContextInfo_Functions {
                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumSubMonitors)(AP_NamedContextInfo* info);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getQueueSize)(AP_NamedContextInfo* info);

                char const *const *(AP_ENGINE_CLIENT_CALL *getChannels)(AP_NamedContextInfo *info);
        };

        struct AP_NamedContextInfo_API
        {
                void* reserved;
                struct AP_NamedContextInfo_Functions* functions;
                AP_NameInfo* s_NameInfo;
        };

        struct AP_NamedContextInfo_Stubs
        {
                struct AP_NamedContextInfo_API api;

#ifdef __cplusplus
                const AP_char8* getName() {
                        return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
                }

                AP_uint32 getNumSubMonitors() {
                        return api.functions->getNumSubMonitors(this);
                }

                AP_uint32 getQueueSize() {
                        return api.functions->getQueueSize(this);
                }

                char const *const *getChannels() {
                        return api.functions->getChannels(this);
                }

#endif /*__cplusplus */
        };

        struct AP_NamedAggregateInfo_Functions
        {
                void** placeholder;
        };

        struct AP_NamedAggregateInfo_API
        {
                void* reserved;
                struct AP_NamedAggregateInfo_Functions* functions;
                AP_NameInfo* s_NameInfo;
        };

        struct AP_NamedAggregateInfo_Stubs
        {
                struct AP_NamedAggregateInfo_API api;

#ifdef __cplusplus
                const AP_char8* getName() {
                        return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
                }

                const AP_char8* getPackage() {
                        return api.s_NameInfo->api.functions->getPackage(api.s_NameInfo);
                }

                const AP_char8* getFullyQualifiedName() {
                        return api.s_NameInfo->api.functions->getFullyQualifiedName(api.s_NameInfo);
                }
#endif /*__cplusplus */
        };

        struct AP_NamedReceiverInfo_Functions
        {
                AP_uint32 (AP_ENGINE_CLIENT_CALL* getQueueSize)(AP_NamedReceiverInfo* info);

                char const *const *(AP_ENGINE_CLIENT_CALL *getChannels)(AP_NamedReceiverInfo *info);

                const AP_char8 *(AP_ENGINE_CLIENT_CALL *getAddress)(AP_NamedReceiverInfo *info);
        };

        struct AP_NamedReceiverInfo_API
        {
                void* reserved;
                struct AP_NamedReceiverInfo_Functions* functions;
                AP_NameInfo* s_NameInfo;
        };

        struct AP_NamedReceiverInfo_Stubs
        {
                struct AP_NamedReceiverInfo_API api;

#ifdef __cplusplus
                const AP_char8 *getName() {
                        return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
                }

                const AP_char8 *getAddress() {
                        return api.functions->getAddress(this);
                }

                AP_uint32 getQueueSize() {
                        return api.functions->getQueueSize(this);
                }

                char const *const *getChannels() {
                        return api.functions->getChannels(this);
                }

#endif /*__cplusplus */
        };

        struct AP_NamedPluginReceiverInfo_Functions
        {
                AP_uint32 (AP_ENGINE_CLIENT_CALL* getQueueSize)(AP_NamedPluginReceiverInfo* info);

                char const *const *(AP_ENGINE_CLIENT_CALL *getChannels)(AP_NamedPluginReceiverInfo *info);
        };

        struct AP_NamedPluginReceiverInfo_API
        {
                void* reserved;
                struct AP_NamedPluginReceiverInfo_Functions* functions;
                AP_NameInfo* s_NameInfo;
        };

        struct AP_NamedPluginReceiverInfo_Stubs
        {
                struct AP_NamedPluginReceiverInfo_API api;

#ifdef __cplusplus
                const AP_char8 *getName() {
                        return api.s_NameInfo->api.functions->getName(api.s_NameInfo);
                }

                AP_uint32 getQueueSize() {
                        return api.functions->getQueueSize(this);
                }

                char const *const *getChannels() {
                        return api.functions->getChannels(this);
                }

#endif /*__cplusplus */
        };

        struct AP_EngineInfo_Functions
        {
                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumMonitors)(AP_EngineInfo* info);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumEventTypes)(AP_EngineInfo* info);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumTimers)(AP_EngineInfo* info);

                AP_NamedMonitorInfo** (AP_ENGINE_CLIENT_CALL* getMonitors)(AP_EngineInfo* info);

                AP_NamedEventTypeInfo** (AP_ENGINE_CLIENT_CALL* getEventTypes)(AP_EngineInfo* info);

                AP_NamedTimerInfo** (AP_ENGINE_CLIENT_CALL* getTimers)(AP_EngineInfo* info);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumJavaApplications)(AP_EngineInfo* info);

                AP_NamedJavaApplicationInfo** (AP_ENGINE_CLIENT_CALL* getJavaApplications)(AP_EngineInfo* info);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumContexts)(AP_EngineInfo* info);

                AP_NamedContextInfo** (AP_ENGINE_CLIENT_CALL* getContexts)(AP_EngineInfo* info);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumAggregates)(AP_EngineInfo* info);

                AP_NamedAggregateInfo** (AP_ENGINE_CLIENT_CALL* getAggregates)(AP_EngineInfo* info);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumReceivers)(AP_EngineInfo* info);

                AP_NamedReceiverInfo** (AP_ENGINE_CLIENT_CALL* getReceivers)(AP_EngineInfo* info);

                AP_uint32 (AP_ENGINE_CLIENT_CALL* getNumPluginReceivers)(AP_EngineInfo* info);

                AP_NamedPluginReceiverInfo** (AP_ENGINE_CLIENT_CALL* getPluginReceivers)(AP_EngineInfo* info);
        };

        struct AP_EngineInfo_API
        {
                void* reserved;
                struct AP_EngineInfo_Functions* functions;
        };

        struct AP_EngineInfo_Stubs
        {
                struct AP_EngineInfo_API api;

#ifdef __cplusplus
                AP_uint32 getNumMonitors() {
                        return api.functions->getNumMonitors(this);
                }

                AP_uint32 getNumEventTypes() {
                        return api.functions->getNumEventTypes(this);
                }

                AP_uint32 getNumTimers() {
                        return api.functions->getNumTimers(this);
                }

                AP_NamedMonitorInfo** getMonitors() {
                        return api.functions->getMonitors(this);
                }

                AP_NamedEventTypeInfo** getEventTypes() {
                        return api.functions->getEventTypes(this);
                }

                AP_NamedTimerInfo** getTimers() {
                        return api.functions->getTimers(this);
                }

                AP_uint32 getNumJavaApplications() {
                        return api.functions->getNumJavaApplications(this);
                }

                AP_NamedJavaApplicationInfo** getJavaApplications() {
                        return api.functions->getJavaApplications(this);
                }

                AP_uint32 getNumContexts() {
                        return api.functions->getNumContexts(this);
                }

                AP_NamedContextInfo** getContexts() {
                        return api.functions->getContexts(this);
                }

                AP_uint32 getNumAggregates() {
                        return api.functions->getNumAggregates(this);
                }
                
                AP_NamedAggregateInfo** getAggregates() {
                        return api.functions->getAggregates(this);
                }

                AP_uint32 getNumReceivers() {
                        return api.functions->getNumReceivers(this);
                }
                
                AP_NamedReceiverInfo** getReceivers() {
                        return api.functions->getReceivers(this);
                }

                AP_uint32 getNumPluginReceivers() {
                        return api.functions->getNumPluginReceivers(this);
                }
                
                AP_NamedPluginReceiverInfo** getPluginReceivers() {
                        return api.functions->getPluginReceivers(this);
                }

#endif /*__cplusplus */
        };


        enum AP_EngineManagement_ConnectMode {
                CONNECT_LEGACY,
                CONNECT_PARALLEL
        };

        typedef enum AP_EngineManagement_ConnectMode AP_EngineManagement_ConnectMode;


        struct AP_EngineManagement_Functions
        {
                void (AP_ENGINE_CLIENT_CALL* injectMonitorScript)(AP_EngineManagement* engine, AP_MonitorScript* script);

                void (AP_ENGINE_CLIENT_CALL* injectJava)(AP_EngineManagement* engine, const AP_uint8* jarbytes, AP_uint32 size);

                void (AP_ENGINE_CLIENT_CALL* injectCDP)(AP_EngineManagement* engine, const AP_uint8* cdpbytes, AP_uint32 size, const char*filename);

                void (AP_ENGINE_CLIENT_CALL* deleteName)(AP_EngineManagement* engine, const AP_char8* name);

                void (AP_ENGINE_CLIENT_CALL* forceDeleteName)(AP_EngineManagement* engine, const AP_char8* name);

                void (AP_ENGINE_CLIENT_CALL* killName)(AP_EngineManagement* engine, const AP_char8* name);

                void (AP_ENGINE_CLIENT_CALL* deleteAll)(AP_EngineManagement* engine);

                AP_EngineStatus* (AP_ENGINE_CLIENT_CALL* getStatus)(AP_EngineManagement* engine);

                AP_EventSupplier* (AP_ENGINE_CLIENT_CALL* connectEventConsumer)(AP_EngineManagement* engine, AP_EventConsumer* consumer, const AP_char8* const* channels);

                AP_EventSupplier* (AP_ENGINE_CLIENT_CALL* connectDisconnectableEventConsumer)(AP_EngineManagement* engine, AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels);

                AP_EventSupplier* (AP_ENGINE_CLIENT_CALL* connectDisconnectableSlowEventConsumer)(AP_EngineManagement* engine, AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels, AP_bool disconnectIfSlow);

                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);

                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);

                void (AP_ENGINE_CLIENT_CALL* detachAsEventConsumerFrom)(AP_EngineManagement* engine, AP_EngineManagement* target, const AP_char8* const* channels, AP_EngineManagement_ConnectMode mode);

                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);

                AP_EngineInfo* (AP_ENGINE_CLIENT_CALL* inspectEngine)(AP_EngineManagement* engine);

                void (AP_ENGINE_CLIENT_CALL* ping)(AP_EngineManagement* engine);

                AP_bool (AP_ENGINE_CLIENT_CALL* isConnected)(AP_EngineManagement* engine);

                const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectMonitorScriptWithWarnings)(AP_EngineManagement* engine, AP_MonitorScript* script);

                const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectMonitorScriptWithWarningsFilename)(AP_EngineManagement* engine, AP_MonitorScript* script, const char *filename);

                const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectJavaWithWarnings)(AP_EngineManagement* engine, const AP_uint8* jarbytes, AP_uint32 size);

                const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectJavaWithWarningsFilename)(AP_EngineManagement* engine, const AP_uint8* jarbytes, AP_uint32 size, const char *filename);

                const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectCDPWithWarnings)(AP_EngineManagement* engine, const AP_uint8* cdpbytes, AP_uint32 size);

                const AP_char8* const* (AP_ENGINE_CLIENT_CALL* injectCDPWithWarningsFilename)(AP_EngineManagement* engine, const AP_uint8* cdpbytes, AP_uint32 size, const char *filename);

                void (AP_ENGINE_CLIENT_CALL* sendEventsNoBatching)(AP_EngineManagement* engine, AP_Event** events);

                void (AP_ENGINE_CLIENT_CALL* sendEvents)(AP_EngineManagement* engine, AP_Event** events);

                void (AP_ENGINE_CLIENT_CALL* flushEvents)(AP_EngineManagement* engine);
        };

        struct AP_EngineManagement_API
        {
                void *reserved;
                struct AP_EngineManagement_Functions* functions;
                AP_EventConsumer* s_EventConsumer;
        };

        struct AP_EngineManagement_Stubs
        {
                struct AP_EngineManagement_API api;

#ifdef __cplusplus
                void injectMonitorScript(AP_MonitorScript* script) {
                        api.functions->injectMonitorScript(this, script);
                }

                void injectJava(const AP_uint8* jarbytes, AP_uint32 size) {
                        api.functions->injectJava(this, jarbytes, size);
                }

                void injectCDP(const AP_uint8* cdpbytes, AP_uint32 size, const char* filename) {
                        api.functions->injectCDP(this, cdpbytes, size, filename);
                }

                const AP_char8* const* injectMonitorScriptWithWarnings(AP_MonitorScript* script) {
                        return api.functions->injectMonitorScriptWithWarnings(this, script);
                }

                const AP_char8* const* injectMonitorScriptWithWarningsFilename(AP_MonitorScript* script, const char *filename) {
                        return api.functions->injectMonitorScriptWithWarningsFilename(this, script, filename);
                }

                const AP_char8* const* injectJavaWithWarnings(const AP_uint8* jarbytes, AP_uint32 size) {
                        return api.functions->injectJavaWithWarnings(this, jarbytes, size);
                }

                const AP_char8* const* injectJavaWithWarningsFilename(const AP_uint8* jarbytes, AP_uint32 size, const char *filename) {
                        return api.functions->injectJavaWithWarningsFilename(this, jarbytes, size, filename);
                }

                const AP_char8* const* injectCDPWithWarnings(const AP_uint8* cdpbytes, AP_uint32 size) {
                        return api.functions->injectCDPWithWarnings(this, cdpbytes, size);
                }

                const AP_char8* const* injectCDPWithWarningsFilename(const AP_uint8* cdpbytes, AP_uint32 size, const char *filename) {
                        return api.functions->injectCDPWithWarningsFilename(this, cdpbytes, size, filename);
                }
                void deleteName(const AP_char8* name) {
                        api.functions->deleteName(this, name);
                }

                void forceDeleteName(const AP_char8* name) {
                        api.functions->forceDeleteName(this, name);
                };

                void killName(const AP_char8* name) {
                        api.functions->killName(this, name);
                }

                void deleteAll() {
                        api.functions->deleteAll(this);
                }

                AP_EngineStatus* getStatus() {
                        return api.functions->getStatus(this);
                }

                AP_EventSupplier* connectEventConsumer(AP_EventConsumer* consumer, const AP_char8* const* channels) {
                        return api.functions->connectEventConsumer(this, consumer, channels);
                }

                AP_EventSupplier* connectDisconnectableEventConsumer(AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels) {
                        return api.functions->connectDisconnectableEventConsumer(this, consumer, channels);
                }

                AP_EventSupplier* connectDisconnectableSlowEventConsumer(AP_DisconnectableEventConsumer* consumer, const AP_char8* const* channels, bool disconnectSlow) {
                        return api.functions->connectDisconnectableSlowEventConsumer(this, consumer, channels, disconnectSlow);
                }

                AP_bool attachAsEventConsumerTo(AP_EngineManagement* target, const AP_char8* const* channels, AP_bool disconnectSlow, AP_EngineManagement_ConnectMode mode) {
                        return api.functions->attachAsEventConsumerTo(this, target, channels, disconnectSlow, mode);
                }

                AP_bool attachAsEventConsumerToHost(const AP_char8* hostname, AP_uint16 port, const AP_char8* const* channels, AP_bool disconnectSlow, AP_EngineManagement_ConnectMode mode) {
                        return api.functions->attachAsEventConsumerToHost(this, hostname, port, channels, disconnectSlow, mode);
                }

                void detachAsEventConsumerFrom(AP_EngineManagement* target, const AP_char8* const* channels, AP_EngineManagement_ConnectMode mode) {
                        api.functions->detachAsEventConsumerFrom(this, target, channels, mode);
                }

                void detachAsEventConsumerFromHost(const AP_char8* hostname, AP_uint16 port, const AP_char8* const* channels, AP_EngineManagement_ConnectMode mode) {
                        api.functions->detachAsEventConsumerFromHost(this, hostname, port, channels, mode);
                }

                AP_EngineInfo* inspectEngine() {
                        return api.functions->inspectEngine(this);
                }

                void ping() {
                        api.functions->ping(this);
                }

                AP_bool isConnected() {
                        return api.functions->isConnected(this);
                }

                void sendEvents(AP_Event** events) {
                        api.functions->sendEvents(this, events);
                }
                void sendEventsNoBatching(AP_Event** events) {
                        api.functions->sendEventsNoBatching(this, events);
                }
                void flushEvents(AP_Event** events) {
                        api.functions->flushEvents(this);
                }
#endif /* __cplusplus */
        };


        /* Static functions from C++ API */

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineInit(const char *processName);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineInitNoMessaging(const char *processName);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_EngineShutdown();

        AP_ENGINE_CLIENT_API AP_EngineManagement* AP_ENGINE_CLIENT_CALL AP_ConnectToEngine(const AP_char8* hostname, AP_uint16 port);

        AP_ENGINE_CLIENT_API AP_EngineManagement* AP_ENGINE_CLIENT_CALL AP_connectToEngineReceiveOnly(const AP_char8* hostname, AP_uint16 port);

        AP_ENGINE_CLIENT_API AP_EngineManagement* AP_ENGINE_CLIENT_CALL AP_connectToEngineMonitorOnly(const AP_char8* hostname, AP_uint16 port);

        /* Move to a private header ? */
        AP_ENGINE_CLIENT_API AP_EngineStatus* AP_ENGINE_CLIENT_CALL engineManagement_getStatusOpaque(void *opaque_EngineManagement, char **errmsg);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DisconnectFromEngine(AP_EngineManagement* engine);

        AP_ENGINE_CLIENT_API AP_MonitorScript* AP_ENGINE_CLIENT_CALL AP_CreateMonitorScript(const AP_char8* text);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteMonitorScript(AP_MonitorScript* script);

        AP_ENGINE_CLIENT_API AP_Event* AP_ENGINE_CLIENT_CALL AP_CreateEvent(const AP_char8* text, const AP_char8* channel);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEvent(AP_Event* event);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEventSupplier(AP_EventSupplier* supplier);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEngineStatus(AP_EngineStatus* status);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteEngineInfo(AP_EngineInfo* info);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_DeleteWarnings(const AP_char8* const* warnings);
        
        typedef enum {
                OFF_LEVEL,
                FORCE_LEVEL,
                CRIT_LEVEL,
                FATAL_LEVEL,
                ERROR_LEVEL,
                WARN_LEVEL,
                INFO_LEVEL,
                DEBUG_LEVEL,
                TRACE_LEVEL
        } AP_EngineClientLogLevel;
        
        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogLevel(AP_EngineClientLogLevel level);
        
        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFile(const AP_char8* filename, int truncate);
        
        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFileUTF8(const AP_char8* filename, int truncate);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogFD(int fd);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetLogMutex(void *);
        
        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_ReOpenLog();
        
        /* Convert a string in local encoding to UTF-8, as required by most of the Apama API */
        AP_ENGINE_CLIENT_API AP_char8* AP_ENGINE_CLIENT_CALL AP_ConvertToUTF8(const AP_char8* s);

        /* Convert a string in UTF-8 to the local encoding, since most of the Apama API returns UTF-8 */
        AP_ENGINE_CLIENT_API AP_char8* AP_ENGINE_CLIENT_CALL AP_ConvertFromUTF8(const AP_char8* s);


        /* Exception checking/handling functions -- these don't appear in the C++ API */

        typedef enum {
                AP_ENGINE_EXCEPTION
        } AP_EngineClientExceptionType;

        AP_ENGINE_CLIENT_API AP_bool AP_ENGINE_CLIENT_CALL AP_CheckException();

        AP_ENGINE_CLIENT_API AP_EngineClientExceptionType AP_ENGINE_CLIENT_CALL AP_GetExceptionType();

        AP_ENGINE_CLIENT_API const AP_char8*  AP_ENGINE_CLIENT_CALL AP_GetExceptionMessage();

        AP_ENGINE_CLIENT_API const AP_char8* const*  AP_ENGINE_CLIENT_CALL AP_GetExceptionWarnings();

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_ClearException();

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL AP_SetEngineParams(const AP_char8* params);
        
        AP_ENGINE_CLIENT_API int AP_ENGINE_CLIENT_CALL AP_IsOutOfBandEvent(const AP_char8* eventName);

        AP_ENGINE_CLIENT_API void AP_ENGINE_CLIENT_CALL  AP_char8free(char *string);

#ifdef __cplusplus
}       /* extern "C" */
#endif /* __cplusplus */


#endif /* ENGINE_CLIENT_C_H */