NetworkStream.BeginRead メソッド

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

NetworkStream.BeginRead メソッド

NetworkStream からの非同期の読み取りを開始します。

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

Visual Basic (宣言)

Public Overrides Function
 BeginRead ( _
    buffer As Byte(), _
    offset As Integer, _
    size As Integer, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult

Visual Basic (使用法)

Dim instance As NetworkStream
Dim buffer As Byte()
Dim offset As Integer
Dim size As Integer
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginRead(buffer, offset, size, callback, state)

C#

public override IAsyncResult BeginRead (
    byte[] buffer,
    int offset,
    int size,
    AsyncCallback callback,
    Object state
)

C++

public:
virtual IAsyncResult^ BeginRead (
    array<unsigned char>^ buffer, 
    int offset, 
    int size, 
    AsyncCallback^ callback, 
    Object^ state
) override

J#

public IAsyncResult BeginRead (
    byte[] buffer, 
    int offset, 
    int size, 
    AsyncCallback callback, 
    Object state
)

JScript

public override function BeginRead (
    buffer : byte[], 
    offset : int, 
    size : int, 
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

パラメータ

buffer

Byte 型の配列。NetworkStream から読み取られたデータを格納するメモリ内の場所です。

offset

データの格納を開始する buffer 内の場所。

size

NetworkStream から読み取るバイト数。

callback

BeginRead の完了時に実行される AsyncCallback デリゲート。

state

追加のユーザー定義のデータを格納するオブジェクト。

戻り値
非同期呼び出しを表す IAsyncResult。

例外

例外の種類	条件
ArgumentNullException	buffer が null 参照 (Visual Basic では Nothing) です。
ArgumentOutOfRangeException	offset が 0 未満です。 または offset が buffer の長さを超えています。 または size が 0 未満です。 または size が、buffer の長さから offset パラメータの値を引いた値を超えています。
IOException	基になっている Socket が閉じています。 または ネットワークからの読み取り中にエラーが発生しました。 または ソケットへのアクセス中にエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	NetworkStream が閉じています。

解説

BeginRead メソッドは受信ネットワーク バッファからの非同期のデータ読み取りを開始します。BeginRead メソッドを呼び出すと、個別の実行スレッド内でデータを受信できます。

AsyncCallback デリゲートを実装するコールバック メソッドを作成し、その名前を BeginRead メソッドに渡す必要があります。使用する state パラメータは、少なくとも NetworkStream を格納している必要があります。コールバック メソッド内で受信データを取得しなければならないため、読み取りバッファなどの有用な情報を保持するための小さなクラスまたは構造体を作成する必要があります。構造体またはクラスのインスタンスは、state パラメータを使用して BeginRead メソッドに渡します。

コールバック メソッドは EndRead メソッドを呼び出す必要があります。アプリケーションが BeginRead を呼び出すと、データが受信されるかエラーが発生するまで待機した後に、指定したコールバック メソッドが個別のスレッドを使用して実行され、EndRead は指定した NetworkStream がデータを読み取るか例外をスローするまでブロックします。BeginRead メソッドを呼び出してから元のスレッドをブロックする場合は、WaitOne メソッドを使用します。元のスレッドの実行を継続させるには、コールバック メソッドで Set を呼び出します。コールバック メソッドの記述に関する追加情報については、「Callback のサンプル」を参照してください。

BeginRead メソッドは、size パラメータで指定したバイト数までの、使用可能なデータをすべて読み取ります。

メモ
IOException が発生した場合は、InnerException プロパティをチェックして、この原因が SocketException かどうかを確認してください。その場合、ErrorCode プロパティを使用して特定のエラー コードを取得してください。エラーの詳細については、MSDN で Windows Socket Version 2 API のエラー コードのドキュメントを参照してください。

使用例

BeginRead を使用して、ネットワーク ストリームから非同期的にデータを読み取るコード例を次に示します。myReadCallBack メソッドは AsyncCallback デリゲートを実装しており、BeginRead の終了時に呼び出されます。

Visual Basic

' Check to see if this NetworkStream is readable.
If myNetworkStream.CanRead Then
   
   Dim myReadBuffer(1024) As Byte
   myNetworkStream.BeginRead(myReadBuffer, 0, myReadBuffer.Length, New
 AsyncCallback(AddressOf NetworkStream_ASync_Send_Receive.myReadCallBack),
 myNetworkStream)
   
   allDone.WaitOne()
Else
   Console.WriteLine("Sorry.  You cannot read from this NetworkStream.")
End If

C#

// Check to see if this NetworkStream is readable.
if(myNetworkStream.CanRead){
    
    byte[] myReadBuffer = new byte[1024];
    myNetworkStream.BeginRead(myReadBuffer, 0, myReadBuffer.Length, 
                                                 new AsyncCallback(NetworkStream_ASync_Send_Receive.myReadCallBack),
 
                                                 myNetworkStream);  

    allDone.WaitOne();
}
else{
     Console.WriteLine("Sorry.  You cannot read from this
 NetworkStream.");
}

C++

// Check to see if this NetworkStream is readable.
if ( myNetworkStream->CanRead )
{
   array<Byte>^myReadBuffer = gcnew array<Byte>(1024);
   myNetworkStream->BeginRead( myReadBuffer, 0, myReadBuffer->Length, gcnew
 AsyncCallback( &MyNetworkStreamClass::myReadCallBack ), myNetworkStream );
   allDone->WaitOne();
}
else
{
   Console::WriteLine( "Sorry.  You cannot read from this
 NetworkStream." );
}

J#

// Check to see if this NetworkStream is readable.
if (myNetworkStream.get_CanRead()) {
    ubyte myReadBuffer[] = new ubyte[1024];
    myNetworkStream.BeginRead(myReadBuffer, 0,
        myReadBuffer.get_Length(), 
        new AsyncCallback(NetworkStreamASyncSendReceive.
        MyReadCallBack), myNetworkStream);
    allDone.WaitOne();
}
else {
    Console.WriteLine("Sorry.  You cannot read from this
 "
        + "NetworkStream.");
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

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