pip/libs/main/client_server/piclientserver_client_base.h

//! \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

    This program 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 3 of the License, or
    (at your option) any later version.

    This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef piclientserver_client_base_H
#define piclientserver_client_base_H

#include "pidiagnostics.h"
#include "pip_client_server_export.h"
#include "pistreampacker.h"

class PIEthernet;

namespace PIClientServer {

class Server;

class ClientInterface {};

//! \brief
//! \~english Base class for client and server-side client
//! \~russian Базовый класс для клиента и клиента на стороне сервера
// template<bool EnableDiagnostics = false>
class PIP_CLIENT_SERVER_EXPORT ClientBase {
	friend class Server;
	NO_COPY_CLASS(ClientBase);

public:
	//! \brief
	//! \~english Constructs ClientBase
	//! \~russian Создает ClientBase
	ClientBase();

	//! \brief
	//! \~english Destructor
	//! \~russian Деструктор
	virtual ~ClientBase();

	//! \brief
	//! \~english Gets underlying TCP connection
	//! \~russian Возвращает TCP-соединение
	const PIEthernet * getTCP() const { return tcp; }

	//! \brief
	//! \~english Closes the connection
	//! \~russian Закрывает соединение
	void close();

	//! \brief
	//! \~english Gracefully stops and waits for completion
	//! \~russian Плавно останавливает и ожидает завершения
	void stopAndWait();


	//! \brief
	//! \~english Writes byte array to the connection
	//! \~russian Записывает массив байтов в соединение
	int write(const void * d, const size_t s);

	//! \brief
	//! \~english Writes byte array to the connection
	//! \~russian Записывает массив байтов в соединение
	int write(const PIByteArray & ba) { return write(ba.data(), ba.size()); }


	//! \brief
	//! \~english Enables diagnostics collection
	//! \~russian Включает сбор диагностики
	void enableDiagnostics();

	//! \brief
	//! \~english Gets current diagnostics state
	//! \~russian Возвращает текущее состояние диагностики
	PIDiagnostics::State diagnostics() const;


	//! \brief
	//! \~english Gets current received packet bytes already received (all bytes count passed in \a receivePacketStart())
	//! \~russian Возвращает сколько байт принимаемого пакета получено (общее количество передается в \a receivePacketStart())
	int receivePacketProgress() const;

	//! \brief
	//! \~english Returns stream configuration
	//! \~russian Возвращает конфигурацию стрима
	const PIStreamPackerConfig & configuration() const { return stream.configuration(); }

	//! \brief
	//! \~english Returns stream configuration
	//! \~russian Возвращает конфигурацию стрима
	PIStreamPackerConfig & configuration() { return stream.configuration(); }

	//! \brief
	//! \~english Sets stream configuration
	//! \~russian Устанавливает конфигурацию стрима
	void setConfiguration(const PIStreamPackerConfig & config) { stream.setConfiguration(config); }

protected:
	//! \brief
	//! \~english Called when data is received
	//! \~russian Вызывается при получении данных
	virtual void readed(PIByteArray data) {}

	//! \brief
	//! \~english Called when connection is established
	//! \~russian Вызывается при установке соединения
	virtual void connected() {}

	//! \brief
	//! \~english Called when connection is closed
	//! \~russian Вызывается при закрытии соединения
	virtual void disconnected() {}

	//! \brief
	//! \~english Called when packet receiving starts
	//! \~russian Вызывается при начале получения пакета
	virtual void receivePacketStart(int size) {}

	//! \brief
	//! \~english Called when packet receiving ends
	//! \~russian Вызывается при завершении получения пакета
	virtual void receivePacketEnd() {}

	//! \brief
	//! \~english Initializes the client
	//! \~russian Инициализирует клиента
	void init();

	bool own_tcp               = false;
	std::atomic_bool can_write = {true};
	PIEthernet * tcp           = nullptr;

private:
	void destroy();

	PIStreamPacker stream;
	mutable PIMutex write_mutex;
	PIDiagnostics * diag = nullptr;
};

} // namespace PIClientServer

#endif