sockppダウンロード - sockppソースコードのダウンロード

sockpp

C/C++

Version 1.0.0

ダウンロード

ソックップ

シンプルでモダンな C++ ソケットライブラリ。

これは、他の言語でよく知られている概念であるsocket 、 acceptor,およびconnectorクラスを使用する、Berkeley ソケットライブラリのかなり低レベルの C++ ラッパーです。

基本socketクラスはシステムソケットハンドルをラップし、その有効期間を維持します。 C++ オブジェクトがスコープ外になると、基礎となるソケットハンドルが閉じられます。ソケットオブジェクトは通常、移動可能ですが、コピーはできません。 std::move()使用して、ソケットをあるスコープ (またはスレッド) から別のスコープ (またはスレッド) に転送できます。

このライブラリは現在、Linux、Mac、および Windows 上の IPv4 および IPv6 をサポートしています。他の *nix および POSIX システムは、ほとんどまたはまったく変更を加えなくても動作するはずです。

Unix ドメインソケットは、OS が実装されている *nix システムで使用できます。

最近、OpenSSL または MbedTLS ライブラリを使用したセキュアソケットのサポートが基本的な範囲で追加されました。これは近い将来さらに拡大される予定です。

SocketCAN パッケージを使用した Linux 上の CAN バスプログラミングの実験的なサポートもあります。これにより、CAN メッセージプロトコルによって定められた制限付きで、CAN バスアダプタにネットワークインターフェイスが提供されます。

ライブラリ内のすべてのコードは、 sockpp C++ 名前空間内に存在します。

「master」ブランチは v2.0 API への移行を開始しており、現時点では特に不安定です。一般的に使用する場合は、最新リリースをダウンロードすることをお勧めします。

CMake を使用してアプリを構築する

ライブラリは、インストールされている場合、通常はfind_package(sockpp)で検出できます。名前空間Sockppとライブラリ名sockppを使用します。

単純なCMakeLists.txtファイルは次のようになります。

 cmake_minimum_required(VERSION 3.12)
project(mysock VERSION 1.0.0)

find_package(sockpp REQUIRED)

add_executable(mysock mysock.cpp)
target_link_libraries(mysock Sockpp::sockpp)

貢献する

貢献は受け入れられ、感謝されます。新しい不安定な作業は、 developブランチで行われます。すべてのプルリクエストは、 masterではなく、そのブランチに対して送信してください。

詳細については、CONTRIBUTING.md を参照してください。

図書館の建設

CMake はサポートされているビルドシステムです。

要件：

準拠した C++-14 コンパイラ。
- gcc v5.0 以降 (または) Clang v3.8 以降。
- Windows ではVisual Studio 2015以降。
CMake v3.12 以降。
Doxygen (オプション) API ドキュメントを生成します。
Catch2 (オプション) v2.x または v3.x で単体テストを構築および実行します。

デフォルトのオプションを使用してビルドするには:

 $ cd sockpp
$ cmake -Bbuild .
$ cmake --build build/

インストールするには:

 $ cmake --build build/ --target install

ビルドオプション

このライブラリには、CMake を介したいくつかのビルドオプションがあり、静的ライブラリまたは共有 (動的) ライブラリ、あるいはその両方の作成を選択できます。また、サンプルオプションを構築することもできます。Doxygen がインストールされている場合は、ドキュメントの作成に使用できます。

変数	デフォルト値	説明
SOCKPP_BUILD_SHARED	の上	共有ライブラリを構築するかどうか
SOCKPP_BUILD_STATIC	オフ	静的ライブラリをビルドするかどうか
SOCKPP_BUILD_DOCUMENTATION	オフ	HTML ベースの API ドキュメントを作成してインストールします ( Doxygen が必要)
SOCKPP_BUILD_EXAMPLES	オフ	サンプルプログラムをビルドする
SOCKPP_BUILD_TESTS	オフ	単体テストを構築する ( Catch2が必要)
SOCKPP_WITH_CAN	オフ	SocketCAN サポートを含めます。 (Linuxのみ)

