Export (0) Print
Expand All

SocketAsyncEventArgs Constructor

Creates an empty SocketAsyncEventArgs instance.

Namespace:  System.Net.Sockets
Assembly:  System (in System.dll)

public SocketAsyncEventArgs()

ExceptionCondition
NotSupportedException

The platform is not supported.

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

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

}

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

.NET Framework

Supported in: 3.5 SP1, 3.0 SP1, 2.0 SP1

Community Additions

ADD
Show:
© 2014 Microsoft