OVMS3/OVMS.V3/main/ovms_events.h

137 lines
3.8 KiB
C++

/*
; Project: Open Vehicle Monitor System
; Date: 14th March 2017
;
; Changes:
; 1.0 Initial release
;
; (C) 2011 Michael Stegen / Stegen Electronics
; (C) 2011-2017 Mark Webb-Johnson
; (C) 2011 Sonny Chen @ EPRO/DX
;
; Permission is hereby granted, free of charge, to any person obtaining a copy
; of this software and associated documentation files (the "Software"), to deal
; in the Software without restriction, including without limitation the rights
; to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
; copies of the Software, and to permit persons to whom the Software is
; furnished to do so, subject to the following conditions:
;
; The above copyright notice and this permission notice shall be included in
; all copies or substantial portions of the Software.
;
; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
; OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
; THE SOFTWARE.
*/
#ifndef __EVENT_H__
#define __EVENT_H__
#include <string>
#include <functional>
#include <map>
#include <list>
#include <esp_event.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/queue.h"
#include "freertos/timers.h"
#include "ovms_command.h"
#include "ovms_mutex.h"
typedef std::function<void(std::string,void*)> EventCallback;
class EventCallbackEntry
{
public:
EventCallbackEntry(std::string caller, EventCallback callback);
virtual ~EventCallbackEntry();
public:
std::string m_caller;
EventCallback m_callback;
};
typedef std::list<EventCallbackEntry*> EventCallbackList;
class EventMap : public std::map<std::string, EventCallbackList*>
{
public:
bool GetCompletion(OvmsWriter* writer, const char* token) const;
};
typedef void (*event_signal_done_fn)(const char* event, void* data);
extern void EventStdFree(const char* event, void* data);
typedef enum
{
EVENT_none = 0, // Do nothing
EVENT_signal // Raise a signal
} event_msg_t;
typedef struct
{
union
{
struct
{
char* event;
void* data;
event_signal_done_fn donefn;
} signal;
} body;
event_msg_t type;
} event_queue_t;
typedef std::list<TimerHandle_t> TimerList;
typedef std::map<TimerHandle_t, bool> TimerStatusMap;
class OvmsEvents
{
public:
OvmsEvents();
~OvmsEvents();
public:
void RegisterEvent(std::string caller, std::string event, EventCallback callback);
void DeregisterEvent(std::string caller);
void SignalEvent(std::string event, void* data, event_signal_done_fn callback = NULL, uint32_t delay_ms = 0);
void SignalEvent(std::string event, void* data, size_t length, uint32_t delay_ms = 0);
public:
void EventTask();
void HandleQueueSignalEvent(event_queue_t* msg);
void FreeQueueSignalEvent(event_queue_t* msg);
static esp_err_t ReceiveSystemEvent(void *ctx, system_event_t *event);
void SignalSystemEvent(system_event_t *event);
const EventMap& Map() { return m_map; }
protected:
bool ScheduleEvent(event_queue_t* msg, uint32_t delay_ms);
static void SignalScheduledEvent(TimerHandle_t timer);
protected:
EventMap m_map;
TimerList m_timers;
TimerStatusMap m_timer_active;
OvmsMutex m_timers_mutex;
public:
bool m_trace;
TaskHandle_t m_taskid;
QueueHandle_t m_taskqueue;
public:
EventCallbackEntry* m_current_callback;
std::string m_current_event;
uint32_t m_current_started;
};
extern OvmsEvents MyEvents;
#endif //#ifndef __EVENT_H__