EventCodec.h

Go to the documentation of this file.

/*
 * EventCodec.h
 *
 * External (client-visible) interface to event encoding/decoding (codec)
 * plugin libraries within the Apama Integration Adapter Framework (IAF).
 * This is the interface that must be implemented by all codec libraries in
 * order to be successfully loaded and integrated by the IAF.
 *
 * $Copyright(c) 2002-2007, 2008, 2013, 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_CODEC_H
#define AP_EVENT_CODEC_H


#include <AP_Types.h>
#include <IAF_Platform.h>
#include <NormalisedEvent.h>
#include <EventTransport.h>
#include <SemanticMapper.h>
#include <AP_TimestampSet.h>
#include <IAF_TimestampConfig.h>

#define AP_EVENTCODEC_VERSION     0x00040000


#define AP_EVENTCODEC_CAP_ENCODER  0x0001
#define AP_EVENTCODEC_CAP_DECODER  0x0002


#define AP_EVENTCODEC_INFO_FUNCTION_NAME AP_EventCodec_info
#define AP_EVENTCODEC_CTOR_FUNCTION_NAME AP_EventCodec_ctor
#define AP_EVENTCODEC_DTOR_FUNCTION_NAME AP_EventCodec_dtor


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


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


typedef enum {
        AP_EventCodec_OK = 0,                   
        AP_EventCodec_InternalError,    
        AP_EventCodec_EncodingFailure,  
        AP_EventCodec_DecodingFailure,  
        AP_EventCodec_TransportFailure, 
        AP_EventCodec_MappingFailure,   
        AP_EventCodec_BadProperties             
} AP_EventCodecError;


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



typedef struct {
        AP_char8* name;
        AP_EventCodecProperty** properties;
} AP_EventCodecProperties;


typedef struct {
        AP_char8* status;
        AP_uint64 totalDecoded;
        AP_uint64 totalEncoded;
        AP_NormalisedEvent* statusDictionary;
} AP_EventCodecStatus;


struct AP_EventCodec_Functions {

        AP_EventCodecError (*updateProperties)(struct AP_EventCodec* codec, AP_EventCodecProperties* properties, IAF_TimestampConfig* timestampConfig);

        const AP_char8* (*getLastError)(struct AP_EventCodec* codec);

        void (*getStatus)(struct AP_EventCodec* codec, AP_EventCodecStatus* status);
};


struct AP_EventEncoder_Functions {

        AP_EventCodecError (*sendNormalisedEvent)(struct AP_EventEncoder* encoder, AP_NormalisedEvent* event, AP_TimestampSet* timeStamp);

        AP_EventCodecError (*flushUpstream)(struct AP_EventEncoder* encoder);

        const AP_char8* (*getLastError)(struct AP_EventEncoder* encoder);

        void (*addEventTransport)(struct AP_EventEncoder* encoder, const AP_char8* name, struct AP_EventTransport* transport);

        void (*removeEventTransport)(struct AP_EventEncoder* encoder, const AP_char8* name);
};


struct AP_EventDecoder_Functions {

        AP_EventCodecError (*sendTransportEvent)(struct AP_EventDecoder* decoder, AP_TransportEvent event, AP_TimestampSet* timeStamp);

        void (*setSemanticMapper)(struct AP_EventDecoder* decoder, AP_SemanticMapper* mapper);

        AP_EventCodecError (*flushDownstream)(struct AP_EventDecoder* decoder);

        const AP_char8* (*getLastError)(struct AP_EventDecoder* decoder);
};


struct AP_EventEncoder {

        void* reserved;

        struct AP_EventEncoder_Functions* functions;
};
typedef struct AP_EventEncoder AP_EventEncoder;


struct AP_EventDecoder {

        void* reserved;

        struct AP_EventDecoder_Functions* functions;
};
typedef struct AP_EventDecoder AP_EventDecoder;


struct AP_EventCodec {

        void* reserved;

        struct AP_EventCodec_Functions* functions;

        AP_EventEncoder* encoder;

        AP_EventDecoder* decoder;
};
typedef struct AP_EventCodec AP_EventCodec;


typedef AP_EVENTCODEC_API void (AP_EVENTCODEC_CALL* AP_EventCodecInfoPtr)(AP_uint32* version, AP_uint32* capabilities);


typedef AP_EVENTCODEC_API AP_EventCodec* (AP_EVENTCODEC_CALL* AP_EventCodecCtorPtr)(AP_char8* name, AP_EventCodecProperties* properties, AP_EventCodecError* err, AP_char8** errMsg, IAF_TimestampConfig* timestampConfig);


typedef AP_EVENTCODEC_API void (AP_EVENTCODEC_CALL* AP_EventCodecDtorPtr)(AP_EventCodec* codec);


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


#endif  /* AP_EVENT_CODEC_H */