ReadTaskAsync Method

Start an awaitable asynchronous read on the socket.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function ReadTaskAsync( _
   ByVal buffer() As Byte, _
   ByVal offset As Integer, _
   ByVal count As Integer _
) As Task(Of Data)

'Usage
 
Dim instance As TcpBase
Dim buffer() As Byte
Dim offset As Integer
Dim count As Integer
Dim value As Task(Of Data)
 
value = instance.ReadTaskAsync(buffer, offset, count)

public Task<Data> ReadTaskAsync( 
   byte[] buffer,
   int offset,
   int count
)

public: Task<Data*>* ReadTaskAsync( 
   byte[]* buffer,
   int offset,
   int count
)

public:
Task<Data^>^ ReadTaskAsync( 
   array<byte>^ buffer,
   int offset,
   int count
)

Parameters

buffer: The byte array used to store the received data.
offset: The position in the buffer to store the data.
count: The maximum number of bytes to receive.

Return Value

A task that represents the asynchronous read operation. The value of the TResult parameter contains the Data object encapsulating the received data (null if the socket is closed).

Remarks

ReadTaskAsync encapsulates TcpBase.ReadAsync and its callback into an easy-to-use awaitable method, leveraging the benefits of IO completion ports without the complexity of callbacks.

Reference

TcpBase Class
TcpBase Members