Socket クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
Barke ソケット インターフェイスを実装します。
public ref class Socket : IDisposablepublic class Socket : IDisposabletype Socket = class
interface IDisposablePublic Class Socket
Implements IDisposable- 継承
-
Socket
- 実装
例
次の例は、 Socket クラスを使用して HTTP サーバーにデータを送信し、標準出力に ASCII 応答を出力する方法を示しています。 次の使用例は、ページ全体を受信するまで呼び出し元のスレッドをブロックします。
private static void SendHttpRequest(Uri? uri = null, int port = 80)
{
uri ??= new Uri("http://example.com");
// Construct a minimalistic HTTP/1.1 request
byte[] requestBytes = Encoding.ASCII.GetBytes(@$"GET {uri.AbsoluteUri} HTTP/1.0
Host: {uri.Host}
Connection: Close
");
// Create and connect a dual-stack socket
using Socket socket = new Socket(SocketType.Stream, ProtocolType.Tcp);
socket.Connect(uri.Host, port);
// Send the request.
// For the tiny amount of data in this example, the first call to Send() will likely deliver the buffer completely,
// however this is not guaranteed to happen for larger real-life buffers.
// The best practice is to iterate until all the data is sent.
int bytesSent = 0;
while (bytesSent < requestBytes.Length)
{
bytesSent += socket.Send(requestBytes, bytesSent, requestBytes.Length - bytesSent, SocketFlags.None);
}
// Do minimalistic buffering assuming ASCII response
byte[] responseBytes = new byte[256];
char[] responseChars = new char[256];
while (true)
{
int bytesReceived = socket.Receive(responseBytes);
// Receiving 0 bytes means EOF has been reached
if (bytesReceived == 0) break;
// Convert byteCount bytes to ASCII characters using the 'responseChars' buffer as destination
int charCount = Encoding.ASCII.GetChars(responseBytes, 0, bytesReceived, responseChars, 0);
// Print the contents of the 'responseChars' buffer to Console.Out
Console.Out.Write(responseChars, 0, charCount);
}
}
次の例では、タスク ベースの非同期 API を使用するのと同じ HTTP GET シナリオを示しながら、 CancellationToken を非同期メソッドに転送し、操作全体を取り消すことができます。
Tip
Socket通常、 CancellationToken を受け取らない非同期メソッドは、ヒープに割り当てられた Taskを返します。 取り消し可能なオーバーロードは常に ValueTask返されます。これを使用すると、高パフォーマンス コードでの割り当てを減らすことができます。
private static async Task SendHttpRequestAsync(Uri? uri = null, int port = 80, CancellationToken cancellationToken = default)
{
uri ??= new Uri("http://example.com");
// Construct a minimalistic HTTP/1.1 request
byte[] requestBytes = Encoding.ASCII.GetBytes(@$"GET {uri.AbsoluteUri} HTTP/1.1
Host: {uri.Host}
Connection: Close
");
// Create and connect a dual-stack socket
using Socket socket = new Socket(SocketType.Stream, ProtocolType.Tcp);
await socket.ConnectAsync(uri.Host, port, cancellationToken);
// Send the request.
// For the tiny amount of data in this example, the first call to SendAsync() will likely deliver the buffer completely,
// however this is not guaranteed to happen for larger real-life buffers.
// The best practice is to iterate until all the data is sent.
int bytesSent = 0;
while (bytesSent < requestBytes.Length)
{
bytesSent += await socket.SendAsync(requestBytes.AsMemory(bytesSent), SocketFlags.None);
}
// Do minimalistic buffering assuming ASCII response
byte[] responseBytes = new byte[256];
char[] responseChars = new char[256];
while (true)
{
int bytesReceived = await socket.ReceiveAsync(responseBytes, SocketFlags.None, cancellationToken);
// Receiving 0 bytes means EOF has been reached
if (bytesReceived == 0) break;
// Convert byteCount bytes to ASCII characters using the 'responseChars' buffer as destination
int charCount = Encoding.ASCII.GetChars(responseBytes, 0, bytesReceived, responseChars, 0);
// Print the contents of the 'responseChars' buffer to Console.Out
await Console.Out.WriteAsync(responseChars.AsMemory(0, charCount), cancellationToken);
}
}
注釈
この API の詳細については、「Socket の 補足 API 解説」を参照してください。
コンストラクター
| 名前 | 説明 |
|---|---|
| Socket(AddressFamily, SocketType, ProtocolType) |
指定したアドレス ファミリ、ソケットの種類、プロトコルを使用して、 Socket クラスの新しいインスタンスを初期化します。 |
| Socket(SafeSocketHandle) |
指定したソケット ハンドルの Socket クラスの新しいインスタンスを初期化します。 |
| Socket(SocketInformation) |
Socketから返された指定した値を使用して、DuplicateAndClose(Int32) クラスの新しいインスタンスを初期化します。 |
| Socket(SocketType, ProtocolType) |
指定したソケットの種類とプロトコルを使用して、 Socket クラスの新しいインスタンスを初期化します。 オペレーティング システムが IPv6 をサポートしている場合、このコンストラクターはデュアル モード ソケットを作成します。それ以外の場合は、IPv4 ソケットが作成されます。 |
プロパティ
| 名前 | 説明 |
|---|---|
| AddressFamily |
Socketのアドレス ファミリを取得します。 |
| Available |
ネットワークから受信され、読み取ることができるデータの量を取得します。 |
| Blocking |
Socketがブロック モードであるかどうかを示す値を取得または設定します。 |
| Connected |
最後のSocket操作またはSend操作の時点で、Receiveがリモート ホストに接続されているかどうかを示す値を取得します。 |
| DontFragment |
Socketでインターネット プロトコル (IP) データグラムをフラグメント化できるかどうかを示す値を取得または設定します。 |
| DualMode |
Socketが IPv4 と IPv6 の両方に使用されるデュアル モード ソケットであるかどうかを示す値を取得または設定します。 |
| EnableBroadcast | |
| ExclusiveAddressUse |
Socketがポートにバインドするプロセスを 1 つだけ許可するかどうかを示す値を取得または設定します。 |
| Handle |
Socketのオペレーティング システム ハンドルを取得します。 |
| IsBound |
Socketが特定のローカル ポートにバインドされているかどうかを示す値を取得します。 |
| LingerState |
保留中のすべてのデータを送信しようとしたときに、 Socket がソケットの閉じるのを遅らせるかどうかを示す値を取得または設定します。 |
| LocalEndPoint |
ローカル エンドポイントを取得します。 |
| MulticastLoopback |
送信マルチキャスト パケットを送信側アプリケーションに配信するかどうかを指定する値を取得または設定します。 |
| NoDelay | |
| OSSupportsIPv4 |
基になるオペレーティング システムとネットワーク アダプターがインターネット プロトコル バージョン 4 (IPv4) をサポートしているかどうかを示します。 |
| OSSupportsIPv6 |
基になるオペレーティング システムとネットワーク アダプターがインターネット プロトコル バージョン 6 (IPv6) をサポートしているかどうかを示します。 |
| OSSupportsUnixDomainSockets |
基になるオペレーティング システムが Unix ドメイン ソケットをサポートしているかどうかを示します。 |
| ProtocolType |
Socketのプロトコルの種類を取得します。 |
| ReceiveBufferSize |
Socketの受信バッファーのサイズを指定する値を取得または設定します。 |
| ReceiveTimeout |
同期 Receive 呼び出しがタイムアウトになる時間を指定する値を取得または設定します。 |
| RemoteEndPoint |
リモート エンドポイントを取得します。 |
| SafeHandle |
現在のSocket オブジェクトがカプセル化するソケット ハンドルを表すSafeSocketHandleを取得します。 |
| SendBufferSize |
Socketの送信バッファーのサイズを指定する値を取得または設定します。 |
| SendTimeout |
同期 Send 呼び出しがタイムアウトになる時間を指定する値を取得または設定します。 |
| SocketType |
Socketの型を取得します。 |
| SupportsIPv4 |
古い.
古い.
古い.
現在のホストで IPv4 サポートが使用可能で有効になっているかどうかを示す値を取得します。 |
| SupportsIPv6 |
古い.
古い.
古い.
フレームワークが特定の古い Dns メンバーに対して IPv6 をサポートするかどうかを示す値を取得します。 |
| Ttl |
Socketによって送信されるインターネット プロトコル (IP) パケットの Time To Live (TTL) 値を指定する値を取得または設定します。 |
| UseOnlyOverlappedIO |
古い.
ソケットで重複 I/O モードのみを使用するかどうかを指定する値を取得または設定します。 .NET 5 以降 (.NET Core バージョンを含む) では、値は常に |
メソッド
明示的なインターフェイスの実装
| 名前 | 説明 |
|---|---|
| IDisposable.Dispose() |
この API は製品インフラストラクチャをサポートします。コードから直接使用するものではありません。 Socketで使用されているすべてのリソースを解放します。 |
拡張メソッド
適用対象
スレッド セーフ
Socket インスタンスで送受信操作を同時に実行しても安全ですが、複数の送受信呼び出しを同時に発行することはお勧めしません。 基になるプラットフォームの実装によっては、大規模またはマルチバッファーの送受信に対して意図しないデータ インターリーブが発生する可能性があります。
