2025-01-14 14:42:39 +00:00
|
|
|
/* API session.
|
2017-04-09 16:22:03 +02:00
|
|
|
*
|
2025-01-14 14:42:39 +00:00
|
|
|
* Author: Steffen Vogel <post@steffenvogel.de>
|
|
|
|
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
|
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
|
|
*/
|
2017-04-09 16:22:03 +02:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <jansson.h>
|
|
|
|
|
2018-10-20 14:20:06 +02:00
|
|
|
#include <villas/api.hpp>
|
2025-01-14 14:42:39 +00:00
|
|
|
#include <villas/buffer.hpp>
|
|
|
|
#include <villas/queue.h>
|
2017-04-09 16:22:03 +02:00
|
|
|
|
2018-10-20 14:20:06 +02:00
|
|
|
namespace villas {
|
|
|
|
namespace node {
|
2018-06-28 13:42:50 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
// Forward declarations
|
2018-10-20 14:20:06 +02:00
|
|
|
class SuperNode;
|
|
|
|
class Api;
|
2020-08-17 17:03:54 +02:00
|
|
|
class Web;
|
2017-04-09 16:22:03 +02:00
|
|
|
|
2018-10-20 14:20:06 +02:00
|
|
|
namespace api {
|
2017-04-09 16:22:03 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
// Forward declarations
|
2020-08-17 17:03:54 +02:00
|
|
|
class Request;
|
|
|
|
class Response;
|
2020-10-16 11:43:24 +02:00
|
|
|
class StatusRequest;
|
2021-02-16 14:15:14 +01:00
|
|
|
class RequestFactory;
|
2020-08-17 17:03:54 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
// A connection via HTTP REST or WebSockets to issue API requests.
|
2018-10-20 14:20:06 +02:00
|
|
|
class Session {
|
|
|
|
|
|
|
|
public:
|
2025-01-14 14:42:39 +00:00
|
|
|
friend Request; // Requires access to wsi for getting URL args and headers
|
|
|
|
friend StatusRequest; // Requires access to wsi for context status
|
|
|
|
friend RequestFactory;
|
|
|
|
|
|
|
|
enum State { ESTABLISHED, SHUTDOWN };
|
|
|
|
|
|
|
|
enum Version { UNKNOWN_VERSION = 0, VERSION_1 = 1, VERSION_2 = 2 };
|
|
|
|
|
|
|
|
enum Method { UNKNOWN, GET, POST, DELETE, OPTIONS, PUT, PATCH };
|
2020-09-30 17:56:12 +02:00
|
|
|
|
2018-10-20 14:20:06 +02:00
|
|
|
protected:
|
2025-01-14 14:42:39 +00:00
|
|
|
enum State state;
|
|
|
|
enum Version version;
|
2017-08-27 17:04:25 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
lws *wsi;
|
2017-05-05 19:24:16 +00:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
Web *web;
|
|
|
|
Api *api;
|
2017-12-09 02:19:28 +08:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
Logger logger;
|
2018-10-20 14:20:06 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
std::unique_ptr<Request> request;
|
|
|
|
std::unique_ptr<Response> response;
|
2017-04-09 16:22:03 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
bool headersSent;
|
2017-04-09 16:22:03 +02:00
|
|
|
|
2020-08-17 17:03:54 +02:00
|
|
|
public:
|
2025-01-14 14:42:39 +00:00
|
|
|
Session(struct lws *w);
|
|
|
|
~Session();
|
2020-08-17 17:03:54 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
std::string getName() const;
|
2017-08-27 17:59:59 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
SuperNode *getSuperNode() const { return api->getSuperNode(); }
|
2018-10-20 14:20:06 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
void open(void *in, size_t len);
|
|
|
|
int writeable();
|
|
|
|
void body(void *in, size_t len);
|
|
|
|
void bodyComplete();
|
|
|
|
void execute();
|
|
|
|
void shutdown();
|
2020-08-17 17:03:54 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
static int protocolCallback(struct lws *wsi, enum lws_callback_reasons reason,
|
|
|
|
void *user, void *in, size_t len);
|
2020-08-17 17:03:54 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
Method getRequestMethod() const;
|
2020-08-17 17:03:54 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
static std::string methodToString(Method meth);
|
2018-10-20 14:20:06 +02:00
|
|
|
};
|
2018-06-28 13:42:50 +02:00
|
|
|
|
2025-01-14 14:42:39 +00:00
|
|
|
} // namespace api
|
|
|
|
} // namespace node
|
|
|
|
} // namespace villas
|