stream client
v1.4.2
これは、リモートエンドポイントを使用してデータ送信を簡単に整理および実装するためのクライアント側のネットワークプリミティブを提供する、軽量のヘッダーのみのブーストベースのライブラリです。
このライブラリ：
クライアントとして他のサービスと通信するC ++でソフトウェアを作成している場合、おそらくすでに問題を抱えている - すべての関連サービスにネットワークトランスポートを提供するために接続レイヤーを実装する必要があります。これはまさにこのライブラリが解決することを目的としていることです。
ソケットはboost::asio::basic_socketの上に実装され、タイムアウトコントロールのクラスを提供するため、ほとんどの場合、 dead（） / write_some（ ） / read_some（）を締め切りまたはタイムアウトで呼び出すだけで十分です。 I/O操作に提供されるデータはboost::asio::bufferにラップする必要があります。基本的に、これらのクライアントはTimeOut-rapped boost::asio::ipソケットであり、同じインターフェイスを持っています。
クライアントストリーミングクラス：
stream_client::tcp_clientプレーンTCPストリームソケットクライアント。 write_some（） / read_some （ ）とともにバッファー全体の入場転送をサポートする（） / rececive （）をサポートして、少なくとも何かを転送します。stream_client::udp_clientプレーンUDPソケットクライアント。 UDP仕様に従って、確認なしでsend（） / receive（）のみをサポートします。stream_client::ssl::ssl_client -SSL -INCRYPTED TCPクライアント。 tcp_client Plus SSLハンドシェイクとコンテキスト制御と同じ機能を持っています。stream_client::http::http_client -HTTPクライアント。 tcp_clientをboost::beast::http::parser and boost::beast::http::serializer and have function（） function function furse boost :: boost :: boost :: boost :: boost :: http :: have 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;Resolverは同じアイデアを中心に実装されています - Sync、Timed DNS Resolverをboost::asio::ip::basic_resolverします。
これは、単一のパラメーター - 結果プロトコルを備えたクラステンプレートであり、興味のあるIPエンドポイントのタイプ-IPv4、IPv6、またはその両方を指定することもできます。 Sockets操作と同様の署名があるResolve（）コールで実行される解像度 - タイムアウト/締め切りを自由に指定するか、デフォルト1を使用できます。
リゾルバークラス：
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>コネクタはResolverを使用してDNS解像度を実行し、エンドポイントのリストを更新し、 new_Session（）で要求された場合にそれらを使用して、指定されたプロトコルの新しいソケットを作成します。 DNSリゾルバーの作業は、作成時にトリガーされるバックグラウンドスレッドに包まれています。
ターゲットエンドポイントDNS結果からランダムに選択された新しいソケットを開くための新しいソケットを開き、リモートホストにバランスの取れたコネクタを作成します。また、コネクタは、新しいソケットの解像度、接続、およびI/O操作のための個別のタイムアウトを指定することができます。
コネクタクラス：
stream_client::connector::tcp_connector -tcpコネクタ、 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（）を取得して戻します。
プールを補充するための2つの戦略があります。
stream_client::connector::greedy_strategy ）。空いている場所がある場合、それはそれらを同時に新しいセッションで埋めようとします。これがデフォルトのものです。stream_client::connector::conservative_strategy ）。世論調査で最大2/3の空いている場所を埋めようとします。失敗した場合、しばらくの間戻ってきて後で再試行します。また、失敗後、1つの新しいセッションのみが作成されます。どちらもstream_client::connector::pool_strategyインターフェイスに関して定義されているため、新しいものを自由に実装できます。
制限：
これを考慮すると、接続プールを使用するための最良の戦略は次のとおりです。
ソケットを失敗に捨て、それらを再利用しないか、リクエスト応答管理が厄介になることが重要です。
接続プール：
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_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 ();
}ライブラリは、内部で実装された基本的なロガーインターフェイスを使用します。 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);これにより、適切な署名でコールバックを使用するロガーインスタンスを上書きすることができます。これらのタイプは次のように定義されます。
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これらすべてのコマンドは、あなたがストリームクライアントルートフォルダーにあると仮定します
RelWithDebInfo 。ONで。OFFOFF 。OFF 。OFF場合、このオプションが設定されます。2020年にTinkoff.ruで開発されました。
Apacheライセンス2.0ライセンスに基づいて区別されます。また、https://www.apache.org/licenses/license-2.0でこのライセンスを取得することもできます。
著者[email protected]
現在のメンテナー[email protected]、[email protected]
