IOControlCode 列挙体とは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

IOControlCode 列挙体

メモ : この列挙体は、.NET Framework version 2.0 で新しく追加されたものです。

IOControl メソッドでサポートされている I/O 制御コードを指定します。

名前空間: System.Net.Sockets
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Enumeration IOControlCode As Long

Visual Basic (使用法)

Dim instance As IOControlCode

public enum IOControlCode : long

C++

public enum class IOControlCode : long long

public enum IOControlCode

JScript

public enum IOControlCode

メンバ

	メンバ名	説明
	AbsorbRouterAlert	この値は、Winsock 2 の SIO_ABSORB_RTRALERT 定数に相当します。
	AddMulticastGroupOnInterface	インデックスで識別されるインターフェイスを使用して、マルチキャストグループに参加します。この制御コードは、Windows 2000 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_INDEX_ADD_MCAST 定数に相当します。
	AddressListChange	ソケットのプロトコルファミリのローカルインターフェイスのリストが変更されたときの通知の受信を有効にします。この制御コードは、Windows 2000 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_ADDRESS_LIST_CHANGE 定数に相当します。
	AddressListQuery	ソケットがバインドできるローカルインターフェイスのリストを返します。この制御コードは、Windows 2000 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_ADDRESS_LIST_QUERY 定数に相当します。
	AddressListSort	AddressListQuery フィールドで返される構造体をソートし、IPv6 アドレスのスコープ ID 情報を追加します。この制御コードは、Windows XP 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 SIO_ADDRESS_LIST_SORT 定数に相当します。
	AssociateHandle	このソケットを、対応するインターフェイスの指定したハンドルに関連付けます。詳細については、Winsock 2 リファレンスで適切なプロトコル仕様が記載された付録を参照するか、特定の対応するインターフェイスのドキュメントを参照してください。この IOCTL の代わりにコンポーネントオブジェクトモデル (COM: Component Object Model) を使用して、ソケットでサポートされている可能性がある他のインターフェイスの検出とトレースを行うことをお勧めします。この制御コードは、COM に対応していない、または何らかの理由で COM を使用できないシステム用の下位互換性を維持するために存在します。この値は、Winsock 2 の SIO_ASSOCIATE_HANDLE 定数に相当します。
	AsyncIO	データが受信を待機しているときの通知を有効にします。この値は、Winsock 2 の FIOASYNC 定数に相当します。
	BindToInterface	ソケットを指定したインターフェイスインデックスにバインドします。この制御コードは、Windows 2000 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_INDEX_BIND 定数に相当します。
	DataToRead	読み取りができるバイト数を返します。この値は、Winsock 2 の FIONREAD 定数に相当します。
	DeleteMulticastGroupFromInterface	マルチキャストグループからソケットを削除します。この制御コードは、Windows 2000 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_INDEX_ADD_MCAST 定数に相当します。
	EnableCircularQueuing	受信メッセージキューが満杯の場合、キューに格納されている最も古いデータグラムを受信データグラムで置き換えます。この値は、Winsock 2 の SIO_ENABLE_CIRCULAR_QUEUEING 定数に相当します。
	Flush	送信キューの内容を破棄します。この値は、Winsock 2 の SIO_FLUSH 定数に相当します。
	GetBroadcastAddress	現在のソケットのアドレスファミリのブロードキャストアドレスを格納している SOCKADDR 構造体を返します。返されたアドレスは、SendTo メソッドで使用できます。この値は、Winsock 2 の SIO_GET_BROADCAST_ADDRESS 定数に相当します。この値は、ユーザーデータグラムプロトコル (UDP: User Datagram Protocol) ソケットでだけ使用できます。
	GetExtensionFunctionPointer	Winsock 仕様の一部ではないプロバイダ固有の関数を取得します。関数はそれらのプロバイダによって割り当てられた GUID を使用して指定されます。この値は、Winsock 2 の SIO_GET_EXTENSION_FUNCTION_POINTER 定数に相当します。
	GetGroupQos	ソケットグループの QOS (Quality of Service) 属性を返します。この値は、今後使用するために予約されており、Winsock 2 の SIO_GET_GROUP_QOS 定数に相当します。
	GetQos	ソケットに関連付けられた QOS 構造体を取得します。この制御コードは、QOS 対応の伝送機能を提供しているプラットフォーム (Windows Me、Windows 2000、およびそれ以降) でだけサポートされます。この値は、Winsock 2 の SIO_GET_QOS 定数に相当します。
	KeepAliveValues	TCP Keep-alive パケットの送信とそれらの送信間隔を制御します。この制御コードは、Windows 2000 以降のオペレーティングシステムでサポートされます。追加情報については、RFC 1122 セクション 4.2.3.6 を参照してください。この値は、Winsock 2 の SIO_KEEPALIVE_VALS 定数に相当します。
	LimitBroadcasts	この値は、Winsock 2 の SIO_LIMIT_BROADCASTS 定数に相当します。
	MulticastInterface	発信マルチキャストパケットで使用するインターフェイスを設定します。インターフェイスはインデックスで識別されます。この制御コードは、Windows 2000 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_INDEX_MCASTIF 定数に相当します。
	MulticastScope	ルーターがマルチキャストパケットを転送できる回数 (有効期間 (TTL: Time to Live))、またはホップ数を制御します。この値は、Winsock 2 の SIO_MULTICAST_SCOPE 定数に相当します。
	MultipointLoopback	ソケットによって送信されたマルチキャストデータが、ソケットの受信キューの受信データとして表示されるかどうかを制御します。この値は、Winsock 2 の SIO_MULTIPOINT_LOOPBACK 定数に相当します。
	NamespaceChange	名前空間のクエリが無効になったときの通知を、ソケットが受け取るかどうかを制御します。この制御コードは、Windows XP 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_NSP_NOTIFY_CHANGE 定数に相当します。
	NonBlockingIO	ソケットのブロッキングの動作を制御します。この制御コードに指定された引数が 0 の場合、ソケットはブロッキングモードに設定されます。引数が 0 以外の場合、ソケットは非ブロッキングモードに設定されます。この値は、Winsock 2 の FIONBIO 定数に相当します。
	OobDataRead	受信を待機している帯域外データに関する情報を返します。この制御コードをストリームソケットで使用した場合、返される値は受信できるバイト数を示します。
	QueryTargetPnpHandle	基になるプロバイダの SOCKET ハンドルを取得します。このハンドルを使用して、プラグアンドプレイのイベント通知を受信できます。この制御コードは、Windows 2000 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_QUERY_TARGET_PNP_HANDLE 定数に相当します。
	ReceiveAll	ネットワーク上のすべての IPv4 パケットの受信を有効にします。ソケットは、アドレスファミリ InterNetwork を取得している必要があります。また、ソケットタイプは Raw、プロトコルタイプはIP である必要があります。現在のユーザーがローカルコンピュータの管理者グループに属していて、ソケットが特定のポートにバインドされている必要があります。この制御コードは、Windows 2000 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_RCVALL 定数に相当します。
	ReceiveAllIgmpMulticast	ネットワーク上のすべてのインターネットグループ管理プロトコル (IGMP) パケットの受信を有効にします。ソケットは、アドレスファミリ InterNetwork を取得している必要があります。また、ソケットタイプは Raw、プロトコルタイプはIgmp である必要があります。現在のユーザーがローカルコンピュータの管理者グループに属していて、ソケットが特定のポートにバインドされている必要があります。この制御コードは、Windows 2000 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_RCVALL_IGMPMCAST 定数に相当します。
	ReceiveAllMulticast	ネットワーク上のすべてのマルチキャスト IPv4 パケットの受信を有効にします。これらは、224.0.0.0 から 239.255.255.255 の範囲の終点アドレスを持ったパケットです。ソケットは、アドレスファミリ InterNetwork を取得している必要があります。また、ソケットタイプは Raw、プロトコルタイプは Udp である必要があります。現在のユーザーがローカルコンピュータの管理者グループに属していて、ソケットが特定のポートにバインドされている必要があります。この制御コードは、Windows 2000 以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_RCVALL_MCAST 定数に相当します。
	RoutingInterfaceChange	リモートエンドポイントにアクセスするために使用するローカルインターフェイスが変更されたときの通知の受信を有効にします。この値は、Winsock 2 の SIO_ROUTING_INTERFACE_CHANGE 定数に相当します。
	RoutingInterfaceQuery	指定したリモートアドレスに接続するために使用できるインターフェイスアドレスを返します。この値は、Winsock 2 の SIO_ROUTING_INTERFACE_QUERY 定数に相当します。
	SetGroupQos	ソケットグループの QOS (Quality of Service) 属性を設定します。この値は、今後使用するために予約されており、Winsock 2 の SIO_SET_GROUP_QOS 定数に相当します。
	SetQos	ソケットの QOS (Quality of Service) 属性を設定します。QOS は、ソケットの帯域幅の要件を定義します。この制御コードは、Windows Me、Windows 2000、およびそれ以降のオペレーティングシステムでサポートされます。この値は、Winsock 2 の SIO_SET_QOS 定数に相当します。
	TranslateHandle	対応するインターフェイスのコンテキスト内で有効なソケットのハンドルを返します。この値は、Winsock 2 の SIO_TRANSLATE_HANDLE 定数に相当します。
	UnicastInterface	発信ユニキャストパケットで使用するインターフェイスを設定します。この値は、Winsock 2 の SIO_UCAST_IF 定数に相当します。