これらは、CMake 構成コマンドの「-D」スイッチを使用して設定します。たとえば、ドキュメントとサンプルアプリを構築するには、次のようにします。

 $ cd sockpp
$ cmake -Bbuild -DSOCKPP_BUILD_DOCUMENTATION=ON -DSOCKPP_BUILD_EXAMPLES=ON .
$ cmake --build build/

セキュアソケット

セキュアソケットサポートを備えたライブラリを構築するには、サポートを提供する TLS ライブラリを選択する必要があります。現在、 OpenSSLまたはMbedTLS を使用できます。

ビルドを構成するときに次のいずれかを選択します。

変数	デフォルト値	説明
SOCKPP_WITH_MBEDTLS	オフ	MbedTLS による安全なソケット
SOCKPP_WITH_OPENSSL	オフ	OpenSSL による安全なソケット

MbedTLS

sockppライブラリは現在、MbedTLS v3.3 をサポートしています。そのライブラリを構築するときは、次の構成オプションを構成ファイルinclude/mbedtls/mbedtls_config.hで定義する必要があります。

 #define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK

スレッド化をサポートするには:

 #define MBEDTLS_THREADING_PTHREAD
#define MBEDTLS_THREADING_C

そして、CMake ビルドオプションを設定します。

 LINK_WITH_PTHREAD:BOOL=ON

構成ファイル内のオプションはファイル内にすでに存在しているはずですが、デフォルトではコメントアウトされていることに注意してください。コメントを外して保存し、ビルドするだけです。

OpenSSL

sockpp OpenSSL ラッパーは現在、OpenSSL v3.0 で構築およびテストされています。

TCPソケット

TCP およびその他の「ストリーミング」ネットワークアプリケーションは通常、サーバーまたはクライアントとして設定されます。アクセプタは、TCP/ストリーミングサーバーを作成するために使用されます。アドレスをバインドし、既知のポートをリッスンして受信接続を受け入れます。接続が受け入れられると、新しいストリーミングソケットが作成されます。その新しいソケットは、直接処理することも、処理のためにスレッド (またはスレッドプール) に移動することもできます。

逆に、TCP クライアントを作成するには、コネクタオブジェクトが作成され、既知のアドレス (通常はホストとソケット) でサーバーに接続されます。接続すると、ソケットはストリーミングソケットとなり、直接読み取りと書き込みに使用できます。

IPv4 の場合、 tcp_acceptorクラスとtcp_connectorクラスはそれぞれサーバーとクライアントの作成に使用されます。これらは、 inet_addressクラスを使用して、32 ビットのホストアドレスと 16 ビットのポート番号で構成されるエンドポイントアドレスを指定します。

TCPサーバー: `tcp_acceptor`

tcp_acceptorは、サーバーをセットアップし、受信接続をリッスンするために使用されます。

 int16_t port = 12345;
sockpp::tcp_acceptor acc(port);

if (!acc)
    report_error(acc.last_error_str());

// Accept a new client connection
sockpp::tcp_socket sock = acc.accept();

通常、アクセプタは新しい接続を受け入れるループ内に存在し、それらを別のプロセス、スレッド、またはスレッドプールに渡してクライアントと対話します。標準 C++ では、これは次のようになります。

 while (true) {
    // Accept a new client connection
    sockpp::tcp_socket sock = acc.accept();

    if (!sock) {
        cerr << "Error accepting incoming connection: "
            << acc.last_error_str() << endl;
    }
    else {
        // Create a thread and transfer the new stream to it.
        thread thr(run_echo, std::move(sock));
        thr.detach();
    }
}

接続ごとのスレッド設計の危険性については十分に文書化されていますが、スレッドプールが利用可能な場合は、同じ手法を使用してソケットをスレッドプールに渡すことができます。

tcpechosvr.cpp の例を参照してください。

TCP クライアント: `tcp_connector`

TCP クライアントは、 tcp_connectorオブジェクトが作成されて接続され、その後、データの直接の読み取りと書き込みに使用できるという点で多少単純です。

 sockpp::tcp_connector conn;
int16_t port = 12345;

if (!conn.connect(sockpp::inet_address("localhost", port)))
    report_error(conn.last_error_str());

