AP_TimestampSet.h

Go to the documentation of this file.

/*
 * Title:       AP_TimestampSet.h
 * Description: High-accuracy time stamp generator
 * $Copyright(c) 2008, 2009, 2011-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.
 * @author      Henry Lockwood
 */

#ifndef AP_TIMESTAMP_SET_H
#define AP_TIMESTAMP_SET_H

#include <AP_Platform.h>
#include <IAF_Platform.h>
#include <sys/timeb.h>
#include <string.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 * High-res timestamp IDs.  These are symbolic constants used to index
 * where a timestamp was created.
 */

/*
 * Downstream (incoming towards correlator) timestamp IDs
 */

/* 1000-1999 are for downstream events in the IAF */
#define AP_TIMESTAMP_DOWNSTREAM_IAF_MIN               1000

#define AP_TIMESTAMP_DOWNSTREAM_IAF_TRANSPORT_ENTRY   1000

#define AP_TIMESTAMP_DOWNSTREAM_IAF_TRANSPORT_EXIT    1249

#define AP_TIMESTAMP_DOWNSTREAM_IAF_DECODER_ENTRY     1250

#define AP_TIMESTAMP_DOWNSTREAM_IAF_DECODER_EXIT      1499

#define AP_TIMESTAMP_DOWNSTREAM_IAF_MAPPER_ENTRY      1500

#define AP_TIMESTAMP_DOWNSTREAM_IAF_MAPPER_EXIT       1749

#define AP_TIMESTAMP_DOWNSTREAM_IAF_APAMA_ENTRY       1750

#define AP_TIMESTAMP_DOWNSTREAM_IAF_APAMA_EXIT        1999
#define AP_TIMESTAMP_DOWNSTREAM_IAF_MAX               1999

/* 3000-3999 are for downstream events in the sender */
#define AP_TIMESTAMP_DOWNSTREAM_SENDER_MIN      3000
#define AP_TIMESTAMP_DOWNSTREAM_SENDER_MAX      3999

/* 5000-5999 are for downstream events in the correlator */
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_MIN                 5000
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_INPUT_MIN           5000
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_INPUT_MAX           5099
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_SERVICE_MONITOR_MIN 5100
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_SERVICE_MONITOR_MAX 5299
/* Reserved for internal Apama framework use */
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_RESERVED1_MIN       5300
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_RESERVED1_MAX       5499
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_RESERVED2_MIN       5500
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_RESERVED2_MAX       5699
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_APPLICATION_MIN     5700
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_APPLICATION_MAX     5899
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_OUTPUT_MIN          5900
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_OUTPUT_MAX          5999
#define AP_TIMESTAMP_DOWNSTREAM_CORRELATOR_MAX                 5999

/* 7000-7999 are for downstream events in the merger */
#define AP_TIMESTAMP_DOWNSTREAM_MERGER_MIN     7000
#define AP_TIMESTAMP_DOWNSTREAM_MERGE_MAX      7999

/* 9000-9999 are for downstream events in an external receiver client */
#define AP_TIMESTAMP_DOWNSTREAM_CLIENT_MIN      9000
#define AP_TIMESTAMP_DOWNSTREAM_CLIENT_MAX      9999

/*
 * Upstream (outgoing from correlator) timestamp IDs
 */

/* 11000-11999 are for upstream events in an external sender client */
#define AP_TIMESTAMP_UPSTREAM_CLIENT_MIN      11000
#define AP_TIMESTAMP_UPSTREAM_CLIENT_MAX      11999

/* 13000-13999 are for upstream events in the sender */
#define AP_TIMESTAMP_UPSTREAM_SENDER_MIN      13000
#define AP_TIMESTAMP_UPSTREAM_SENDER_MAX      13999

/* 15000-15999 are for upstream events in the correlator */
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_MIN                   15000
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_INPUT_MIN             15000
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_INPUT_MAX             15099
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_APPLICATION_MIN       15100
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_APPLICATION_MAX       15299
/* Reserved for internal Apama framework use */
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_RESERVED2_MIN         15300
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_RESERVED2_MAX         15499
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_RESERVED1_MIN         15500
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_RESERVED1_MAX         15699
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_SERVICE_MONITOR_MIN   15700
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_SERVICE_MONITOR_MAX   15899
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_OUTPUT_MIN            15900
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_OUTPUT_MAX            15999
#define AP_TIMESTAMP_UPSTREAM_CORRELATOR_MAX                   15999

/* 17000-17999 are for upstream events in the merger */
#define AP_TIMESTAMP_UPSTREAM_MERGER_MIN      17000
#define AP_TIMESTAMP_UPSTREAM_MERGER_MAX      17999

/* 19000-19999 are for upstream events in the IAF */
#define AP_TIMESTAMP_UPSTREAM_IAF_MIN               19000

#define AP_TIMESTAMP_UPSTREAM_IAF_APAMA_ENTRY       19000

#define AP_TIMESTAMP_UPSTREAM_IAF_APAMA_EXIT        19249

#define AP_TIMESTAMP_UPSTREAM_IAF_MAPPER_ENTRY      19250

#define AP_TIMESTAMP_UPSTREAM_IAF_MAPPER_EXIT       19499

#define AP_TIMESTAMP_UPSTREAM_IAF_ENCODER_ENTRY     19500

#define AP_TIMESTAMP_UPSTREAM_IAF_ENCODER_EXIT      19749

#define AP_TIMESTAMP_UPSTREAM_IAF_TRANSPORT_ENTRY   19750

#define AP_TIMESTAMP_UPSTREAM_IAF_TRANSPORT_EXIT    19999

#define AP_TIMESTAMP_UPSTREAM_IAF_MAX               19999


struct AP_TimestampSet;

typedef AP_uint64 AP_TimestampSetIndex;


typedef double AP_TimestampSetTime;


struct AP_TimestampSet_Functions 
{
        void (*addNow)(struct AP_TimestampSet* timestamp, AP_TimestampSetIndex index);

        void (*addTime)(struct AP_TimestampSet* timestamp, AP_TimestampSetIndex index, AP_TimestampSetTime time);

        void (*replace)(struct AP_TimestampSet* timestamp, AP_TimestampSetIndex index, AP_TimestampSetTime newTime);

        void (*replaceWithNow)(struct AP_TimestampSet* timestamp, AP_TimestampSetIndex index);

        AP_TimestampSetTime (*findTime)(struct AP_TimestampSet* timestamp, AP_TimestampSetIndex index);

        AP_TimestampSetTime (*findTimeAndRemove)(struct AP_TimestampSet* timestamp, AP_TimestampSetIndex index);

        AP_bool (*getNextStampAndRemove)(struct AP_TimestampSet* timestamp, AP_TimestampSetIndex* retIndex, AP_TimestampSetTime* retTime);

        AP_uint32 (*getSize)(struct AP_TimestampSet* timestamp);

        AP_char8* (*toString)(struct AP_TimestampSet* timestamp);
};


struct AP_TimestampSet {

        void* reserved;

        struct AP_TimestampSet_Functions* functions;

};
typedef struct AP_TimestampSet AP_TimestampSet;


AP_COMMON_API AP_TimestampSet* AP_TimestampSet_ctor();


AP_COMMON_API AP_TimestampSet* AP_TimestampSet_copy(AP_TimestampSet* old);


AP_COMMON_API void AP_TimestampSet_dtor(AP_TimestampSet* timestamp);

AP_COMMON_API AP_TimestampSetTime AP_TimestampSet_getRelativeTime();

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

#endif /* __CTIMESTAMP_HA_INCLUDED__ */