stream client
v1.4.2
Это легкая библиотека на основе BOOST, предоставляющая клиентскую сетевую библиотеку на основе клиентов, для легкой организации и реализации передачи данных с помощью удаленных конечных точек.
Эта библиотека:
Если вы пишете программное обеспечение на C ++, которое связывается с другими службами в качестве клиента, вы, вероятно, уже пришли с проблемой - необходимо внедрить уровень подключения для обеспечения сетевого транспорта для всех связанных сервисов. Это именно то, что цель этой библиотеки решить.
Глевы реализуются сверху boost::asio::basic_socket и предоставляют классы с управлением тайм -аутом, поэтому в большинстве случаев этого достаточно, чтобы просто вызовать send () / chect () / write_some () / read_some () с крайним сроком или тайм -аутом. Данные, поставляемые для операций ввода -вывода, должны быть завернуты в boost::asio::buffer . По сути, эти клиенты-это время аута boost::asio::ip Sockets и имеют тот же интерфейс.
Клиентские потоки классов:
stream_client::tcp_client - Clain TCP Client Socket Client. Поддерживает Send () / rececive () для признанных переводов всего буфера вместе с write_some () / read_some () , чтобы перенести хотя бы что -то.stream_client::udp_client - обычный клиент UDP. Поддерживает только Send () / chective () без какого -либо подтверждения в соответствии с спецификациями UDP.stream_client::ssl::ssl_client - SSL -Ecrypted TCP Client. Иметь те же функции, что и рукопожатие tcp_client Plus SSL и управление контекстом.stream_client::http::http_client - http client. Обертывание tcp_client с помощью boost::beast::http::parser and boost::beast::http::serializer и выполнить функцию () для выполнения звонков для запроса-ответа.stream_client::http::https_client - https client. То же, что и http_client , но использует клиент ssl_client внизу. const boost::asio::ip::tcp::endpoint endpoint (boost::asio::ip::address::from_string( " 127.0.0.1 " ), 12345);
const std::chrono::milliseconds connect_timeout ( 1000 );
const std::chrono::milliseconds io_timeout ( 100 );
// this makes connected socket and may take up to connect_timeout time
stream_client::tcp_client client (endpoint, connect_timeout, io_timeout);
// send() operation will transmit all contents of send_data or throw an error;
// also it will throw boost::asio::error::timed_out after io_timeout.
const std::string send_data = " test data " ;
client.send(boost::asio::buffer(send_data.data(), send_data.size()));
// receive() operation will read send_data.size() size or throw an error;
// also it will throw boost::asio::error::timed_out after io_timeout.
std::string recv_data (send_data.size(), ' ');
client.receive(boost::asio::buffer(&recv_data[ 0 ], send_data.size()));
// there are also non-throw overloads to these functions which
// will set boost::system::error_code instead of exception; Resolver реализован вокруг той же идеи - сделать синхронизацию, временной DNS Resolver, поэтому он использует boost::asio::ip::basic_resolver для выполнения фактического разрешения в пределах указанных тайм -аутов.
Это шаблон класса с одним параметром - протокол результата, также вы можете указать, какой тип конечных точек IP вам интересует - IPv4, IPv6 или обоих. Разрешение, выполняемое с помощью вызова Resolve () , которая имеет аналогичную подпись, как и операции сокетов - вы можете указать тайм -аут/крайний срок или использовать по умолчанию.
Занятия резолюра:
stream_client::resolver::tcp_resolver - RESOLVER, который возвращает итератор TCP конечных точек.stream_client::resolver::udp_resolver - Resolver, который возвращает итератор UDP конечных точек. const std::chrono::milliseconds resolve_timeout ( 5000 );
stream_client::resolver::tcp_resolver resolver ( " localhost " , " 12345 " ,
resolve_timeout,
stream_client::resolver::ip_family::ipv4);
// resolve() guaranteed to return at least one endpoint or will throw an error;
// it will throw boost::asio::error::timed_out after resolve_timeout.
auto endpoints_it = resolver.resolve();
// returned iterator is an instance of boost::asio::ip::basic_resolver::iterator<Protocol>Connector использует Resolver для выполнения разрешения DNS и обновления списка конечных точек и использует их, если запрошен с помощью new_session () , для создания нового сокета указанного протокола. Работа DNS Resolver завершена в фоновый поток, который запускается при создании или если в открытии нового розетки была ошибка.
Целевая конечная точка, чтобы открыть новую розетку, выбранную случайным образом из результатов DNS, что делает его сбалансированным разъемом к удаленному хосту. Кроме того, разъем позволяет определять отдельные тайм -ауты для разрешения, подключения и работы ввода -вывода новых сокетов.
Классы разъемов:
stream_client::connector::tcp_connector - TCP Connector, чтобы получить stream_client::tcp_client SOCKET.stream_client::connector::udp_connector - UDP Connector, чтобы получить stream_client::udp_client Sockets.stream_client::connector::ssl_connector - TCP Connector, чтобы получить stream_client::ssl::ssl_client SOCKET.stream_client::connector::http_connector - http connector, чтобы получить stream_client::http::http_client сокеты.stream_client::connector::https_connector - https connector, чтобы получить сокеты stream_client::http::https_client . const std::chrono::milliseconds resolve_timeout ( 5000 );
const std::chrono::milliseconds connect_timeout ( 1000 );
const std::chrono::milliseconds io_timeout ( 100 );
// this will return immediately, starting background thread for name resolution
stream_client::connector::tcp_connector connector ( " localhost " , " 12345 " ,
resolve_timeout, connect_timeout, io_timeout,
stream_client::resolver::ip_family::ipv4);
// this will acquire new socket or throw;
// it will throw boost::asio::error::timed_out after connect_timeout
std::unique_ptr<stream_client::tcp_client> client = connector.new_session();
// use the client
const std::string send_data = " test data " ;
std::string recv_data (send_data.size(), ' ');
client-> send (boost::asio::buffer(send_data.data(), send_data.size()));
client-> receive (boost::asio::buffer(&recv_data[ 0 ], send_data.size()));Представляет контейнер, занятый открытыми гнездами. Использует разъем для открытия новых розеток в фоновом потоке, который запускается после того, как в бассейне появляются вакантные места. Пользователь может вызвать get_session () , чтобы получить сокет из пула и return_session () , чтобы вернуть его.
Есть две стратегии для пополнения пула:
stream_client::connector::greedy_strategy ). Если есть свободные места, он попытается заполнить их новыми сессиями одновременно. Это по умолчанию.stream_client::connector::conservative_strategy ). Постараюсь заполнить до 2/3 свободных мест в опросе. Если провалится в течение некоторого времени и повторить позже. Кроме того, после сбоев он создаст только одну новую сеанс. Оба они определены в терминах stream_client::connector::pool_strategy interface, поэтому вы можете реализовать новый.
Ограничения:
Учитывая это, лучшая стратегия использования пула соединений является таковой:
Важно отказаться от гнезда при неудаче, а не повторно их использование, или управление ответом на запросы будет противно.
Бассейны соединений:
stream_client::connector::tcp_pool - Pool of stream_client::tcp_client Sockets.stream_client::connector::udp_pool - Pool of stream_client::udp_client Sockets.stream_client::connector::ssl_pool - Pool of stream_client::ssl::ssl_client Sockets.stream_client::connector::http_pool - Pool of stream_client::http::http_client Sockets.stream_client::connector::https_pool - Pool of stream_client::http::https_client Sockets.Есть также псевдонимы для тех же пулов, но используя стратегию консервативного переподключения:
stream_client::connector::tcp_conservative_poolstream_client::connector::udp_conservative_poolstream_client::connector::ssl_conservative_poolstream_client::connector::http_conservative_poolstream_client::connector::https_conservative_pool const std::chrono::milliseconds resolve_timeout ( 5000 );
const std::chrono::milliseconds connect_timeout ( 1000 );
const std::chrono::milliseconds io_timeout ( 100 );
auto connector_pool =
std::make_shared<stream_client::connector::tcp_pool>( " localhost " , " 12345 " ,
resolve_timeout, connect_timeout, io_timeout,
stream_client::resolver::ip_family::ipv4);
const size_t threads_num = 10 ;
std::vector<std::thread> threads;
const std::string send_data = " test data " ;
std::mutex stdout_mutex;
for ( size_t i = 0 ; i < threads_num; ++i) {
threads. emplace_back ([&send_data, &stdout_mutex, connector_pool]() {
std::string recv_data (send_data. size (), ' ' );
auto client = connector_pool-> get_session ();
// both these calls will throw exception on error or timeout
client-> send ( boost::asio::buffer (send_data. data (), send_data. size ()));
client-> receive ( boost::asio::buffer (&recv_data[ 0 ], send_data. size ()));
// if there was no exception, return it
connector_pool-> return_session ( std::move (client));
const std::lock_guard<std::mutex> lk (stdout_mutex);
std::cout << std::this_thread::get_id () << " : " << recv_data << std::endl;
});
}
for ( auto & t : threads) {
t. join ();
} Библиотека использует базовый интерфейс логиста, реализованный внутри. Вы можете изменить уровень Logger, используя функции stream_client::set_log_level() или stream_client::get_log_level() .
Эти уровни поддерживаются:
enum class log_level : int
{
trace = 0 ,
debug,
info,
warning,
error,
};По умолчанию библиотека печатает сообщения в stdout с приличным форматированием. Если вы хотите перезаписать это поведение, вы можете установить свой собственный журнал через:
void stream_client::set_logger (std::shared_ptr<stream_client::log_interface> logger);
void stream_client::set_logger (stream_client::log_level level, stream_client::log_func_type log_func);Который позволяет либо перезаписать экземпляр Logger, используя обратный вызов с надлежащей подписью. Эти типы определяются как:
class log_interface
{
public:
virtual void set_level (log_level level) noexcept = 0;
virtual log_level get_level () const noexcept = 0;
virtual void message (log_level level, const std::string& location, const std::string& message) const = 0;
};
using log_func_type = std::function< void (log_level level, const std::string& location, const std::string& message)>;Для получения дополнительной информации, пожалуйста, посмотрите на logger.hpp.
Эта библиотека должна была быть несколько многоплатформенной, однако она была протестирована и в основном использовалась на Ubuntu и MacOS.
Предпочитаю строительное здание.
sudo apt update
sudo apt install build-essential cmake libboost-dev libboost-system-dev libssl-devbrew install cmake pkg-config icu4c openssl boostПостроить:
cmake -H. -Bbuild
cmake --build ./buildДля установки (SUDO может потребоваться):
cmake -H. -Bbuild -DSTREAMCLIENT_BUILD_TESTING=OFF -DSTREAMCLIENT_BUILD_DOCS=OFF -DSTREAMCLIENT_BUILD_EXAMPLES=OFF
cmake --build ./build --target installИли тест:
cmake -H. -Bbuild -DSTREAMCLIENT_BUILD_TESTING=ON -DSTREAMCLIENT_BUILD_DOCS=OFF -DSTREAMCLIENT_BUILD_EXAMPLES=OFF
cmake --build ./build
cmake -E chdir ./build ctest --output-on-failureВсе эти команды предполагают, что вы находитесь в корневой папке Stream-Client
RelWithDebInfo по умолчанию.ON .OFF по умолчаниюOFF по умолчанию.OFF по умолчанию.OFF , то эти параметры установлены. Разработано на Tinkoff.ru в 2020 году.
Дисредитив в соответствии с лицензией Apache 2.0 . Вы также можете получить эту лицензию по адресу https://www.apache.org/licenses/license-2.0.
Автор - [email protected]
Текущие сопровождающие - [email protected], [email protected]
