This topic has not yet been rated - Rate this topic

SocketAsyncEventArgs Constructor

Creates an empty SocketAsyncEventArgs instance.

Namespace:  System.Net.Sockets
Assembly:  System (in System.dll)
public SocketAsyncEventArgs()
Exception Condition
NotSupportedException

The platform is not supported.

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.

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

}


.NET Framework

Supported in: 4, 3.5 SP1, 3.0 SP1, 2.0 SP1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
The provided sample is useless
It just shows a useless wrapper of a stack that adds very little functionality, yet removes potentially useful functionality of the underlying stack object. The worst part is that it never even call the constructor for which the sample is supposedly demonstrating.