SocketAsyncEventArgs.BufferList Property

Definition

Namespace:

System.Net.Sockets

Assemblies:

netstandard.dll, System.Net.Sockets.dll

Source:

SocketAsyncEventArgs.cs

Gets or sets an array of data buffers to use with an asynchronous socket method.

C#

public System.Collections.Generic.IList<ArraySegment<byte>>? BufferList { get; set; }

Property Value

IList<ArraySegment<Byte>>

An IList that represents an array of data buffers to use with an asynchronous socket method.

Exceptions

ArgumentException

There are ambiguous buffers specified on a set operation. This exception occurs if the Buffer property has been set to a non-null value and an attempt was made to set the BufferList property to a non-null value.

Remarks

This property is used with the Socket.ReceiveAsync and Socket.SendAsync methods.

This property is used to provide multiple buffers of data to be sent or to provide multiple buffers in which to store received data for an asynchronous socket operation that can send or receive data. Multiple buffers using the BufferList property are supported by the Socket.ReceiveAsync and Socket.SendAsync methods.

If the BufferList property is set to a non-null value, the Buffer property must be null and is ignored by the Socket.ReceiveAsync and Socket.SendAsync methods.

If the Buffer was set to a non-null value and an attempt is made to set the BufferList property to a non-null value, an exception is thrown.

If the BufferList property is set to a non-null value, the Socket.ConnectAsync and Socket.AcceptAsync methods will throw an ArgumentException.

The BufferList parameter is ignored by the Socket.DisconnectAsync and Socket.SendPacketsAsync methods.

Applies to

See also

• ReceiveAsync(SocketAsyncEventArgs)
• SendAsync(SocketAsyncEventArgs)
• Buffer