Socket.Poll メソッドとは何？わかりやすく解説 Weblio辞書

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

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

Socket.Poll メソッド

Socket のステータスを確認します。

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

Visual Basic (宣言)

Public Function Poll ( _
    microSeconds As Integer, _
    mode As SelectMode _
) As Boolean

Visual Basic (使用法)

Dim instance As Socket
Dim microSeconds As Integer
Dim mode As SelectMode
Dim returnValue As Boolean

returnValue = instance.Poll(microSeconds, mode)

public bool Poll (
    int microSeconds,
    SelectMode mode
)

C++

public:
bool Poll (
    int microSeconds, 
    SelectMode mode
)

public boolean Poll (
    int microSeconds, 
    SelectMode mode
)

JScript

public function Poll (
    microSeconds : int, 
    mode : SelectMode
) : boolean

パラメータ

microSeconds: マイクロ秒単位の待機時間。

mode: SelectMode 値の 1 つ。

戻り値

モード	戻り値
SelectRead	Listen が呼び出されており、接続が保留中の場合は true。またはデータを読み取ることができる場合は true。または接続が閉じている、リセットされている、または終了している場合は true。それ以外の場合は、false を返します。
SelectWrite	Connect を処理し、接続に成功した場合は true。またはデータを送信できる場合は true。それ以外の場合は、false を返します。
SelectError	ブロックしない Connect を処理し、接続に失敗した場合は true。または OutOfBandInline が設定されておらず、帯域外データを使用できる場合は true。それ以外の場合は、false を返します。

モード

戻り値

SelectRead

Listen が呼び出されており、接続が保留中の場合は true。

または

データを読み取ることができる場合は true。

または

接続が閉じている、リセットされている、または終了している場合は true。

それ以外の場合は、false を返します。

SelectWrite

Connect を処理し、接続に成功した場合は true。

または

データを送信できる場合は true。

それ以外の場合は、false を返します。

SelectError

ブロックしない Connect を処理し、接続に失敗した場合は true。

または

OutOfBandInline が設定されておらず、帯域外データを使用できる場合は true。

それ以外の場合は、false を返します。

例外

例外の種類	条件
NotSupportedException	mode パラメータが、SelectMode 値の 1 つではありません。
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。以下の解説を参照してください。
ObjectDisposedException	Socket は閉じられています。

解説

Poll メソッドは Socket の状態を確認します。selectMode パラメータに SelectMode.SelectRead を指定して、Socket が読み取り可能かどうかを確認します。SelectMode.SelectWrite を指定して、Socket が書き込み可能かどうかを確認します。SelectMode.SelectError を使用してエラー条件を検出します。Poll は、指定した時間 (microseconds 単位) が経過するまで実行をブロックします。応答に対して無制限に待機する場合は、microSeconds パラメータを負の整数に設定します。複数ソケットの状態を確認する場合は、Select を使用するとよいでしょう。

メモ
SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラーコードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラーコードのマニュアルからエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

メモ
このメソッドは、ネットワークケーブルの断線や、リモートホストが不意にシャットダウンした場合など、一部の接続の問題は検出できません。データを送受信して、このようなエラーの検出を試行する必要があります。

メモ
このメンバは、アプリケーションでネットワークトレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

使用例

ソケットを作成してサーバーに接続し、Poll を使用してソケットのステータスをチェックするコード例を次に示します。

Visual Basic

'Creates the Socket for sending data over TCP.
Dim s As New Socket(AddressFamily.InterNetwork,
 SocketType.Stream, ProtocolType.Tcp)

' Connects to host using IPEndPoint.
s.Connect(EPhost)
If Not s.Connected Then
   strRetPage = "Unable to connect to host"
End If
' Use the SelectWrite enumeration to obtain Socket status.
If s.Poll(- 1, SelectMode.SelectWrite) Then
   Console.WriteLine("This Socket is writable.")
Else
   If s.Poll(- 1, SelectMode.SelectRead) Then
      Console.WriteLine(("This Socket is readable. "))
   Else
      If s.Poll(- 1, SelectMode.SelectError) Then
         Console.WriteLine("This Socket has an error.")
      End If
   End If

//Creates the Socket for sending data over TCP.
Socket s = new Socket(AddressFamily.InterNetwork, SocketType.Stream
,
   ProtocolType.Tcp );
 
// Connects to host using IPEndPoint.
s.Connect(EPhost);
if (!s.Connected)
{
   strRetPage = "Unable to connect to host";
}
// Use the SelectWrite enumeration to obtain Socket status.
 if(s.Poll(-1, SelectMode.SelectWrite)){
      Console.WriteLine("This Socket is writable.");
 }
 else if (s.Poll(-1, SelectMode.SelectRead)){
        Console.WriteLine("This Socket is readable." );
 }
 else if (s.Poll(-1, SelectMode.SelectError)){
      Console.WriteLine("This Socket has an error.");
 }

C++

//Creates the Socket for sending data over TCP.
Socket^ s = gcnew Socket( AddressFamily::InterNetwork, SocketType::Stream,
   ProtocolType::Tcp );

// Connects to host using IPEndPoint.
s->Connect( EPhost );
if ( !s->Connected )
{
   strRetPage = "Unable to connect to host";
}
// Use the SelectWrite enumeration to obtain Socket status.
if ( s->Poll( -1, SelectMode::SelectWrite ) )
{
   Console::WriteLine( "This Socket is writable." );
}
else if ( s->Poll(  -1, SelectMode::SelectRead
 ) )
{
   Console::WriteLine( "This Socket is readable." );
}
else if ( s->Poll(  -1, SelectMode::SelectError
 ) )
{
   Console::WriteLine( "This Socket has an error." );
}

//Creates the Socket for sending data over TCP.
Socket s = new Socket(AddressFamily.InterNetwork, SocketType.Stream
, 
    ProtocolType.Tcp);
// Connects to host using IPEndPoint.
s.Connect(epHost);
if (!(s.get_Connected())) {
    strRetPage = "Unable to connect to host";
}
// Use the SelectWrite enumeration to obtain Socket status.
if (s.Poll(-1, SelectMode.SelectWrite)) {
    Console.WriteLine("This Socket is writable.");
}
else {
    if (s.Poll(-1, SelectMode.SelectRead)) {
        Console.WriteLine("This should not print."
            + "Because this is not a listening Socket,"
            + " no incoming connecton requests are expected. ");
    }
    else {
        if (s.Poll(-1, SelectMode.SelectError)) {
            Console.WriteLine("This Socket has an error.");
        }
    }
}