解説

IOControlCode 列挙体には、ソケットの操作モードを指定する名前付きの値が用意されています。これらの値は、Windows Socket 2 (Winsock 2) WSAIoctl 関数に渡される制御コードです。

使用例

DataToRead パラメータ値を使用して IOControl(IOControlCode,Byte[],Byte[]) メソッドを呼び出し、その結果と Available プロパティにアクセスした場合を比較するコード例を次に示します。

static void DisplayPendingByteCount(Socket
 s)
{
    byte[] outValue = BitConverter.GetBytes(0);

    // Check how many bytes have been received.
    s.IOControl(IOControlCode.DataToRead, null, outValue);

    uint bytesAvailable = BitConverter.ToUInt32(outValue, 0);
    Console.Write("server has {0} bytes pending. ", 
        bytesAvailable);
    Console.WriteLine("Available property says {1}.",
                     s.Available);

    return;
}

C++

void DisplayPendingByteCount( Socket^ s )
{
   array<Byte>^ outValue = BitConverter::GetBytes( 0 );
   
   // Check how many bytes have been received.
   s->IOControl( IOControlCode::DataToRead, nullptr, outValue );

   UInt32 bytesAvailable = BitConverter::ToUInt32( outValue, 0 );
   Console::Write( "server has {0} bytes pending,",
      bytesAvailable );
   Console::WriteLine( "Available property says {1}.",
      s->Available );
   return;
}

static void DisplayPendingByteCount(Socket
 s)
{
    ubyte outValue[] = BitConverter.GetBytes(0);
    // Check how many bytes have been received.
    s.IOControl(IOControlCode.DataToRead, null, outValue);
    UInt32 bytesAvailable = BitConverter.ToUInt32(outValue, 0);
    //ToDo: Unsigned Integers not supported- converted to int
    Console.Write("server has {0} bytes pending. ",
        bytesAvailable.ToString());
    Console.WriteLine("Available property says {1}.", 
        (System.Int32)s.get_Available());
    return;
} //DisplayPendingByteCount