stream client 다운로드 - stream client 소스 코드 다운로드

스트림 클라이언트

이는 원격 엔드 포인트로 데이터 전송을 쉽게 구성하고 구현할 수있는 클라이언트 측 네트워크 프리미티브를 제공하는 가볍고 헤더 전용 부스트 기반 라이브러리입니다.

이 라이브러리 :

Boost.asio에서 영감을 얻고 지어졌습니다.
커넥터 및 연결 풀로 높은 수준의 구조를 제공합니다.
TCP / UDP / SSL / HTTP / HTTPS 프로토콜을 지원합니다.
boost :: asio :: IP Ones와 동일한 인터페이스를 가진 소켓을 사용합니다.
모든 작업에 대해 투명한 시간 초과/마감일 제어를 허용합니다.
HTTP 프로토콜을 사용하려는 경우 1.65+ 또는 1.66+ 부스트가 필요합니다.

왜

클라이언트로서 다른 서비스와 통신하는 C ++에 소프트웨어를 작성하는 경우 이미 문제가 발생했을 것입니다. 모든 관련 서비스에 네트워크 전송을 제공하기 위해 연결 계층을 구현해야합니다. 이것이 바로이 도서관이 해결하려는 목표입니다.

사용 방법

소켓

소켓은 boost::asio::basic_socket 위에 구현되며 타임 아웃 컨트롤이있는 클래스를 제공하므로 대부분의 경우 마감일 또는 시간 초과로 send () / receing () / write_some () / read_some ()을 호출하는 것이 충분합니다. I/O 작업에 제공되는 데이터는 boost::asio::buffer 로 포장되어야합니다. 기본적 으로이 클라이언트는 시간 초과 포장 된 boost::asio::ip 소켓이며 동일한 인터페이스를 가지고 있습니다.

클라이언트 스트림 클래스 :

stream_client::tcp_client 일반 TCP 스트림 소켓 클라이언트. write_some () / read_some () 와 함께 전체 버퍼의 승인 된 전송에 대한 send () / rececive () 를 지원하여 적어도 무언가를 전송합니다.
stream_client::udp_client 일반 UDP 소켓 클라이언트. UDP 사양에 따라 승인없이 send () / receing () 만 지원합니다.
stream_client::ssl::ssl_client -SSL 암호화 TCP 클라이언트. tcp_client plus ssl 핸드 셰이크 및 컨텍스트 제어와 동일한 기능을 갖습니다.
stream_client::http::http_client http 클라이언트. boost::beast::http::parser and boost::beast::http::serializer 로 tcp_client 랩핑합니다.
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 Resolver

Resolver는 동일한 아이디어를 중심으로 구현됩니다. 동기화, 시간이 정해진 DNS Resolver는 boost::asio::ip::basic_resolver 사용하여 지정된 타임 아웃 내에서 실제 해상도를 수행합니다.

단일 매개 변수 - 결과 프로토콜이있는 클래스 템플릿이며, 관심있는 IPv4, IPv6 또는 둘 다에 관심이있는 IP 엔드 포인트 유형을 지정할 수도 있습니다. 소켓 작업과 유사한 서명을 갖는 Resolve () 호출로 수행 된 해상도 - 시간 초과/마감일을 지정하거나 기본값을 사용할 수 있습니다.

리졸버 클래스 :

stream_client::resolver::tcp_resolver TCP 엔드 포인트의 반복기를 반환하는 Resolver.
stream_client::resolver::udp_resolver UDP 엔드 포인트의 반복기를 반환하는 Resolver.

예

 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 Resolver의 작업은 배경 스레드로 싸여있어 생성시 또는 새 소켓을 여는 데 오류가 발생한 경우.

목표 종말점 DNS 결과에서 무작위로 선택된 새 소켓을 열려면 원격 호스트와의 커넥터 균형을 유지합니다. 또한 커넥터를 통해 새로운 소켓의 해상도, 연결 및 I/O 작동에 대한 별도의 시간 초과를 지정할 수 있습니다.

커넥터 클래스 :

stream_client::connector::tcp_connector -tcp connector, stream_client::tcp_client 소켓을 얻습니다.
stream_client::connector::udp_connector -UDP Connector, stream_client::udp_client 소켓을 얻습니다.
stream_client::connector::ssl_connector -tcp connector, stream_client::ssl::ssl_client 소켓을 얻습니다.
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 () 을 얻을 수 있습니다.

수영장을 리필하기위한 두 가지 전략이 있습니다.

greedy ( 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() 함수를 사용하여 로거 레벨을 수정할 수 있습니다.

이 레벨은 지원됩니다.

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

이 모든 명령은 스트림 클라이언트 루트 폴더에 있다고 가정합니다.

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에 의해 설정되었습니다.