stream client下载 - stream client源代码下载

流客户

这是一个轻巧的，仅标头的，基于增压的库，提供客户端网络原始图，以轻松地组织和实现远程端点的数据传输。

这个库：

灵感来自于boost.asio。
提供高级构造作为连接器和连接池。
支持TCP / UDP / SSL / HTTP / HTTPS协议。
使用与boost :: asio :: ip的插座相同的接口。
允许所有操作的透明超时/截止日期控制。
如果您打算使用HTTP协议，则需要提升1.65+或1.66+。

为什么

如果您在C ++上编写软件，该软件与其他服务作为客户端进行通信，那么您可能已经对这个问题进行了交流 - 需要实现连接层以向所有相关服务提供网络传输。这正是该图书馆要解决的目标。

如何使用

插座

插座是在boost::asio::basic_socket顶部实现的，并提供具有超时控件的类，因此，在大多数情况下，只需调用send send（） / receion_some（） / write_some（） / read_some（） / read_some（） / read_some（）带有截止日期或超时。提供给I/O操作的数据应包裹在boost::asio::buffer中。基本上，这些客户端是超时包装的boost::asio::ip插座，并且具有相同的界面。

客户端流类：

stream_client::tcp_client普通TCP流插座客户端。支持Send（） / rececive（）与with_some（） / read_some（）一起接收到的整个缓冲区的传输至少传输。
stream_client::udp_client普通UDP套接字客户端。仅根据UDP规格提供任何确认，仅支持发送（） / recection（） 。
stream_client::ssl::ssl_client -ssl -conterpted tcp客户端。具有与tcp_client加上SSL握手和上下文控制相同的功能。
stream_client::http::http_client -http client。用tcp_client boost::beast::http::parser和boost::beast::http::serializer and pertric（）函数以进行request-Response呼叫。
stream_client::http::https_client -https客户端。与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;

DNS解析器

解析器围绕相同的想法实现 - 制作同步，定时的DNS解析器，因此它使用boost::asio::ip::basic_resolver在指定的超时内执行实际分辨率。

它是具有单个参数 - 结果协议的类模板，您也可以指定您对-IPv4，IPv6或两者都感兴趣的IP端点类型。用resolve（）调用执行的分辨率，其签名与插座操作类似 - 您可以自由指定超时/截止日期或使用默认一个。

解析器类：

stream_client::resolver::tcp_resolver返回TCP端点的迭代器的解析器。
stream_client::resolver::udp_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解析器的工作被包裹在创建时触发的背景线程中，或者打开新套接字有错误。

目标端点要打开从DNS结果随机选择的新套接字，从而使其平衡连接器到远程主机。此外，该连接器允许指定单独的超时，以进行分辨率，连接和I/O的新套接字操作。

连接器类：

stream_client::connector::tcp_connector -TCP Connector，以获取stream_client::tcp_client插座。
stream_client::connector::udp_connector -UDP连接器，以获取stream_client::udp_client套接字。
stream_client::connector::ssl_connector -TCP连接器，以获取stream_client::ssl::ssl_client插座。
stream_client::connector::http_connector -HTTP连接器，以获取stream_client::http::http_client插座。
stream_client::connector::https_connector -HTTPS连接器，以获取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接口定义的，因此您可以自由实现新的。

限制：

池中已经在池中的插座不以任何方式检查或维护。因此，由于所有受支持的协议的此类检查的复杂性，池不能保证所有插座都在任意时间点打开。
在return_session（）中返回时，插座的返回时没有什么具体的。因此，如果他们有或将有未决的数据要阅读，它将一直呆在那里直到阅读。

考虑到这一点，使用连接池的最佳策略就是这样：

创建它，根据需要指定所有超时。
创建后，使用get_session（）获得打开的套接字。
是否需要插座上的I/O操作。
如果2-3成功，请用return_session（）将其返回，否则重复点2。

重要的是要丢弃失败插座，不要重复使用它们，否则请求响应管理会变得讨厌。

连接池：

stream_client::connector::tcp_pool stream_client::tcp_client插座。
stream_client::connector::udp_pool stream_client::udp_client套接字。
stream_client::connector::ssl_pool stream_client::ssl::ssl_client套接字。
stream_client::connector::http_pool stream_client::http::http_client套接字。
stream_client::connector::https_pool stream_client::http::https_client套接字。

也有同一池的别名，但使用保守的重新连接策略：

stream_client::connector::tcp_conservative_pool
stream_client::connector::udp_conservative_pool
stream_client::connector::ssl_conservative_pool
stream_client::connector::http_conservative_pool
stream_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 ();
}

记录

该库使用内部实现的基本记录器接口。您可以使用stream_client::set_log_level()或stream_client::get_log_level() functions修改logger级别。

这些级别得到支持：

 enum class log_level : int
{
    trace = 0 ,
    debug,
    info,
    warning,
    error,
};

默认情况下，图书馆以不错的格式打印消息以闻名。如果要覆盖此行为，则可以通过以下方式设置自己的记录器：

 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);

它允许使用正确签名的回调的覆盖记录器实例。这些类型的定义为：

 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。
喜欢源自源建筑。

Ubuntu依赖性

sudo apt update
sudo apt install build-essential cmake libboost-dev libboost-system-dev libssl-dev

MacOS依赖性

brew 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

所有这些命令都假定您在流式的root文件夹中

CMAKE选项

cmake_build_type-构建类型。默认情况下， RelWithDebInfo 。
build_shared_libs-构建共享或静态库。默认情况ON 。
streamclient_build_testing-是否构建测试。默认OFF
streamclient_build_examples-构建库示例。默认情况OFF 。
streamclient_build_docs - 构建HTML（SPHINX）参考文档。默认情况OFF 。
OPENSSL_USE_STATIC_LIBS-与发现的OpenSSL静态或动态链接。如果build_shared_libs OFF ，则设置此选项。
openssl_root_dir-文件夹在哪里查找openssl。默认情况下由BREW的PKG-Config设置。