en/latest/parent__handler_8hpp_source.html

 #ifndef _PARENT_HANDLER_HPP
 #define _PARENT_HANDLER_HPP

 #include "event_handler_util.hpp"

 #include <stdarg.h>
 #include <stdint.h>
 #include <string.h>

 #include "frozen.h"
 #include "mgos.h"
 #include "mgos_mqtt.h"

 class ParentHandler {
  public:
   ParentHandler(void);
   virtual ~ParentHandler(void) {}
   virtual HandlerError handleRequest(struct mg_connection* mgCon,
                                      struct mg_str*        message,
                                      char*                 commandName,
                                      char*                 response)   = 0;
   virtual HandlerError handleReport(char* stateReport) = 0;

   HandlerError createReport(char* report, const char* fmt, uint8_t totalArg, ...);

   bool  canHandleRequest(char* requestNameSpace);
   char* getNameSpace(void);

  protected:
   char _nameSpace[MAX_NAMESPACE_LEN];
 };

 #endif

ParentHandler::canHandleRequest
bool canHandleRequest(char *requestNameSpace)
used to check if a handler object can handle a request with a specific namespace
Definition: parent_handler.cpp:71

ParentHandler::getNameSpace
char * getNameSpace(void)
return the command namespace that the handler support
Definition: parent_handler.cpp:80

event_handler_util.hpp
header file for event handler utils

ParentHandler::_nameSpace
char _nameSpace[MAX_NAMESPACE_LEN]
namespace that the handler supports, all child classes must initialize this variable to let the maste...
Definition: parent_handler.hpp:51

ParentHandler::createReport
HandlerError createReport(char *report, const char *fmt, uint8_t totalArg,...)
used for generating a json report string based on the format given, usually child handler uses this t...
Definition: parent_handler.cpp:43

MAX_NAMESPACE_LEN
#define MAX_NAMESPACE_LEN
maximum length in characters of the namespace name sent by the server
Definition: event_handler_util.hpp:31

HandlerError
HandlerError
enum defining errors that the system(including master handler and other child handler) may have ...
Definition: event_handler_util.hpp:37

ParentHandler
the parent handler class that is the blueprint for other child handlers to implement, it also defines a couple functions that child handler can use
Definition: parent_handler.hpp:31