help.h

Go to the documentation of this file.

// Copyright (c) 2024 anabrid GmbH
// Contact: https://www.anabrid.com/licensing/
//
// SPDX-License-Identifier: MIT OR GPL-2.0-or-later
 
#pragma once
 
#include "protocol/handler.h"
 
#include "protocol/registry.h"
 
namespace msg {
namespace handlers {
 
class HelpHandler : public MessageHandler {
public:
  utils::status replyWithObject(const Request& req, JsonObject &msg_out) override {
    msg_out["human_readable_info"] =
        "This is a JSON-Lines protocol described at https://anabrid.dev/docs/hybrid-controller/";
 
    auto types_list = msg_out.createNestedArray("available_types");
    msg::handlers::Registry::get().write_handler_names_to(types_list);
 
    return utils::status::success();
  }
};
 
} // namespace handlers
 
} // namespace msg