128 lines
4.3 KiB
C++
128 lines
4.3 KiB
C++
/*! \file piclientserver_client_base.h
|
||
* \ingroup ClientServer
|
||
* \~\brief
|
||
* \~english
|
||
* \~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 {};
|
||
|
||
//! ~english Base class for client-server communication with diagnostics support
|
||
//! ~russian Базовый класс для клиент-серверного взаимодействия с поддержкой диагностики
|
||
// template<bool EnableDiagnostics = false>
|
||
class PIP_CLIENT_SERVER_EXPORT ClientBase {
|
||
friend class Server;
|
||
NO_COPY_CLASS(ClientBase);
|
||
|
||
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(); }
|
||
PIStreamPackerConfig & configuration() { return stream.configuration(); }
|
||
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();
|
||
|
||
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
|