Apama  10.5.4.1
SemanticMapper.h
Go to the documentation of this file.
1 /*
2  * SemanticMapper.h
3  *
4  * External (client-visible) interface to the Semantic Mapper component of the
5  * Apama Integration Adapter Framework (IAF).
6  *
7  * $Copyright(c) 2002, 2004-2006, 2008-2009 Progress Software Corporation (PSC). All rights reserved.$
8  * $Copyright (c) 2013, 2016-2018 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.$
9  * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG
10  *
11  * $Id: SemanticMapper.h 339852 2018-10-24 14:12:31Z jhea $
12  */
13 
14 #ifndef AP_SEMANTIC_MAPPER_H
15 #define AP_SEMANTIC_MAPPER_H
16 
17 #include <AP_Types.h>
18 #include <NormalisedEvent.h>
19 #include <AP_TimestampSet.h>
20 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif /* __cplusplus */
28 
29 
30 /*
31  * Forward declare some structures
32  */
33 struct AP_SemanticMapper;
34 
35 
43 typedef enum {
53 
54 
67 
85 
99  AP_SemanticMapperError (*parseApamaEvent) (struct AP_SemanticMapper* mapper, const AP_char8* eventString, const AP_char8* channelString, AP_NormalisedEvent*** returnArray);
100 
114  AP_SemanticMapperError (*freeNormalizedArray) (struct AP_SemanticMapper* mapper, AP_NormalisedEvent** eventArray, AP_bool hasContent);
115 
132  AP_SemanticMapperError (*createApamaEventStrings) (struct AP_SemanticMapper* mapper, AP_NormalisedEvent* event, AP_char8*** returnArrayPtr, AP_char8*** channelArrayPtr);
133 
147  AP_SemanticMapperError (*freeStringArray) (struct AP_SemanticMapper* mapper, AP_char8** eventArray, AP_bool hasContent);
148 
159  const AP_char8* (*getLastError)(struct AP_SemanticMapper* mapper);
160 };
161 
162 
176 
180  void* reserved;
181 
187 
188 };
189 typedef struct AP_SemanticMapper AP_SemanticMapper;
190 
197 AP_IAFCORE_API AP_SemanticMapper *ap_getSemanticMapper();
198 
199 #ifdef __cplusplus
200 } /* extern "C" */
201 #endif /* __cplusplus */
202 
203 
204 #endif /* AP_SEMANTIC_MAPPER_H */
AP_SemanticMapperError(* parseApamaEvent)(struct AP_SemanticMapper *mapper, const AP_char8 *eventString, const AP_char8 *channelString, AP_NormalisedEvent ***returnArray)
parseApamaEvent
Definition: SemanticMapper.h:99
Normalised Event.
AP_SemanticMapperError(* sendNormalisedEvent)(struct AP_SemanticMapper *mapper, AP_NormalisedEvent *event, AP_TimestampSet *timeStamp)
sendNormalisedEvent
Definition: SemanticMapper.h:84
AP_SemanticMapperError(* createApamaEventStrings)(struct AP_SemanticMapper *mapper, AP_NormalisedEvent *event, AP_char8 ***returnArrayPtr, AP_char8 ***channelArrayPtr)
createApamaEventStrings
Definition: SemanticMapper.h:132
void * reserved
Pointer to private internal data.
Definition: SemanticMapper.h:180
AP_SemanticMapperError(* freeStringArray)(struct AP_SemanticMapper *mapper, AP_char8 **eventArray, AP_bool hasContent)
freeStringArray
Definition: SemanticMapper.h:147
AP_SemanticMapper_Functions.
Definition: SemanticMapper.h:66
struct AP_SemanticMapper_Functions * functions
Function table of Semantic Mapper operations.
Definition: SemanticMapper.h:186
AP_SemanticMapperError
AP_SemanticMapperError.
Definition: SemanticMapper.h:43
AP_SemanticMapperError(* freeNormalizedArray)(struct AP_SemanticMapper *mapper, AP_NormalisedEvent **eventArray, AP_bool hasContent)
freeNormalizedArray
Definition: SemanticMapper.h:114
AP_IAFCORE_API AP_SemanticMapper * ap_getSemanticMapper()
ap_getSemanticMapper
Couldn't queue converted event for injection into Engine.
Definition: SemanticMapper.h:51
AP_NormalisedEvent.
Definition: NormalisedEvent.h:455
Hires Timestamps.
Couldn't convert customer event to Apama event.
Definition: SemanticMapper.h:49
Everything is fine.
Definition: SemanticMapper.h:45
AP_SemanticMapper.
Definition: SemanticMapper.h:175
AP_TimestampSet.
Definition: AP_TimestampSet.h:307
Some unspecified internal error occurred.
Definition: SemanticMapper.h:47