Socket.BeginReceiveMessageFrom メソッド

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

Socket.BeginReceiveMessageFrom メソッド

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

指定した SocketFlags を使用し、指定したバイト数のデータの非同期受信を開始して、データ バッファ内の指定した位置に格納します。さらに、エンドポイントとパケット情報を格納します。

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

Visual Basic (宣言)

Public Function BeginReceiveMessageFrom ( _
    buffer As Byte(), _
    offset As Integer, _
    size As Integer, _
    socketFlags As SocketFlags, _
    ByRef remoteEP As EndPoint, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult

Visual Basic (使用法)

Dim instance As Socket
Dim buffer As Byte()
Dim offset As Integer
Dim size As Integer
Dim socketFlags As SocketFlags
Dim remoteEP As EndPoint
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginReceiveMessageFrom(buffer, offset, size, socketFlags,
 remoteEP, callback, state)

C#

public IAsyncResult BeginReceiveMessageFrom (
    byte[] buffer,
    int offset,
    int size,
    SocketFlags socketFlags,
    ref EndPoint remoteEP,
    AsyncCallback callback,
    Object state
)

C++

public:
IAsyncResult^ BeginReceiveMessageFrom (
    array<unsigned char>^ buffer, 
    int offset, 
    int size, 
    SocketFlags socketFlags, 
    EndPoint^% remoteEP, 
    AsyncCallback^ callback, 
    Object^ state
)

J#

public IAsyncResult BeginReceiveMessageFrom (
    byte[] buffer, 
    int offset, 
    int size, 
    SocketFlags socketFlags, 
    /** @ref */ EndPoint remoteEP, 
    AsyncCallback callback, 
    Object state
)

JScript

JScript では、値型の引数は参照渡しされません。

パラメータ

buffer

受信したデータのストレージ場所となる Byte 型の配列。

offset

データを格納する、bufferパラメータ内の、インデックス番号が 0 から始まる位置。

size

受信するバイト数。

socketFlags

SocketFlags 値のビットごとの組み合わせ。

remoteEP

データのソースを表す EndPoint。

callback

AsyncCallback デリゲート。

state

この要求のステータス情報を格納するオブジェクト。

戻り値
非同期の読み取りを参照する IAsyncResult。

例外

例外の種類	条件
ArgumentNullException	buffer が null 参照 (Visual Basic では Nothing) です。 または remoteEP が null 参照 (Visual Basic では Nothing) です。
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ArgumentOutOfRangeException	offset が 0 未満です。 または offset が buffer の長さを超えています。 または size が 0 未満です。 または size が、buffer の長さから offset パラメータの値を引いた値を超えています。
ObjectDisposedException	Socket は閉じられています。
NotSupportedException	Windows 2000 以前のオペレーティング システムです。このメソッドを使用するには、Windows XP が必要です。

解説

非同期の受信操作は、EndReceiveMessageFrom メソッドを呼び出して終了させる必要があります。このメソッドは、通常、asyncCallback デリゲートによって呼び出されます。

このメソッドは、操作が完了するまでブロックしません。操作が完了するまでブロックするには、ReceiveMessageFrom メソッドを使用します。

保留中の BeginReceiveMessageFrom をキャンセルするには、Close メソッドを呼び出します。

非同期プログラミング モデルの使用法の詳細については、「同期メソッドの非同期呼び出し」を参照してください。

このメソッドは、buffer パラメータにデータを読み込み、データの送信元のリモート ホスト エンドポイントと受信パケットに関する情報をキャプチャします。このエンドポイントの取得方法については、EndReceiveFrom のトピックを参照してください。このメソッドは、不明なホストまたは複数のホストからコネクションレスのデータグラムを非同期的に受信する場合に便利です。

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

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

メモ
非同期の Socket メソッドでは、実行コンテキスト (セキュリティ コンテキスト、偽装ユーザー、および呼び出し元コンテキスト) がキャッシュされます。特定のコンテキスト (特定の非同期 Socket メソッド、特定の Socket インスタンス、および特定のコールバック) を一度使用すると、2 回目以降は、パフォーマンスが向上します。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
Socket クラス
Socket メンバ
System.Net.Sockets 名前空間