conn.write_n("Hello", 5);

char buf[16];
ssize_t n = conn.read(buf, sizeof(buf));

tcpecho.cpp の例を参照してください。

UDPソケット: `udp_socket`

UDP ソケットはコネクションレス通信に使用できます。

 sockpp::udp_socket sock;
sockpp::inet_address addr("localhost", 12345);

std::string msg("Hello there!");
sock.send_to(msg, addr);

sockpp::inet_address srcAddr;

char buf[16];
ssize_t n = sock.recv(buf, sizeof(buf), &srcAddr);

udpecho.cpp および udpechosvr.cpp の例を参照してください。

IPv6

次のクラスを使用して、同じスタイルのコネクタとアクセプタを IPv6 経由の TCP 接続に使用できます。

 inet6_address
tcp6_connector
tcp6_acceptor
tcp6_socket
udp6_socket

例は、examples/tcp ディレクトリにあります。

Unix ドメインソケット

Unix ドメインソケットを実装する *nix システム上のローカル接続にも同じことが当てはまります。そのためには、次のクラスを使用します。

 unix_address
unix_connector
unix_acceptor
unix_socket  (unix_stream_socket)
unix_dgram_socket

サンプルは、examples/unix ディレクトリにあります。

SocketCAN (Linux 上の CAN バス)

コントローラーエリアネットワーク (CAN バス) は、自動車または産業用機械の内部で通信するためにマイクロコントローラーによって通常使用される比較的単純なプロトコルです。 Linux にはSocketCANパッケージがあり、プロセスがユーザー空間のソケットを使用して物理 CAN バスインターフェイスへのアクセスを共有できるようになります。参照: Linux SocketCAN

最下位レベルでは、CAN デバイスは「フレーム」と呼ばれる個々のパケットをバス上の特定の数値アドレスに書き込みます。

たとえば、温度センサーを備えたデバイスは、次のように温度を定期的に読み取り、生の 32 ビット整数としてバスに書き込む可能性があります。

 can_address addr("CAN0");
can_socket sock(addr);

// The agreed ID to broadcast temperature on the bus
canid_t canID = 0x40;

while (true) {
    this_thread::sleep_for(1s);

    // Write the time to the CAN bus as a 32-bit int
    int32_t t = read_temperature();

    can_frame frame { canID, &t, sizeof(t) };
    sock.send(frame);
}

フレームを取得する受信側は次のようになります。

 can_address addr("CAN0");
can_socket sock(addr);

can_frame frame;
sock.recv(&frame);

実装の詳細

ソケットクラス階層は、基本socketクラスに基づいて構築されます。ほとんどの単純なアプリケーションは、おそらくsocketを直接使用せず、 tcp_connectorやtcp_acceptorなどの特定のアドレスファミリに対して定義された派生クラスを使用します。

ソケットオブジェクトは、基礎となる OS ソケットハンドルへのハンドルと、そのソケットで発生した最後のエラーのキャッシュされた値を保持します。ソケットハンドルは通常、整数のファイル記述子であり、開いているソケットの場合は値 >=0、開いていないソケットまたは無効なソケットの場合は -1 になります。開かれていないソケットに使用される値は定数INVALID_SOCKETとして定義されますが、オブジェクト自体が初期化されていない場合やエラー状態にある場合はfalseと評価されるため、通常は直接テストする必要はありません。一般的なエラーチェックは次のようになります。

 tcp_connector conn({"localhost", 12345});

if (!conn)
    cerr << conn.last_error_str() << std::endl;

各ソケットクラスのデフォルトのコンストラクターは何もせず、単純に基になるハンドルをINVALID_SOCKETに設定します。ソケットオブジェクトは作成されません。 connectorオブジェクトをアクティブに接続するか、 acceptorオブジェクトを開く呼び出しにより、基礎となる OS ソケットが作成され、要求された操作が実行されます。

通常、アプリケーションはライブラリを使用してほとんどの低レベル操作を実行できます。接続されていないソケットとバインドされていないソケットは、ほとんどのクラスで静的なcreate()関数を使用して作成し、それらのソケットを手動でバインドしてリッスンできます。

