IPCRequestHandler.hpp

/*
 * Copyright (C) 2016 - 2023 Mikhail Sapozhnikov
 *
 * This file is part of ship-control.
 *
 * ship-control is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * ship-control is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with ship-control.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef IPCREQUESTHANDLER_HPP
#define IPCREQUESTHANDLER_HPP

#include "InputQueue.hpp"
#include "DataProvider.hpp"
#include <string>

namespace shipcontrol
{

/*
 * IPC request format:
 * JSON
 * {
 *     "type": "cmd" or "query",
 *     "cmd" (in case of cmd type): one of "speed_up", "speed_down", "turn_left", "turn_right", "set_speed", "set_steering"
 *     "data" (optional): target speed or target steering in case of "set_speed" or "set_steering" command
 * }
 *
 * IPC command response format:
 * JSON
 * {
 *     "status": "ok" or "fail",
 *     "error": "<error_message>" in case of status=fail
 * }
 * This is sent in case of failed query as well
 *
 * IPC query response format:
 * JSON
 * {
 *     "speed": "<value>",
 *     "steering": "<value>"
 * }
 */

class IPCRequestHandler
{
public:
    IPCRequestHandler(InputQueue &queue, DataProvider &provider);
    std::string handleRequest(const std::string &request);
protected:
    std::string handle_cmd(const std::string &cmd, const std::string &data);
    std::string handle_query();

    InputQueue &_input_queue;
    DataProvider &_data_provider;
};

} // namespace shipcontrol

#endif // IPCREQUESTHANDLER_HPP