SemanticMapper.h

Go to the documentation of this file.

/*
 * SemanticMapper.h
 *
 * External (client-visible) interface to the Semantic Mapper component of the
 * Apama Integration Adapter Framework (IAF).
 *
 * $Copyright(c) 2002, 2004-2006, 2008-2009, 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_SEMANTIC_MAPPER_H
#define AP_SEMANTIC_MAPPER_H

#include <AP_Types.h>
#include <NormalisedEvent.h>
#include <AP_TimestampSet.h>

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


/*
 * Forward declare some structures
 */
struct AP_SemanticMapper;


typedef enum {
        AP_SemanticMapper_OK = 0,                       
        AP_SemanticMapper_InternalError,        
        AP_SemanticMapper_MappingFailure,       
        AP_SemanticMapper_InjectionFailure      
} AP_SemanticMapperError;


struct AP_SemanticMapper_Functions {

        AP_SemanticMapperError (*sendNormalisedEvent)(struct AP_SemanticMapper* mapper, AP_NormalisedEvent* event, AP_TimestampSet* timeStamp);

        AP_SemanticMapperError (*parseApamaEvent) (struct AP_SemanticMapper* mapper, const AP_char8* eventString, const AP_char8* channelString, AP_NormalisedEvent*** returnArray);

        AP_SemanticMapperError (*freeNormalizedArray) (struct AP_SemanticMapper* mapper, AP_NormalisedEvent** eventArray, AP_bool hasContent);

        AP_SemanticMapperError (*createApamaEventStrings) (struct AP_SemanticMapper* mapper, AP_NormalisedEvent* event, AP_char8*** returnArrayPtr, AP_char8*** channelArrayPtr);

        AP_SemanticMapperError (*freeStringArray) (struct AP_SemanticMapper* mapper, AP_char8** eventArray, AP_bool hasContent);

        const AP_char8* (*getLastError)(struct AP_SemanticMapper* mapper);
};


struct AP_SemanticMapper{

        void* reserved;

        struct AP_SemanticMapper_Functions* functions;

};
typedef struct AP_SemanticMapper AP_SemanticMapper;

AP_IAFCORE_API AP_SemanticMapper *ap_getSemanticMapper();

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


#endif  /* AP_SEMANTIC_MAPPER_H */