Files
OpenDTU/include/MessageOutput.h
2025-08-19 18:53:08 +02:00

76 lines
2.7 KiB
C++

// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <AsyncWebSocket.h>
#include <TaskSchedulerDeclarations.h>
#include <Print.h>
#include <freertos/task.h>
#include <mutex>
#include <vector>
#include <unordered_map>
#include <queue>
#include <memory>
class MessageOutputClass {
public:
MessageOutputClass();
void init(Scheduler& scheduler);
void register_ws_output(AsyncWebSocket* output);
static int log_vprintf(const char *fmt, va_list arguments);
private:
void loop();
Task _loopTask;
static constexpr size_t BUFFER_SIZE = 8192;
char _buffer[BUFFER_SIZE];
size_t _buffer_in = 0;
size_t _buffer_out = 0;
using message_t = std::vector<uint8_t>;
// we keep a buffer for every task and only write complete lines to the
// serial output and then move them to be pushed through the websocket.
// this way we prevent mangling of messages from different contexts.
std::unordered_map<TaskHandle_t, message_t> _task_messages;
std::queue<message_t> _lines;
// we chunk the websocket output to circumvent issues with TCP delayed ACKs:
// if the websocket client (Windows in particular) is using delayed ACKs,
// and since we wait for an ACK before sending the next chunk, we will
// accumulate way too many messages and we won't be able to send them out
// fast enough as the rate of produced messages is higher than the rate of
// ACKs received. by chunking and waiting in between chunks, we either
// "motivate" the client to send out ACKs immediately as the TCP packets are
// "large", or we will wait long enough for the TCP stack to send out the
// ACK anyways.
void send_ws_chunk(const uint8_t* buffer, size_t size);
static constexpr size_t WS_CHUNK_SIZE_BYTES = 512;
static constexpr uint32_t WS_CHUNK_INTERVAL_MS = 250;
static constexpr size_t TYPICAL_LINE_LENGTH = 150;
std::shared_ptr<message_t> _ws_chunk = nullptr;
uint32_t _last_ws_chunk_sent = 0;
AsyncWebSocket* _ws = nullptr;
std::mutex _msgLock;
void serialWrite(const uint8_t* buffer, size_t size);
static constexpr uint32_t RATE_LIMIT_WINDOW_MS = 1000;
static constexpr size_t RATE_LIMIT_MAX_TOKENS = 128;
size_t _available_tokens = RATE_LIMIT_MAX_TOKENS;
uint32_t _last_token_refill_millis = 0;
size_t _rate_limited_packets = 0;
uint32_t _last_rate_limit_warning_millis = 0;
static constexpr uint32_t RATE_LIMIT_WARNING_INTERVAL_MS = 1000;
bool consumeToken();
int log_self(const char* fmt, ...);
int log_vprintf_rate_limited(const char* fmt, va_list arguments);
int log_vprintf_recursive(const char* fmt, va_list arguments);
};
extern MessageOutputClass MessageOutput;