/* Asynchronous WebServer library for Espressif MCUs Copyright (c) 2016 Hristo Gochkov. All rights reserved. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef ASYNCEVENTSOURCE_H_ #define ASYNCEVENTSOURCE_H_ #include #include #ifdef ESP32 #include #include #ifndef SSE_MAX_QUEUED_MESSAGES #define SSE_MAX_QUEUED_MESSAGES 32 #endif #elif defined(ESP8266) #include #ifndef SSE_MAX_QUEUED_MESSAGES #define SSE_MAX_QUEUED_MESSAGES 8 #endif #elif defined(TARGET_RP2040) #include #ifndef SSE_MAX_QUEUED_MESSAGES #define SSE_MAX_QUEUED_MESSAGES 32 #endif #endif #include #ifdef ESP8266 #include #ifdef CRYPTO_HASH_h // include Hash.h from espressif framework if the first include was from the crypto library #include <../src/Hash.h> #endif #endif class AsyncEventSource; class AsyncEventSourceResponse; class AsyncEventSourceClient; using ArEventHandlerFunction = std::function; using ArAuthorizeConnectHandler = std::function; class AsyncEventSourceMessage { private: uint8_t* _data; size_t _len; size_t _sent; // size_t _ack; size_t _acked; public: AsyncEventSourceMessage(const char* data, size_t len); ~AsyncEventSourceMessage(); size_t ack(size_t len, uint32_t time = 0); size_t write(AsyncClient* client); size_t send(AsyncClient* client); bool finished() { return _acked == _len; } bool sent() { return _sent == _len; } }; class AsyncEventSourceClient { private: AsyncClient* _client; AsyncEventSource* _server; uint32_t _lastId; std::list _messageQueue; #ifdef ESP32 mutable std::mutex _lockmq; #endif void _queueMessage(const char* message, size_t len); void _runQueue(); public: AsyncEventSourceClient(AsyncWebServerRequest* request, AsyncEventSource* server); ~AsyncEventSourceClient(); AsyncClient* client() { return _client; } void close(); void write(const char* message, size_t len); void send(const String& message, const String& event, uint32_t id = 0, uint32_t reconnect = 0) { send(message.c_str(), event.c_str(), id, reconnect); } void send(const String& message, const char* event, uint32_t id = 0, uint32_t reconnect = 0) { send(message.c_str(), event, id, reconnect); } void send(const char* message, const char* event = NULL, uint32_t id = 0, uint32_t reconnect = 0); bool connected() const { return (_client != NULL) && _client->connected(); } uint32_t lastId() const { return _lastId; } size_t packetsWaiting() const; // system callbacks (do not call) void _onAck(size_t len, uint32_t time); void _onPoll(); void _onTimeout(uint32_t time); void _onDisconnect(); }; class AsyncEventSource : public AsyncWebHandler { private: String _url; std::list> _clients; #ifdef ESP32 // Same as for individual messages, protect mutations of _clients list // since simultaneous access from different tasks is possible mutable std::mutex _client_queue_lock; #endif ArEventHandlerFunction _connectcb{nullptr}; ArAuthorizeConnectHandler _authorizeConnectHandler; public: AsyncEventSource(const String& url) : _url(url) {}; ~AsyncEventSource() { close(); }; const char* url() const { return _url.c_str(); } void close(); void onConnect(ArEventHandlerFunction cb); void authorizeConnect(ArAuthorizeConnectHandler cb); void send(const String& message, const String& event, uint32_t id = 0, uint32_t reconnect = 0) { send(message.c_str(), event.c_str(), id, reconnect); } void send(const String& message, const char* event, uint32_t id = 0, uint32_t reconnect = 0) { send(message.c_str(), event, id, reconnect); } void send(const char* message, const char* event = NULL, uint32_t id = 0, uint32_t reconnect = 0); // number of clients connected size_t count() const; size_t avgPacketsWaiting() const; // system callbacks (do not call) void _addClient(AsyncEventSourceClient* client); void _handleDisconnect(AsyncEventSourceClient* client); virtual bool canHandle(AsyncWebServerRequest* request) override final; virtual void handleRequest(AsyncWebServerRequest* request) override final; }; class AsyncEventSourceResponse : public AsyncWebServerResponse { private: String _content; AsyncEventSource* _server; public: AsyncEventSourceResponse(AsyncEventSource* server); void _respond(AsyncWebServerRequest* request); size_t _ack(AsyncWebServerRequest* request, size_t len, uint32_t time); bool _sourceValid() const { return true; } }; #endif /* ASYNCEVENTSOURCE_H_ */