some autogen docs

This commit is contained in:
2025-08-14 14:07:52 +03:00
parent d95944dcfc
commit 04152f05a9
7 changed files with 261 additions and 7 deletions

View File

@@ -33,6 +33,8 @@ namespace PIClientServer {
// ServerClient
//! ~english Server-side client implementation
//! ~russian Серверная реализация клиента
class PIP_CLIENT_SERVER_EXPORT ServerClient: public ClientBase {
friend class Server;
NO_COPY_CLASS(ServerClient);
@@ -41,6 +43,8 @@ public:
ServerClient() {}
protected:
//! ~english Called before client destruction
//! ~russian Вызывается перед уничтожением клиента
virtual void aboutDelete() {}
private:
@@ -50,6 +54,8 @@ private:
// Client
//! ~english Client implementation for connecting to servers
//! ~russian Клиентская реализация для подключения к серверам
class PIP_CLIENT_SERVER_EXPORT Client: public ClientBase {
NO_COPY_CLASS(Client);
@@ -57,6 +63,8 @@ public:
Client();
~Client();
//! ~english Connects to specified server address
//! ~russian Подключается к указанному адресу сервера
void connect(PINetworkAddress addr);
protected:

View File

@@ -37,6 +37,8 @@ class Server;
class ClientInterface {};
//! ~english Base class for client-server communication with diagnostics support
//! ~russian Базовый класс для клиент-серверного взаимодействия с поддержкой диагностики
// template<bool EnableDiagnostics = false>
class PIP_CLIENT_SERVER_EXPORT ClientBase {
friend class Server;
@@ -46,16 +48,39 @@ public:
ClientBase();
virtual ~ClientBase();
//! ~english Gets underlying TCP connection
//! ~russian Возвращает TCP-соединение
const PIEthernet * getTCP() const { return tcp; }
//! ~english Closes the connection
//! ~russian Закрывает соединение
void close();
//! ~english Gracefully stops and waits for completion
//! ~russian Плавно останавливает и ожидает завершения
void stopAndWait();
//! ~english Writes byte array to the connection
//! ~russian Записывает массив байтов в соединение
int write(const void * d, const size_t s);
//! ~english Writes byte array to the connection
//! ~russian Записывает массив байтов в соединение
int write(const PIByteArray & ba) { return write(ba.data(), ba.size()); }
//! ~english Enables diagnostics collection
//! ~russian Включает сбор диагностики
void enableDiagnostics();
//! ~english Gets current diagnostics state
//! ~russian Возвращает текущее состояние диагностики
PIDiagnostics::State diagnostics() const;
//! ~english Gets current received packet bytes already received (all bytes count passed in \a receivePacketStart())
//! ~russian Возвращает сколько байт принимаемого пакета получено (общее количество передается в \a receivePacketStart())
int receivePacketProgress() const;
const PIStreamPackerConfig & configuration() const { return stream.configuration(); }
@@ -63,10 +88,24 @@ public:
void setConfiguration(const PIStreamPackerConfig & config) { stream.setConfiguration(config); }
protected:
//! ~english Called when data is received
//! ~russian Вызывается при получении данных
virtual void readed(PIByteArray data) {}
//! ~english Called when connection is established
//! ~russian Вызывается при установке соединения
virtual void connected() {}
//! ~english Called when connection is closed
//! ~russian Вызывается при закрытии соединения
virtual void disconnected() {}
//! ~english Called when packet receiving starts
//! ~russian Вызывается при начале получения пакета
virtual void receivePacketStart(int size) {}
//! ~english Called when packet receiving ends
//! ~russian Вызывается при завершении получения пакета
virtual void receivePacketEnd() {}
void init();

View File

@@ -38,6 +38,8 @@ namespace PIClientServer {
class ServerClient;
//! ~english TCP server for client-server communication
//! ~russian TCP сервер для клиент-серверного взаимодействия
class PIP_CLIENT_SERVER_EXPORT Server: public PIStreamPackerConfig {
friend class ServerClient;
NO_COPY_CLASS(Server);
@@ -46,17 +48,44 @@ public:
Server();
virtual ~Server();
//! ~english Starts listening on specified address
//! ~russian Начинает прослушивание на указанном адресе
void listen(PINetworkAddress addr);
//! ~english Starts listening on all interfaces
//! ~russian Начинает прослушивание на всех интерфейсах
void listenAll(ushort port) { listen({0, port}); }
//! ~english Stops the server
//! ~russian Останавливает сервер
void stopServer();
//! ~english Closes all client connections
//! ~russian Закрывает все клиентские соединения
void closeAll();
//! ~english Gets maximum allowed clients
//! ~russian Возвращает максимальное число клиентов
int getMaxClients() const { return max_clients; }
//! ~english Sets maximum allowed clients
//! ~russian Устанавливает максимальное число клиентов
void setMaxClients(int new_max_clients);
//! ~english Gets current clients count
//! ~russian Возвращает текущее количество клиентов
int clientsCount() const;
//! ~english Executes function for each connected client
//! ~russian Выполняет функцию для каждого подключённого клиента
void forEachClient(std::function<void(ServerClient *)> func);
//! ~english Sets factory for creating new client instances
//! ~russian Устанавливает фабрику для создания клиентских экземпляров
void setClientFactory(std::function<ServerClient *()> f) { client_factory = f; }
private: