samplelog_intf.h

Go to the documentation of this file.

#pragma once
 
#include <adtfucom3/adtf_ucom3.h>
 
namespace adtf
{
namespace streaming
{
namespace ant
{

class ISampleLog : public ucom::ant::IObject
{
    protected:
        ~ISampleLog() = default;
    public:
        ADTF_IID(ISampleLog, "samplelog.ant.streaming.adtf.iid");
    public:
        typedef enum : uint8_t
        {
            MSLEE_SomethingEvent          = 0,
            MSLEE_CreateEvent             = 1,
            MSLEE_WriteEvent              = 2,
            MSLEE_ReadEvent               = 3,
            MSLEE_TransmitEvent           = 4,
            MSLEE_TransmitReceiveState    = 5,
            MSLEE_TransmitFinishedEvent   = 6,
            MSLEE_ReceiveEvent            = 7,
            MSLEE_ReceiveFinishedEvent    = 8,
            MSLEE_LogUserOffset           = 200
        } eSampleLogEntryEventID;

        typedef uint32_t tSampleLogEntryEventID;
        typedef uint64_t tSampleLogEntryCreatorID;
        typedef int32_t  tSampleLogEntryThreadID;
        typedef uint64_t tSampleLogEntryProcessID;

        typedef struct 
        {
            tSampleLogEntryCreatorID   ui64LogCreatorID;
            int32_t                          i32Counter;
        } tSampleLogSampleID;

        typedef struct
        {
            tSampleLogEntryEventID   ui32EventID;
            tSampleLogEntryCreatorID ui64LogCreatorID;
            tSampleLogEntryThreadID  i32ThreadID;
            tSampleLogEntryProcessID ui64ProcID;
            tTimeStamp                    tmEntryTime;
            const void*                  pAdditionalDataRef;
            size_t                         szAdditionalDataSize;
        } tSampleLogEntry;
 
        #pragma pack(push)
        #pragma pack(4)
        typedef struct
        {
            tSampleLogEntryCreatorID ui64LogCreatorID;
            tTimeStamp               tmEntryTime;
            tSampleLogSampleID       sSampleId;
            tSampleLogEntryEventID   ui32EventID;
        } tSampleLogTransmitReceiveState;
        #pragma pack(pop)

        class IGetLogEntryCallback
        {
            public:
                virtual tResult GetIt(const tSampleLogEntry& sLogEntry) = 0;
        };

        virtual tResult EnableLogging(const uint8_t& ui8Level) = 0;

        virtual tResult ClearLog() = 0;

        virtual tResult SetSampleID(const ISampleLog::tSampleLogSampleID& sSampleID) = 0;

        virtual ISampleLog::tSampleLogSampleID GetSampleID() const = 0;

        virtual tResult AddLogEntry(const ISampleLog::tSampleLogEntry& sLogEntry) = 0;

        virtual tResult GetLogEntries(ISampleLog::IGetLogEntryCallback& pGetCallback) const = 0;
};
 
 
 
} //namespace ant
} //namespace streaming
} // namespace adtf