SslStream.BeginRead メソッド

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

SslStream.BeginRead メソッド

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

ストリームからデータを読み取り、指定した配列に格納する非同期読み取り操作を開始します。

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

Visual Basic (宣言)

Public Overrides Function
 BeginRead ( _
    buffer As Byte(), _
    offset As Integer, _
    count As Integer, _
    asyncCallback As AsyncCallback, _
    asyncState As Object _
) As IAsyncResult

Visual Basic (使用法)

Dim instance As SslStream
Dim buffer As Byte()
Dim offset As Integer
Dim count As Integer
Dim asyncCallback As AsyncCallback
Dim asyncState As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginRead(buffer, offset, count, asyncCallback, asyncState)

C#

public override IAsyncResult BeginRead (
    byte[] buffer,
    int offset,
    int count,
    AsyncCallback asyncCallback,
    Object asyncState
)

C++

public:
virtual IAsyncResult^ BeginRead (
    array<unsigned char>^ buffer, 
    int offset, 
    int count, 
    AsyncCallback^ asyncCallback, 
    Object^ asyncState
) override

J#

public IAsyncResult BeginRead (
    byte[] buffer, 
    int offset, 
    int count, 
    AsyncCallback asyncCallback, 
    Object asyncState
)

JScript

public override function BeginRead (
    buffer : byte[], 
    offset : int, 
    count : int, 
    asyncCallback : AsyncCallback, 
    asyncState : Object
) : IAsyncResult

パラメータ

buffer

ストリームから読み取ったバイトを受け取る Byte 配列。

offset

このストリームから読み取ったデータの格納を開始する位置を示す、buffer 内のインデックス番号が 0 から始まる位置。

count

ストリームから読み取る最大バイト数。

asyncCallback

読み取り操作の完了時に呼び出すメソッドを参照する AsyncCallback デリゲート。

asyncState

読み取り操作に関する情報を格納するユーザー定義のオブジェクト。このオブジェクトは、操作の完了時に asyncCallback デリゲートに渡されます。

戻り値
非同期操作のステータスを示す IAsyncResult オブジェクト。

例外

例外の種類	条件
ArgumentNullException	buffer が null 参照 (Visual Basic では Nothing) です。
ArgumentException	offset < 0. または offset が buffer の長さを超えています。 または offset と count の合計が buffer の長さを超えています。
IOException	読み取り操作に失敗しました。 または 暗号化が使用されていますが、データを復号化できませんでした。
NotSupportedException	既に実行中の読み取り操作が存在します。
ObjectDisposedException	このオブジェクトは閉じられています。
InvalidOperationException	認証が行われていません。

解説

暗号化や署名が有効になっている場合、読み取り操作では基になるストリームからのデータの読み取り、データの整合性チェック、データの復号化が行われます。非同期読み取り操作は、EndRead メソッドを呼び出して終了させる必要があります。通常、このメソッドは asyncCallback デリゲートによって呼び出されます。

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

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

SslStream クラスは、複数の読み取り操作の同時実行をサポートしていません。

このメソッドは、正常に認証されるまで呼び出すことはできません。認証するには、AuthenticateAsClient、BeginAuthenticateAsClient、AuthenticateAsServer、BeginAuthenticateAsServer のいずれかのメソッドを呼び出します。

使用例

非同期読み取り操作を開始するコード例を次に示します。

C#

// readData and buffer holds the data read from the server.
// They is used by the ReadCallback method.
static StringBuilder readData = new StringBuilder();
static byte [] buffer = new byte[2048];

C#

static void WriteCallback(IAsyncResult ar)
{
    SslStream stream = (SslStream) ar.AsyncState;
    try 
    {
        Console.WriteLine("Writing data to the server.");
        stream.EndWrite(ar);
        // Asynchronously read a message from the server.
        stream.BeginRead(buffer, 0, buffer.Length, 
            new AsyncCallback(ReadCallback),
            stream);
    }
    catch (Exception writeException)
    {
        e = writeException;
        complete = true;
        return;
    }
}

読み取りが完了すると、次のメソッドが呼び出されます。

C#

static void ReadCallback(IAsyncResult ar)
{
    // Read the  message sent by the server.
    // The end of the message is signaled using the
    // "<EOF>" marker.
    SslStream stream = (SslStream) ar.AsyncState;
    int byteCount = -1;
    try 
    {
        Console.WriteLine("Reading data from the server.");
        byteCount = stream.EndRead(ar);
        // Use Decoder class to convert from bytes to UTF8
        // in case a character spans two buffers.
        Decoder decoder = Encoding.UTF8.GetDecoder();
        char[] chars = new char[decoder.GetCharCount(buffer,0,
 byteCount)];
        decoder.GetChars(buffer, 0, byteCount, chars,0);
        readData.Append (chars);
        // Check for EOF or an empty message.
        if (readData.ToString().IndexOf("<EOF>")
 == -1 && byteCount != 0)
        {
            // We are not finished reading.
            // Asynchronously read more message data from  the server.
            stream.BeginRead(buffer, 0, buffer.Length, 
                new AsyncCallback(ReadCallback),
                stream);
        } 
        else
        {
            Console.WriteLine("Message from the server: {0}", readData.ToString());
        }
    }
    catch (Exception readException)
    {
        e = readException;
        complete = true;
        return;
    }
    complete = true;
}

プラットフォーム

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

参照

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