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

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

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

NegotiateStream.BeginWrite メソッド

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

指定したバッファからストリームに Byte を書き込む非同期書き込み操作を開始します。

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

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As NegotiateStream
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.BeginWrite(buffer, offset, count, asyncCallback, asyncState)

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

C++

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

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

JScript

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

パラメータ

buffer: ストリームに書き込むバイトを提供する Byte 配列。

offset: ストリームに書き込むバイトの読み取りを開始する位置を示す、 buffer 内のインデックス番号が 0 から始まる位置。

count: buffer から読み取るバイト数を指定する Int32 値。

asyncCallback: 書き込み操作の完了時に呼び出すメソッドを参照する AsyncCallback デリゲート。

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

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

例外

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

解説

暗号化、署名、または暗号化と署名が有効になっている場合、このメソッドが、バッファからのデータの読み込み、読み込んだデータの暗号化、署名、または暗号化と署名、および基になるストリームを使用したデータの送信を行います。データの暗号化や署名などのセキュリティサービスが使用されていない場合、このメソッドは基になるストリームで非同期の書き込み操作を開始します。

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

非同期読み取り操作は、EndWrite メソッドを呼び出して終了させる必要があります。通常、このメソッドは asyncCallback デリゲートによって呼び出されます。非同期プログラミングモデルの使用法の詳細については、「同期メソッドの非同期呼び出し」を参照してください。

NegotiateStream クラスは、複数の書き込み操作の同時実行をサポートしていません。同じストリームで既に書き込み操作が実行中であるときに、別の書き込み操作を開始しようとすると、NotSupportedException 例外がスローされます。

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

使用例

非同期の書き込み操作を開始するコード例を次に示します。

// Send a message to the server.
// Encode the test data into a byte array.
byte[] message = Encoding.UTF8.GetBytes("Hello from the client.");
ar = authStream.BeginWrite(message, 0, message.Length,
    new AsyncCallback(EndWriteCallback),
    authStream);

操作が完了すると次のメソッドが呼び出されます。

// The following method is called when the write operation completes.
public static void EndWriteCallback
 (IAsyncResult ar)
{
    Console.WriteLine("Client ending write operation...");
    NegotiateStream authStream = (NegotiateStream) ar.AsyncState;

    // End the asynchronous operation.
    authStream.EndWrite(ar);
}