1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-23 00:00:01 +01:00
VILLASnode/include/villas/nodes/websocket.hpp

136 lines
3.6 KiB
C++

/** Node type: WebSockets
*
* @file
* @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
* @copyright 2014-2021, Institute for Automation of Complex Power Systems, EONERC
* @license GNU General Public License (version 3)
*
* VILLASnode
*
* This program 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
* any later version.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************************/
#pragma once
#include <spdlog/fmt/ostr.h>
#include <villas/pool.hpp>
#include <villas/queue_signalled.h>
#include <villas/common.hpp>
#include <villas/buffer.hpp>
#include <villas/format.hpp>
#include <villas/node.hpp>
#include <villas/node/config.hpp>
/* Forward declaration */
struct lws;
namespace villas {
namespace node {
/* Forward declarations */
class NodeCompat;
#define DEFAULT_WEBSOCKET_QUEUE_LENGTH (DEFAULT_QUEUE_LENGTH * 64)
/** Internal data per websocket node */
struct websocket {
struct List destinations; /**< List of websocket servers connect to in client mode (struct websocket_destination). */
struct Pool pool;
struct CQueueSignalled queue; /**< For samples which are received from WebSockets */
};
struct websocket_destination {
char *uri;
struct lws_client_connect_info info;
};
/* Internal datastructures */
struct websocket_connection {
enum State {
DESTROYED,
INITIALIZED,
CONNECTING,
RECONNECTING,
ESTABLISHED,
SHUTDOWN,
ERROR
} state; /**< The current status of this connection. */
enum class Mode {
CLIENT,
SERVER,
} mode;
struct lws *wsi;
NodeCompat *node;
Format *formatter;
struct CQueue queue; /**< For samples which are sent to the Websocket */
struct websocket_destination *destination;
struct {
villas::Buffer *recv; /**< A buffer for reconstructing fragmented messages. */
villas::Buffer *send; /**< A buffer for constructing messages before calling lws_write() */
} buffers;
/** Custom formatter for spdlog */
template<typename OStream>
friend OStream &operator<<(OStream &os, const struct websocket_connection &c)
{
if (c.wsi) {
char name[128];
lws_get_peer_simple(c.wsi, name, sizeof(name));
os << "remote=" << name;
}
else if (c.mode == websocket_connection::Mode::CLIENT && c.destination != nullptr)
os << "dest=" << c.destination->info.address << ":" << c.destination->info.port;
if (c.node)
os << ", node=" << *c.node;
os << ", mode=" << (c.mode == websocket_connection::Mode::CLIENT ? "client" : "server");
return os;
}
};
int websocket_protocol_cb(struct lws *wsi, enum lws_callback_reasons reason, void *user, void *in, size_t len);
int websocket_type_start(SuperNode *sn);
int websocket_type_stop();
int websocket_parse(NodeCompat *n, json_t *j);
char * websocket_print(NodeCompat *n);
int websocket_start(NodeCompat *n);
int websocket_stop(NodeCompat *n);
int websocket_destroy(NodeCompat *n);
int websocket_poll_fds(NodeCompat *n, int fds[]);
int websocket_read(NodeCompat *n, struct Sample * const smps[], unsigned cnt);
int websocket_write(NodeCompat *n, struct Sample * const smps[], unsigned cnt);
} /* namespace node */
} /* namespace villas */