NormalisedEvent.h

Go to the documentation of this file.

/*
 * NormalisedEvent.h
 *
 * External (client-visible) interface to the normalised event type used to
 * pass event into and out of the IAF Semantic Mapper component.  Normalised
 * events are essentially just dictionaries of name-value pairs, where both
 * the names and values are character strings.  Each name-value pair nominally
 * represents the name and content of a single field from an event, but users
 * of the class are free to invent custom naming schemes to represent more
 * complex event structures.  Names must be unique within a given event.
 * Values may be empty or missing.
 *
 * Please note that normalised events are NOT thread-safe.  If your code will
 * be acessing the same normalised event object (or associated iterators) from
 * multiple threads, you must implement your own thread synchronisation to
 * prevent concurrent modification of the objects.
 *
 * $Copyright(c) 2002-2006, 2008, 2013-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_NORMALISED_EVENT_H
#define AP_NORMALISED_EVENT_H


#include <AP_Types.h>
#include <IAF_Platform.h>

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


/*
 * Forward declare some classes
 */
struct AP_NormalisedEvent;
struct AP_NormalisedEventIterator;


typedef const AP_char8* AP_NormalisedEventKey;


typedef const AP_char8* AP_NormalisedEventValue;


struct AP_NormalisedEventIterator_Functions {

        AP_bool (*valid)(struct AP_NormalisedEventIterator* it);

        AP_NormalisedEventKey (*key)(struct AP_NormalisedEventIterator* it);

        AP_NormalisedEventValue (*value)(struct AP_NormalisedEventIterator* it);

        AP_bool (*next)(struct AP_NormalisedEventIterator* it);

        AP_bool (*back)(struct AP_NormalisedEventIterator* it);
};


struct AP_NormalisedEventIterator {

        void* reserved;

        struct AP_NormalisedEventIterator_Functions* functions;

};
typedef struct AP_NormalisedEventIterator AP_NormalisedEventIterator;


AP_IAFCORE_API void AP_IAFCORE_CALL AP_NormalisedEventIterator_dtor(AP_NormalisedEventIterator* it);


struct AP_NormalisedEvent_Functions {

        AP_uint32 (*size)(struct AP_NormalisedEvent* event);

        AP_bool (*empty)(struct AP_NormalisedEvent* event);

        AP_NormalisedEventIterator* (*add)(struct AP_NormalisedEvent* event, AP_NormalisedEventKey key, AP_NormalisedEventValue value);

        void (*addQuick)(struct AP_NormalisedEvent* event, AP_NormalisedEventKey key, AP_NormalisedEventValue value);

        void (*remove)(struct AP_NormalisedEvent* event, AP_NormalisedEventKey key);

        void (*replace)(struct AP_NormalisedEvent* event, AP_NormalisedEventKey key, AP_NormalisedEventValue newValue);

        void (*removeAll)(struct AP_NormalisedEvent* event);

        AP_bool (*exists)(struct AP_NormalisedEvent* event, AP_NormalisedEventKey key);

        AP_NormalisedEventIterator* (*find)(struct AP_NormalisedEvent* event, AP_NormalisedEventKey key);

        AP_NormalisedEventValue (*findValue)(struct AP_NormalisedEvent* event, AP_NormalisedEventKey key);

        AP_NormalisedEventValue (*findValueAndRemove)(struct AP_NormalisedEvent* event, AP_NormalisedEventKey key);

        AP_NormalisedEventValue (*findValueAndRemove2)(struct AP_NormalisedEvent* event, AP_NormalisedEventKey key, AP_bool* existed);  

        AP_NormalisedEventIterator* (*first)(struct AP_NormalisedEvent* event);

        AP_NormalisedEventIterator* (*last)(struct AP_NormalisedEvent* event);

        AP_char8* (*toString)(struct AP_NormalisedEvent* event);
        
        
        void (*char8free)(AP_char8* string);    

};


struct AP_NormalisedEvent {

        void* reserved;

        struct AP_NormalisedEvent_Functions* functions;

};
typedef struct AP_NormalisedEvent AP_NormalisedEvent;


/*
 * AP_NormalisedEvent_globalInit
 *
 * Initialisation function used internally by the IAF.  User code should *not*
 * call this function under any circumstances.
 */
AP_IAFCORE_API void AP_IAFCORE_CALL AP_NormalisedEvent_globalInit();


AP_IAFCORE_API AP_NormalisedEvent* AP_IAFCORE_CALL AP_NormalisedEvent_ctor();


AP_IAFCORE_API AP_NormalisedEvent* AP_IAFCORE_CALL AP_NormalisedEvent_copy(AP_NormalisedEvent* old);


AP_IAFCORE_API void AP_IAFCORE_CALL AP_NormalisedEvent_dtor(AP_NormalisedEvent* event);


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


#endif  /* AP_NORMALISED_EVENT_H */