merged AI doc, some new pages

libs/main/client_server/piclientserver_client_base.h

@@ -1,9 +1,11 @@
-/*! \file piclientserver_client_base.h
- * \ingroup ClientServer
- * \~\brief
- * \~english
- * \~russian
- */
+//! \~\file piclientserver_client_base.h
+//! \~\ingroup ClientServer
+//! \brief
+//! \~english Base class for client-server communication
+//! \~russian Базовый класс для клиент-серверного взаимодействия
+//! \details
+//! \~english Provides base functionality for client-server communication with diagnostics support.
+//! \~russian Обеспечивает базовую функциональность для клиент-серверного взаимодействия с поддержкой диагностики.
 /*
     PIP - Platform Independent Primitives
     Ivan Pelipenko peri4ko@yandex.ru
@@ -35,77 +37,93 @@ namespace PIClientServer {
 
 class Server;
 
-class ClientInterface {};
-
-//! ~english Base class for client-server communication with diagnostics support
-//! ~russian Базовый класс для клиент-серверного взаимодействия с поддержкой диагностики
+//! \~\ingroup ClientServer
+//! \~\brief
+//! \~english Base class for client and server-side client communication. Provides TCP connection management, diagnostics, and packet
+//! streaming capabilities.
+//! \~russian Базовый класс для клиентской и серверной коммуникации. Обеспечивает управление TCP-соединением, диагностику и потоковую
+//! передачу пакетов.
 // template<bool EnableDiagnostics = false>
 class PIP_CLIENT_SERVER_EXPORT ClientBase {
 	friend class Server;
 	NO_COPY_CLASS(ClientBase);
 
 public:
+	//! \~english Constructs a disconnected client connection object.
+	//! \~russian Создает объект клиентского соединения в отключенном состоянии.
 	ClientBase();
+	
+	//! \~english Destroys the client connection and releases owned resources.
+	//! \~russian Уничтожает клиентское соединение и освобождает связанные ресурсы.
 	virtual ~ClientBase();
 
-	//! ~english Gets underlying TCP connection
-	//! ~russian Возвращает TCP-соединение
+	
+	//! \~english Returns the underlying TCP transport object.
+	//! \~russian Возвращает базовый объект TCP-транспорта.
 	const PIEthernet * getTCP() const { return tcp; }
 
-	//! ~english Closes the connection
-	//! ~russian Закрывает соединение
+	//! \~english Closes the connection immediately.
+	//! \~russian Немедленно закрывает соединение.
 	void close();
 
-	//! ~english Gracefully stops and waits for completion
-	//! ~russian Плавно останавливает и ожидает завершения
+	//! \~english Stops the connection workflow and waits until shutdown completes.
+	//! \~russian Останавливает работу соединения и ждет полного завершения.
 	void stopAndWait();
 
 
-	//! ~english Writes byte array to the connection
-	//! ~russian Записывает массив байтов в соединение
+	//! \~english Sends raw payload bytes through the stream packer.
+	//! \~russian Отправляет сырые байты полезной нагрузки через упаковщик потока.
 	int write(const void * d, const size_t s);
 
-	//! ~english Writes byte array to the connection
-	//! ~russian Записывает массив байтов в соединение
+	//! \~english Sends payload stored in "ba".
+	//! \~russian Отправляет полезную нагрузку из "ba".
 	int write(const PIByteArray & ba) { return write(ba.data(), ba.size()); }
 
 
-	//! ~english Enables diagnostics collection
-	//! ~russian Включает сбор диагностики
+	//! \~english Enables connection diagnostics collection.
+	//! \~russian Включает сбор диагностики соединения.
 	void enableDiagnostics();
 
-	//! ~english Gets current diagnostics state
-	//! ~russian Возвращает текущее состояние диагностики
+	//! \~english Returns a snapshot of current diagnostics counters.
+	//! \~russian Возвращает снимок текущих диагностических счетчиков.
 	PIDiagnostics::State diagnostics() const;
 
 
-	//! ~english Gets current received packet bytes already received (all bytes count passed in \a receivePacketStart())
-	//! ~russian Возвращает сколько байт принимаемого пакета получено (общее количество передается в \a receivePacketStart())
+	//! \~english Returns how many payload bytes of the current packet are already received (all bytes count passed in \a receivePacketStart()).
+	//! \~russian Возвращает, сколько байтов полезной нагрузки текущего пакета уже получено (общее количество передается в \a receivePacketStart()).
 	int receivePacketProgress() const;
 
+	//! \~english Returns the current packet framing configuration.
+	//! \~russian Возвращает текущую конфигурацию пакетирования.
 	const PIStreamPackerConfig & configuration() const { return stream.configuration(); }
+	
+	//! \~english Returns the current packet framing configuration for modification.
+	//! \~russian Возвращает текущую конфигурацию пакетирования для изменения.
 	PIStreamPackerConfig & configuration() { return stream.configuration(); }
+	
+	//! \~english Replaces the packet framing configuration.
+	//! \~russian Заменяет конфигурацию пакетирования.
 	void setConfiguration(const PIStreamPackerConfig & config) { stream.setConfiguration(config); }
 
 protected:
-	//! ~english Called when data is received
-	//! ~russian Вызывается при получении данных
+	//! \~english Called when a full payload packet is received.
+	//! \~russian Вызывается при получении полного пакета полезной нагрузки.
 	virtual void readed(PIByteArray data) {}
 
-	//! ~english Called when connection is established
-	//! ~russian Вызывается при установке соединения
+	//! \~english Called after the TCP connection becomes active.
+	//! \~russian Вызывается после перехода TCP-соединения в активное состояние.
 	virtual void connected() {}
 
-	//! ~english Called when connection is closed
-	//! ~russian Вызывается при закрытии соединения
+	//! \~english Called after the connection is closed.
+	//! \~russian Вызывается после закрытия соединения.
 	virtual void disconnected() {}
 
-	//! ~english Called when packet receiving starts
-	//! ~russian Вызывается при начале получения пакета
+	//! \~english Called when reception of a new packet starts.
+	//! \~russian Вызывается при начале приема нового пакета.
 	virtual void receivePacketStart(int size) {}
 
-	//! ~english Called when packet receiving ends
-	//! ~russian Вызывается при завершении получения пакета
+	//! \~english Called when reception of the current packet finishes.
+	//! \~russian Вызывается при завершении приема текущего пакета.
 	virtual void receivePacketEnd() {}
 
 	void init();