SocketAsyncEventArgs Constructors

Definition

Namespace:

System.Net.Sockets

Assembly:

System.Net.Sockets.dll

Overloads

SocketAsyncEventArgs()	Creates an empty SocketAsyncEventArgs instance.
SocketAsyncEventArgs(Boolean)	Initializes the SocketAsyncEventArgs.

SocketAsyncEventArgs()

Source:

SocketAsyncEventArgs.cs

Creates an empty SocketAsyncEventArgs instance.

public:
 SocketAsyncEventArgs();

public SocketAsyncEventArgs ();

Public Sub New ()

Exceptions

NotSupportedException

The platform is not supported.

Examples

The following code example represents a collection of reusable SocketAsyncEventArgs objects.

// Represents a collection of reusable SocketAsyncEventArgs objects.
class SocketAsyncEventArgsPool
{
    Stack<SocketAsyncEventArgs> m_pool;

    // Initializes the object pool to the specified size
    //
    // The "capacity" parameter is the maximum number of
    // SocketAsyncEventArgs objects the pool can hold
    public SocketAsyncEventArgsPool(int capacity)
    {
        m_pool = new Stack<SocketAsyncEventArgs>(capacity);
    }

    // Add a SocketAsyncEventArg instance to the pool
    //
    //The "item" parameter is the SocketAsyncEventArgs instance
    // to add to the pool
    public void Push(SocketAsyncEventArgs item)
    {
        if (item == null) { throw new ArgumentNullException("Items added to a SocketAsyncEventArgsPool cannot be null"); }
        lock (m_pool)
        {
            m_pool.Push(item);
        }
    }

    // Removes a SocketAsyncEventArgs instance from the pool
    // and returns the object removed from the pool
    public SocketAsyncEventArgs Pop()
    {
        lock (m_pool)
        {
            return m_pool.Pop();
        }
    }

    // The number of SocketAsyncEventArgs instances in the pool
    public int Count
    {
        get { return m_pool.Count; }
    }
}

Remarks

After calling this constructor all properties will have their default values:

• Object references will be null

• Properties that return an integer will return zero.

• The LastOperation property will be equal to None.

• The SendPacketsFlags property will be equal to TransmitFileOptions.UseDefaultWorkerThread, which specifies no flags will be used.

• The SocketFlags property will be equal to None.

The caller must set the appropriate properties prior to passing the object to the appropriate asynchronous socket (xxxAsync) method.

SocketAsyncEventArgs(Boolean)

Source:

SocketAsyncEventArgs.cs

Initializes the SocketAsyncEventArgs.

public:
 SocketAsyncEventArgs(bool unsafeSuppressExecutionContextFlow);

public SocketAsyncEventArgs (bool unsafeSuppressExecutionContextFlow);

new System.Net.Sockets.SocketAsyncEventArgs : bool -> System.Net.Sockets.SocketAsyncEventArgs

Public Sub New (unsafeSuppressExecutionContextFlow As Boolean)

Parameters

unsafeSuppressExecutionContextFlow

Boolean

Whether to disable the capturing and flow of execution context. Execution context flow should only be disabled if it's handled by higher layers.