EventTransport.h

Go to the documentation of this file.

/*
 * EventTransport.h
 *
 * External (client-visible) interface to Transport Integration Layer (TIL)
 * plugin libraries within the Apama Integration Adapter Framework (IAF).
 * This is the interface that must be implemented by all transport libraries
 * in order to be successfully loaded and integrated by the IAF.
 *
 * $Copyright(c) 2002-2006, 2008, 2010, 2013-2014, 2016-2018, 2022 Cumulocity GmbH, Duesseldorf, Germany 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 Cumulocity GmbH.
 *
 */

#ifndef AP_EVENT_TRANSPORT_H
#define AP_EVENT_TRANSPORT_H

/*
 * Define this here so EventCodec.h picks it up as well
 */
typedef void* AP_TransportEvent;


#include <AP_Types.h>
#include <IAF_Platform.h>
#include <EventCodec.h>
#include <AP_TimestampSet.h>
#include <IAF_TimestampConfig.h>

#define AP_EVENTTRANSPORT_VERSION         0x00040000


/*
 * Names of functions exported from shared library.  The IAF will search for
 * these functions by name when the library is loaded, so you must use these
 * *exact* names when implementing a transport library.
 */
#define AP_EVENTTRANSPORT_INFO_FUNCTION_NAME AP_EventTransport_info
#define AP_EVENTTRANSPORT_CTOR_FUNCTION_NAME AP_EventTransport_ctor
#define AP_EVENTTRANSPORT_DTOR_FUNCTION_NAME AP_EventTransport_dtor


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


/*
 * Forward-declare some structures
 */
struct AP_EventTransport;
struct AP_EventDecoder;


typedef enum {
        AP_EventTransport_OK = 0,                       
        AP_EventTransport_InternalError,        
        AP_EventTransport_TransportFailure, 
        AP_EventTransport_DecodingFailure,  
        AP_EventTransport_BadProperties,        
        AP_EventTransport_CantStart             
} AP_EventTransportError;


typedef struct {
        AP_char8* name;
        AP_char8* value;
} AP_EventTransportProperty;


typedef struct {
        AP_char8* name;
        AP_EventTransportProperty** properties;
} AP_EventTransportProperties;


typedef struct {
        AP_char8* status;
        AP_uint64 totalReceived;
        AP_uint64 totalSent;
        AP_NormalisedEvent* statusDictionary;
} AP_EventTransportStatus;



struct AP_EventTransport_Functions {

        AP_EventTransportError (*updateProperties)(struct AP_EventTransport* transport, AP_EventTransportProperties* properties, IAF_TimestampConfig* timestampConfig);

        AP_EventTransportError (*sendTransportEvent)(struct AP_EventTransport* transport, AP_TransportEvent event, AP_TimestampSet* timeStamp);

        void (*addEventDecoder)(struct AP_EventTransport* transport, const AP_char8* name, struct AP_EventDecoder* decoder);

        void (*removeEventDecoder)(struct AP_EventTransport* transport, const AP_char8* name);

        AP_EventTransportError (*flushUpstream)(struct AP_EventTransport* transport);

        AP_EventTransportError (*flushDownstream)(struct AP_EventTransport* transport);

        AP_EventTransportError (*start)(struct AP_EventTransport* transport);

        AP_EventTransportError (*stop)(struct AP_EventTransport* transport);

        const AP_char8* (*getLastError)(struct AP_EventTransport* transport);

        void (*getStatus)(struct AP_EventTransport* transport, AP_EventTransportStatus* status);
};


struct AP_EventTransport {

        void* reserved;

        struct AP_EventTransport_Functions* functions;
};
typedef struct AP_EventTransport AP_EventTransport;


typedef AP_EVENTTRANSPORT_API void (AP_EVENTTRANSPORT_CALL* AP_EventTransportInfoPtr)(AP_uint32* version, AP_uint32* capabilities);


typedef AP_EVENTTRANSPORT_API AP_EventTransport* (AP_EVENTTRANSPORT_CALL* AP_EventTransportCtorPtr)(AP_char8* name, AP_EventTransportProperties* properties, AP_EventTransportError* err, AP_char8** errMsg, IAF_TimestampConfig* timestampConfig);

typedef AP_EVENTTRANSPORT_API void (AP_EVENTTRANSPORT_CALL* AP_EventTransportDtorPtr)(AP_EventTransport* obj);


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


#endif  /* AP_EVENT_TRANSPORT_H */