mirror of
https://github.com/emsesp/EMS-ESP32.git
synced 2025-12-07 08:19:52 +03:00
initial commit
This commit is contained in:
proddy
272
lib/framework/WebSocketTxRx.h
Normal file
272
lib/framework/WebSocketTxRx.h
Normal file
@@ -0,0 +1,272 @@
|
||||
#ifndef WebSocketTxRx_h
|
||||
#define WebSocketTxRx_h
|
||||
|
||||
#include <StatefulService.h>
|
||||
#include <ESPAsyncWebServer.h>
|
||||
|
||||
#define WEB_SOCKET_CLIENT_ID_MSG_SIZE 128
|
||||
|
||||
#define WEB_SOCKET_ORIGIN "websocket"
|
||||
#define WEB_SOCKET_ORIGIN_CLIENT_ID_PREFIX "websocket:"
|
||||
|
||||
template <class T>
|
||||
class WebSocketConnector {
|
||||
protected:
|
||||
StatefulService<T>* _statefulService;
|
||||
AsyncWebServer* _server;
|
||||
AsyncWebSocket _webSocket;
|
||||
size_t _bufferSize;
|
||||
|
||||
WebSocketConnector(StatefulService<T>* statefulService,
|
||||
AsyncWebServer* server,
|
||||
char const* webSocketPath,
|
||||
SecurityManager* securityManager,
|
||||
AuthenticationPredicate authenticationPredicate,
|
||||
size_t bufferSize) :
|
||||
_statefulService(statefulService), _server(server), _webSocket(webSocketPath), _bufferSize(bufferSize) {
|
||||
_webSocket.setFilter(securityManager->filterRequest(authenticationPredicate));
|
||||
_webSocket.onEvent(std::bind(&WebSocketConnector::onWSEvent,
|
||||
this,
|
||||
std::placeholders::_1,
|
||||
std::placeholders::_2,
|
||||
std::placeholders::_3,
|
||||
std::placeholders::_4,
|
||||
std::placeholders::_5,
|
||||
std::placeholders::_6));
|
||||
_server->addHandler(&_webSocket);
|
||||
_server->on(webSocketPath, HTTP_GET, std::bind(&WebSocketConnector::forbidden, this, std::placeholders::_1));
|
||||
}
|
||||
|
||||
WebSocketConnector(StatefulService<T>* statefulService,
|
||||
AsyncWebServer* server,
|
||||
char const* webSocketPath,
|
||||
size_t bufferSize) :
|
||||
_statefulService(statefulService), _server(server), _webSocket(webSocketPath), _bufferSize(bufferSize) {
|
||||
_webSocket.onEvent(std::bind(&WebSocketConnector::onWSEvent,
|
||||
this,
|
||||
std::placeholders::_1,
|
||||
std::placeholders::_2,
|
||||
std::placeholders::_3,
|
||||
std::placeholders::_4,
|
||||
std::placeholders::_5,
|
||||
std::placeholders::_6));
|
||||
_server->addHandler(&_webSocket);
|
||||
}
|
||||
|
||||
virtual void onWSEvent(AsyncWebSocket* server,
|
||||
AsyncWebSocketClient* client,
|
||||
AwsEventType type,
|
||||
void* arg,
|
||||
uint8_t* data,
|
||||
size_t len) = 0;
|
||||
|
||||
String clientId(AsyncWebSocketClient* client) {
|
||||
return WEB_SOCKET_ORIGIN_CLIENT_ID_PREFIX + String(client->id());
|
||||
}
|
||||
|
||||
private:
|
||||
void forbidden(AsyncWebServerRequest* request) {
|
||||
request->send(403);
|
||||
}
|
||||
};
|
||||
|
||||
template <class T>
|
||||
class WebSocketTx : virtual public WebSocketConnector<T> {
|
||||
public:
|
||||
WebSocketTx(JsonStateReader<T> stateReader,
|
||||
StatefulService<T>* statefulService,
|
||||
AsyncWebServer* server,
|
||||
char const* webSocketPath,
|
||||
SecurityManager* securityManager,
|
||||
AuthenticationPredicate authenticationPredicate = AuthenticationPredicates::IS_ADMIN,
|
||||
size_t bufferSize = DEFAULT_BUFFER_SIZE) :
|
||||
WebSocketConnector<T>(statefulService,
|
||||
server,
|
||||
webSocketPath,
|
||||
securityManager,
|
||||
authenticationPredicate,
|
||||
bufferSize),
|
||||
_stateReader(stateReader) {
|
||||
WebSocketConnector<T>::_statefulService->addUpdateHandler(
|
||||
[&](const String& originId) { transmitData(nullptr, originId); }, false);
|
||||
}
|
||||
|
||||
WebSocketTx(JsonStateReader<T> stateReader,
|
||||
StatefulService<T>* statefulService,
|
||||
AsyncWebServer* server,
|
||||
char const* webSocketPath,
|
||||
size_t bufferSize = DEFAULT_BUFFER_SIZE) :
|
||||
WebSocketConnector<T>(statefulService, server, webSocketPath, bufferSize), _stateReader(stateReader) {
|
||||
WebSocketConnector<T>::_statefulService->addUpdateHandler(
|
||||
[&](const String& originId) { transmitData(nullptr, originId); }, false);
|
||||
}
|
||||
|
||||
protected:
|
||||
virtual void onWSEvent(AsyncWebSocket* server,
|
||||
AsyncWebSocketClient* client,
|
||||
AwsEventType type,
|
||||
void* arg,
|
||||
uint8_t* data,
|
||||
size_t len) {
|
||||
if (type == WS_EVT_CONNECT) {
|
||||
// when a client connects, we transmit it's id and the current payload
|
||||
transmitId(client);
|
||||
transmitData(client, WEB_SOCKET_ORIGIN);
|
||||
}
|
||||
}
|
||||
|
||||
private:
|
||||
JsonStateReader<T> _stateReader;
|
||||
|
||||
void transmitId(AsyncWebSocketClient* client) {
|
||||
DynamicJsonDocument jsonDocument = DynamicJsonDocument(WEB_SOCKET_CLIENT_ID_MSG_SIZE);
|
||||
JsonObject root = jsonDocument.to<JsonObject>();
|
||||
root["type"] = "id";
|
||||
root["id"] = WebSocketConnector<T>::clientId(client);
|
||||
size_t len = measureJson(jsonDocument);
|
||||
AsyncWebSocketMessageBuffer* buffer = WebSocketConnector<T>::_webSocket.makeBuffer(len);
|
||||
if (buffer) {
|
||||
serializeJson(jsonDocument, (char*)buffer->get(), len + 1);
|
||||
client->text(buffer);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Broadcasts the payload to the destination, if provided. Otherwise broadcasts to all clients except the origin, if
|
||||
* specified.
|
||||
*
|
||||
* Original implementation sent clients their own IDs so they could ignore updates they initiated. This approach
|
||||
* simplifies the client and the server implementation but may not be sufficent for all use-cases.
|
||||
*/
|
||||
void transmitData(AsyncWebSocketClient* client, const String& originId) {
|
||||
DynamicJsonDocument jsonDocument = DynamicJsonDocument(WebSocketConnector<T>::_bufferSize);
|
||||
JsonObject root = jsonDocument.to<JsonObject>();
|
||||
root["type"] = "payload";
|
||||
root["origin_id"] = originId;
|
||||
JsonObject payload = root.createNestedObject("payload");
|
||||
WebSocketConnector<T>::_statefulService->read(payload, _stateReader);
|
||||
|
||||
size_t len = measureJson(jsonDocument);
|
||||
AsyncWebSocketMessageBuffer* buffer = WebSocketConnector<T>::_webSocket.makeBuffer(len);
|
||||
if (buffer) {
|
||||
serializeJson(jsonDocument, (char*)buffer->get(), len + 1);
|
||||
if (client) {
|
||||
client->text(buffer);
|
||||
} else {
|
||||
WebSocketConnector<T>::_webSocket.textAll(buffer);
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
template <class T>
|
||||
class WebSocketRx : virtual public WebSocketConnector<T> {
|
||||
public:
|
||||
WebSocketRx(JsonStateUpdater<T> stateUpdater,
|
||||
StatefulService<T>* statefulService,
|
||||
AsyncWebServer* server,
|
||||
char const* webSocketPath,
|
||||
SecurityManager* securityManager,
|
||||
AuthenticationPredicate authenticationPredicate = AuthenticationPredicates::IS_ADMIN,
|
||||
size_t bufferSize = DEFAULT_BUFFER_SIZE) :
|
||||
WebSocketConnector<T>(statefulService,
|
||||
server,
|
||||
webSocketPath,
|
||||
securityManager,
|
||||
authenticationPredicate,
|
||||
bufferSize),
|
||||
_stateUpdater(stateUpdater) {
|
||||
}
|
||||
|
||||
WebSocketRx(JsonStateUpdater<T> stateUpdater,
|
||||
StatefulService<T>* statefulService,
|
||||
AsyncWebServer* server,
|
||||
char const* webSocketPath,
|
||||
size_t bufferSize = DEFAULT_BUFFER_SIZE) :
|
||||
WebSocketConnector<T>(statefulService, server, webSocketPath, bufferSize), _stateUpdater(stateUpdater) {
|
||||
}
|
||||
|
||||
protected:
|
||||
virtual void onWSEvent(AsyncWebSocket* server,
|
||||
AsyncWebSocketClient* client,
|
||||
AwsEventType type,
|
||||
void* arg,
|
||||
uint8_t* data,
|
||||
size_t len) {
|
||||
if (type == WS_EVT_DATA) {
|
||||
AwsFrameInfo* info = (AwsFrameInfo*)arg;
|
||||
if (info->final && info->index == 0 && info->len == len) {
|
||||
if (info->opcode == WS_TEXT) {
|
||||
DynamicJsonDocument jsonDocument = DynamicJsonDocument(WebSocketConnector<T>::_bufferSize);
|
||||
DeserializationError error = deserializeJson(jsonDocument, (char*)data);
|
||||
if (!error && jsonDocument.is<JsonObject>()) {
|
||||
JsonObject jsonObject = jsonDocument.as<JsonObject>();
|
||||
WebSocketConnector<T>::_statefulService->update(
|
||||
jsonObject, _stateUpdater, WebSocketConnector<T>::clientId(client));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private:
|
||||
JsonStateUpdater<T> _stateUpdater;
|
||||
};
|
||||
|
||||
template <class T>
|
||||
class WebSocketTxRx : public WebSocketTx<T>, public WebSocketRx<T> {
|
||||
public:
|
||||
WebSocketTxRx(JsonStateReader<T> stateReader,
|
||||
JsonStateUpdater<T> stateUpdater,
|
||||
StatefulService<T>* statefulService,
|
||||
AsyncWebServer* server,
|
||||
char const* webSocketPath,
|
||||
SecurityManager* securityManager,
|
||||
AuthenticationPredicate authenticationPredicate = AuthenticationPredicates::IS_ADMIN,
|
||||
size_t bufferSize = DEFAULT_BUFFER_SIZE) :
|
||||
WebSocketConnector<T>(statefulService,
|
||||
server,
|
||||
webSocketPath,
|
||||
securityManager,
|
||||
authenticationPredicate,
|
||||
bufferSize),
|
||||
WebSocketTx<T>(stateReader,
|
||||
statefulService,
|
||||
server,
|
||||
webSocketPath,
|
||||
securityManager,
|
||||
authenticationPredicate,
|
||||
bufferSize),
|
||||
WebSocketRx<T>(stateUpdater,
|
||||
statefulService,
|
||||
server,
|
||||
webSocketPath,
|
||||
securityManager,
|
||||
authenticationPredicate,
|
||||
bufferSize) {
|
||||
}
|
||||
|
||||
WebSocketTxRx(JsonStateReader<T> stateReader,
|
||||
JsonStateUpdater<T> stateUpdater,
|
||||
StatefulService<T>* statefulService,
|
||||
AsyncWebServer* server,
|
||||
char const* webSocketPath,
|
||||
size_t bufferSize = DEFAULT_BUFFER_SIZE) :
|
||||
WebSocketConnector<T>(statefulService, server, webSocketPath, bufferSize),
|
||||
WebSocketTx<T>(stateReader, statefulService, server, webSocketPath, bufferSize),
|
||||
WebSocketRx<T>(stateUpdater, statefulService, server, webSocketPath, bufferSize) {
|
||||
}
|
||||
|
||||
protected:
|
||||
void onWSEvent(AsyncWebSocket* server,
|
||||
AsyncWebSocketClient* client,
|
||||
AwsEventType type,
|
||||
void* arg,
|
||||
uint8_t* data,
|
||||
size_t len) {
|
||||
WebSocketRx<T>::onWSEvent(server, client, type, arg, data, len);
|
||||
WebSocketTx<T>::onWSEvent(server, client, type, arg, data, len);
|
||||
}
|
||||
};
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user