merged AI doc, some new pages
This commit is contained in:
@@ -1,9 +1,8 @@
|
||||
/*! \file piclientserver_client.h
|
||||
* \ingroup ClientServer
|
||||
* \~\brief
|
||||
* \~english
|
||||
* \~russian
|
||||
*/
|
||||
//! \~\file piclientserver_client.h
|
||||
//! \~\ingroup ClientServer
|
||||
//! \brief
|
||||
//! \~english Client-side and server-side client connection classes
|
||||
//! \~russian Классы клиентского подключения и серверного представления клиента
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
Ivan Pelipenko peri4ko@yandex.ru
|
||||
@@ -33,18 +32,27 @@ namespace PIClientServer {
|
||||
|
||||
// ServerClient
|
||||
|
||||
//! ~english Server-side client implementation
|
||||
//! ~russian Серверная реализация клиента
|
||||
//! \~\ingroup ClientServer
|
||||
//! \~\brief
|
||||
//! \~english Server-side representation of one accepted client connection.
|
||||
//! \~russian Серверное представление одного принятого клиентского соединения.
|
||||
//! \details
|
||||
//! \~english Server-side client representation. Created and managed by Server. Used to communicate with remote clients connected to the
|
||||
//! server.
|
||||
//! \~russian Представление клиента на стороне сервера. Создаётся и управляется сервером. Используется для коммуникации с удалёнными
|
||||
//! клиентами, подключёнными к серверу.
|
||||
class PIP_CLIENT_SERVER_EXPORT ServerClient: public ClientBase {
|
||||
friend class Server;
|
||||
NO_COPY_CLASS(ServerClient);
|
||||
|
||||
public:
|
||||
//! \~english Constructs an unbound server-side client object.
|
||||
//! \~russian Создает непривязанный объект серверного клиента.
|
||||
ServerClient() {}
|
||||
|
||||
protected:
|
||||
//! ~english Called before client destruction
|
||||
//! ~russian Вызывается перед уничтожением клиента
|
||||
//! \~english Called right before the server deletes this client object.
|
||||
//! \~russian Вызывается непосредственно перед удалением этого объекта сервером.
|
||||
virtual void aboutDelete() {}
|
||||
|
||||
private:
|
||||
@@ -54,17 +62,28 @@ private:
|
||||
|
||||
// Client
|
||||
|
||||
//! ~english Client implementation for connecting to servers
|
||||
//! ~russian Клиентская реализация для подключения к серверам
|
||||
//! \~\ingroup ClientServer
|
||||
//! \~\brief
|
||||
//! \~english Active client connection that initiates a connection to a server.
|
||||
//! \~russian Активное клиентское соединение, которое само подключается к серверу.
|
||||
//! \details
|
||||
//! \~english Client implementation for connecting to servers. Provides TCP connection to remote server with diagnostics and packet
|
||||
//! streaming support.
|
||||
//! \~russian Реализация клиента для подключения к серверам. Обеспечивает TCP-соединение с удалённым сервером с поддержкой диагностики и
|
||||
//! потоковой передачи пакетов.
|
||||
class PIP_CLIENT_SERVER_EXPORT Client: public ClientBase {
|
||||
NO_COPY_CLASS(Client);
|
||||
|
||||
public:
|
||||
//! \~english Constructs a client ready to connect to a remote server.
|
||||
//! \~russian Создает клиент, готовый к подключению к удаленному серверу.
|
||||
Client();
|
||||
//! \~english Destroys the client and closes its connection if needed.
|
||||
//! \~russian Уничтожает клиента и при необходимости закрывает его соединение.
|
||||
~Client();
|
||||
|
||||
//! ~english Connects to specified server address
|
||||
//! ~russian Подключается к указанному адресу сервера
|
||||
//! \~english Connects to the server at address "addr".
|
||||
//! \~russian Подключается к серверу по адресу "addr".
|
||||
void connect(PINetworkAddress addr);
|
||||
|
||||
protected:
|
||||
|
||||
Reference in New Issue
Block a user