Export (0) Print
Expand All

SslStream.BeginRead Method

Note: This method is new in the .NET Framework version 2.0.

Begins an asynchronous read operation that reads data from the stream and stores it in the specified array.

Namespace: System.Net.Security
Assembly: System (in system.dll)

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

Parameters

buffer

A Byte array that receives the bytes read from the stream.

offset

The zero-based location in buffer at which to begin storing the data read from this stream.

count

The maximum number of bytes to read from the stream.

asyncCallback

An AsyncCallback delegate that references the method to invoke when the read operation is complete.

asyncState

A user-defined object that contains information about the read operation. This object is passed to the asyncCallback delegate when the operation completes.

Return Value

An IAsyncResult object that indicates the status of the asynchronous operation.

Exception typeCondition

ArgumentNullException

buffer is a null reference (Nothing in Visual Basic).

ArgumentException

offset < 0.

-or-

offset > the length of buffer.

-or-

offset + count > the length of buffer.

IOException

The read operation failed.

-or-

Encryption is in use, but the data could not be decrypted.

NotSupportedException

There is already a read operation in progress.

ObjectDisposedException

This object has been closed.

InvalidOperationException

Authentication has not occurred.

If encryption and or signing are enabled, the read operation reads the data from the underlying stream, checks the integrity of the data, and/or decrypts it. The asynchronous read operation must be completed by calling the EndRead method. Typically, the method is invoked by the asyncCallback delegate.

This method does not block while the operation completes. To block until the operation completes, use the Read method.

For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously

The SslStream class does not support multiple simultaneous read operations.

You cannot call this method until you have successfully authenticated. To authenticate call one of the AuthenticateAsClient, or BeginAuthenticateAsClient, AuthenticateAsServer, BeginAuthenticateAsServer methods.

The following code example demonstrates starting an asynchronous read operation.

// 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];

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;
    }
}

The following method is called when the read completes.


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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft