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設置。