Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

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

}

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft. All rights reserved.