ProfilerEvent.h

/*******************************************************************************
 * BSD 3-Clause License
 *
 * Copyright (c) 2016-2025, Mech-Mind Robotics
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Info:  https://www.mech-mind.com/
 *
 ******************************************************************************/
 
#pragma once
#include <functional>
#include "profiler/Profiler.h"
 
namespace mmind {
 
namespace eye {
 
class MMIND_API_EXPORT ProfilerEvent
{
public:
    enum Event {
        PROFILER_EVENT_DISCONNECTED = 0x0001, 
        PROFILER_EVENT_ALL = 0xFFFF,          
    };
 
    using EventCallback = std::function<void(Event event, void* pUser)>;
 
    [[deprecated(
        "Please use @ref registerProfilerEventCallback(Profiler& profiler, Event event, const "
        "ProfilerEventCallback& callback) instead.")]] static ErrorStatus
    registerProfilerEventCallback(Profiler& profiler, EventCallback callback, void* pUser,
                                  unsigned int events);
 
    struct EventInfo
    {
        std::string eventName{};  
        uint16_t eventId{0x0000}; 
 
        EventInfo() = default;
        EventInfo(const std::string& eventName, uint16_t eventId)
            : eventName(eventName), eventId(eventId)
        {
        }
    };
 
    static ErrorStatus getSupportedEvents(const Profiler& profiler,
                                          std::vector<EventInfo>& eventInfos);
 
    struct EventData
    {
        int eventId{0};          
        std::string eventName{}; 
        int64_t timestamp{0};    
    };
 
    struct PayloadMember
    {
        std::string name; 
        enum class Type {
            _UInt32,
            _Int32,
            _Int64,
            _Float,
            _Double,
            _Bool,
            _String,
        };
        Type type; 
        struct MemberValue
        {
            uint32_t uint32Value;
            int32_t int32Value;
            int64_t int64Value;
            float floatValue;
            double doubleValue;
            bool boolValue;
            std::string stringValue;
        };
        MemberValue value; 
    };
 
    using Payload = std::vector<PayloadMember>;
 
    using ProfilerEventCallback =
        std::function<void(const EventData* eventData, const void* extraPayload)>;
 
    static ErrorStatus registerProfilerEventCallback(Profiler& profiler, uint16_t event,
                                                     const ProfilerEventCallback& callback);
 
    static ErrorStatus unregisterProfilerEventCallback(Profiler& profiler, uint16_t event);
};
 
} // namespace eye
 
} // namespace mmind