socket::handle()メソッドは、基礎となる OS ハンドルを公開します。このハンドルは、ライブラリによって公開されていないプラットフォーム API 呼び出しに送信できます。

スレッドの安全性

ソケットオブジェクトはスレッドセーフではありません。複数のスレッドでソケットからの読み取りまたはソケットへの書き込みを行う必要があるアプリケーションでは、アクセスを保護するためにstd::mutexなどの何らかの形式のシリアル化を使用する必要があります。

socketあるスレッドから別のスレッドに安全に移動できます。これは、1 つのスレッドを使用して受信接続を受け入れ、その後、新しいソケットを処理のために別のスレッドまたはスレッドプールに渡すサーバーの一般的なパターンです。これは次のように行うことができます。

 sockpp::tcp6_socket sock = acc.accept(&peer);

// Create a thread and transfer the new socket to it.
std::thread thr(handle_connection, std::move(sock));

この場合、 handle_connection は次のような値でソケットを受け取る関数になります。

 void handle_connection(sockpp::tcp6_socket sock) { ... }

socketコピーできないため、ソケットをこのような関数に移動するしかありません。

特にクライアントアプリケーションでは、1 つのスレッドでソケットから読み取りを行い、別のスレッドでソケットに書き込みを行うのが一般的なパターンです。この場合、基礎となるソケットハンドルはスレッドセーフであると見なされます (1 つの読み取りスレッドと 1 つの書き込みスレッド)。ただし、このシナリオでも、特にキャッシュされたエラー値が原因で、 sockpp::socketオブジェクトは依然としてスレッドセーフではありません。書き込みスレッドでは、読み取りスレッドで発生したエラーが認識される可能性があり、その逆も同様です。

この場合の解決策は、 socket::clone()メソッドを使用してソケットのコピーを作成することです。これは、システムのdup()関数または同様の関数を使用して、ソケットハンドルの複製コピーを持つ別のソケットを作成します。これには、ソケットの各コピーが独立した存続期間を維持できるという追加の利点があります。両方のオブジェクトがスコープ外になるまで、基礎となるソケットは閉じられません。

 sockpp::tcp_connector conn({host, port});

auto rdSock = conn.clone();
std::thread rdThr(read_thread_func, std::move(rdSock));

socket::shutdown()メソッドを使用すると、別のスレッドシグナリングメカニズムを必要とせずに、これらのオブジェクトの 1 つから別のオブジェクトにソケットを閉じる意図を伝えることができます。

tcpechomt.cpp の例を参照してください。

拡大する

追加情報

バージョン Version 1.0.0
タイプ C/C++
更新時間 2025-01-02
サイズ 229.38KB
から Github

sockpp

ソックップ

最新ニュース

アップデートを取得する

CMake を使用してアプリを構築する

貢献する

図書館の建設

要件：

ビルドオプション

セキュアソケット

MbedTLS

OpenSSL

TCPソケット

TCPサーバー: `tcp_acceptor`

TCP クライアント: `tcp_connector`

UDPソケット: `udp_socket`

IPv6

Unix ドメインソケット

SocketCAN (Linux 上の CAN バス)

実装の詳細

スレッドの安全性

vkhr

carma platform

jitify

qttabbar

kawaii gcc

cpp peglib

chat.petals.dev

GPT Prompt Templates

GPTyped

vkhr

carma platform

jitify

waymo open dataset

wp functions

slugify

sockpp

ソックップ

最新ニュース

アップデートを取得する

CMake を使用してアプリを構築する

貢献する

図書館の建設

要件：

ビルドオプション

セキュアソケット

MbedTLS

OpenSSL

TCPソケット

TCPサーバー: tcp_acceptor

TCP クライアント: tcp_connector

UDPソケット: udp_socket

IPv6

Unix ドメインソケット

SocketCAN (Linux 上の CAN バス)

実装の詳細

スレッドの安全性

TCPサーバー: `tcp_acceptor`

TCP クライアント: `tcp_connector`

UDPソケット: `udp_socket`