SocketAsyncEventArgs SocketAsyncEventArgs SocketAsyncEventArgs SocketAsyncEventArgs Class

Определение

Представляет асинхронную операцию сокета.Represents an asynchronous socket operation.

public ref class SocketAsyncEventArgs : EventArgs, IDisposable
public class SocketAsyncEventArgs : EventArgs, IDisposable
type SocketAsyncEventArgs = class
    inherit EventArgs
    interface IDisposable
Public Class SocketAsyncEventArgs
Inherits EventArgs
Implements IDisposable
Наследование
SocketAsyncEventArgsSocketAsyncEventArgsSocketAsyncEventArgsSocketAsyncEventArgs
Реализации

Примеры

В следующем примере кода реализуется логика соединения для сервера сокетов, использующего SocketAsyncEventArgs класс.The following code example implements the connection logic for the socket server that uses the SocketAsyncEventArgs class. После принятия соединения все данные, считанные с клиента, отправляются обратно клиенту.After accepting a connection, all data read from the client is sent back to the client. Чтение и вывод обратно в клиентский шаблон продолжаются до тех пор, пока клиент не отключится.The read and echo back to the client pattern is continued until the client disconnects. Класс буфферманажер, используемый в этом примере, отображается в примере кода для SetBuffer(Byte[], Int32, Int32) метода.The BufferManager class that is used by this example is displayed in the code example for the SetBuffer(Byte[], Int32, Int32) method. Класс соккетасинцевентаргспул, используемый в этом примере, отображается в примере кода для SocketAsyncEventArgs конструктора.The SocketAsyncEventArgsPool class that is used in this example is displayed in the code example for the SocketAsyncEventArgs constructor.

// Implements the connection logic for the socket server.  
// After accepting a connection, all data read from the client 
// is sent back to the client. The read and echo back to the client pattern 
// is continued until the client disconnects.
class Server
{
    private int m_numConnections;   // the maximum number of connections the sample is designed to handle simultaneously 
    private int m_receiveBufferSize;// buffer size to use for each socket I/O operation 
    BufferManager m_bufferManager;  // represents a large reusable set of buffers for all socket operations
    const int opsToPreAlloc = 2;    // read, write (don't alloc buffer space for accepts)
    Socket listenSocket;            // the socket used to listen for incoming connection requests
    // pool of reusable SocketAsyncEventArgs objects for write, read and accept socket operations
    SocketAsyncEventArgsPool m_readWritePool;
    int m_totalBytesRead;           // counter of the total # bytes received by the server
    int m_numConnectedSockets;      // the total number of clients connected to the server 
    Semaphore m_maxNumberAcceptedClients;

    // Create an uninitialized server instance.  
    // To start the server listening for connection requests
    // call the Init method followed by Start method 
    //
    // <param name="numConnections">the maximum number of connections the sample is designed to handle simultaneously</param>
    // <param name="receiveBufferSize">buffer size to use for each socket I/O operation</param>
    public Server(int numConnections, int receiveBufferSize)
    {
        m_totalBytesRead = 0;
        m_numConnectedSockets = 0;
        m_numConnections = numConnections;
        m_receiveBufferSize = receiveBufferSize;
        // allocate buffers such that the maximum number of sockets can have one outstanding read and 
        //write posted to the socket simultaneously  
        m_bufferManager = new BufferManager(receiveBufferSize * numConnections * opsToPreAlloc,
            receiveBufferSize);
  
        m_readWritePool = new SocketAsyncEventArgsPool(numConnections);
        m_maxNumberAcceptedClients = new Semaphore(numConnections, numConnections); 
    }

    // Initializes the server by preallocating reusable buffers and 
    // context objects.  These objects do not need to be preallocated 
    // or reused, but it is done this way to illustrate how the API can 
    // easily be used to create reusable objects to increase server performance.
    //
    public void Init()
    {
        // Allocates one large byte buffer which all I/O operations use a piece of.  This gaurds 
        // against memory fragmentation
        m_bufferManager.InitBuffer();

        // preallocate pool of SocketAsyncEventArgs objects
        SocketAsyncEventArgs readWriteEventArg;

        for (int i = 0; i < m_numConnections; i++)
        {
            //Pre-allocate a set of reusable SocketAsyncEventArgs
            readWriteEventArg = new SocketAsyncEventArgs();
            readWriteEventArg.Completed += new EventHandler<SocketAsyncEventArgs>(IO_Completed);
            readWriteEventArg.UserToken = new AsyncUserToken();

            // assign a byte buffer from the buffer pool to the SocketAsyncEventArg object
            m_bufferManager.SetBuffer(readWriteEventArg);

            // add SocketAsyncEventArg to the pool
            m_readWritePool.Push(readWriteEventArg);
        }

    }

    // Starts the server such that it is listening for 
    // incoming connection requests.    
    //
    // <param name="localEndPoint">The endpoint which the server will listening 
    // for connection requests on</param>
    public void Start(IPEndPoint localEndPoint)
    {
        // create the socket which listens for incoming connections
        listenSocket = new Socket(localEndPoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);
        listenSocket.Bind(localEndPoint);
        // start the server with a listen backlog of 100 connections
        listenSocket.Listen(100);
        
        // post accepts on the listening socket
        StartAccept(null);            

        //Console.WriteLine("{0} connected sockets with one outstanding receive posted to each....press any key", m_outstandingReadCount);
        Console.WriteLine("Press any key to terminate the server process....");
        Console.ReadKey();
    }


    // Begins an operation to accept a connection request from the client 
    //
    // <param name="acceptEventArg">The context object to use when issuing 
    // the accept operation on the server's listening socket</param>
    public void StartAccept(SocketAsyncEventArgs acceptEventArg)
    {
        if (acceptEventArg == null)
        {
            acceptEventArg = new SocketAsyncEventArgs();
            acceptEventArg.Completed += new EventHandler<SocketAsyncEventArgs>(AcceptEventArg_Completed);
        }
        else
        {
            // socket must be cleared since the context object is being reused
            acceptEventArg.AcceptSocket = null;
        }

        m_maxNumberAcceptedClients.WaitOne();
        bool willRaiseEvent = listenSocket.AcceptAsync(acceptEventArg);
        if (!willRaiseEvent)
        {
            ProcessAccept(acceptEventArg);
        }
    }

    // This method is the callback method associated with Socket.AcceptAsync 
    // operations and is invoked when an accept operation is complete
    //
    void AcceptEventArg_Completed(object sender, SocketAsyncEventArgs e)
    {
        ProcessAccept(e);
    }

    private void ProcessAccept(SocketAsyncEventArgs e)
    {
        Interlocked.Increment(ref m_numConnectedSockets);
        Console.WriteLine("Client connection accepted. There are {0} clients connected to the server",
            m_numConnectedSockets);

        // Get the socket for the accepted client connection and put it into the 
        //ReadEventArg object user token
        SocketAsyncEventArgs readEventArgs = m_readWritePool.Pop();
        ((AsyncUserToken)readEventArgs.UserToken).Socket = e.AcceptSocket;

        // As soon as the client is connected, post a receive to the connection
        bool willRaiseEvent = e.AcceptSocket.ReceiveAsync(readEventArgs);
        if(!willRaiseEvent){
            ProcessReceive(readEventArgs);
        }

        // Accept the next connection request
        StartAccept(e);
    }

    // This method is called whenever a receive or send operation is completed on a socket 
    //
    // <param name="e">SocketAsyncEventArg associated with the completed receive operation</param>
    void IO_Completed(object sender, SocketAsyncEventArgs e)
    {
        // determine which type of operation just completed and call the associated handler
        switch (e.LastOperation)
        {
            case SocketAsyncOperation.Receive:
                ProcessReceive(e);
                break;
            case SocketAsyncOperation.Send:
                ProcessSend(e);
                break;
            default:
                throw new ArgumentException("The last operation completed on the socket was not a receive or send");
        }       

    }
    
    // This method is invoked when an asynchronous receive operation completes. 
    // If the remote host closed the connection, then the socket is closed.  
    // If data was received then the data is echoed back to the client.
    //
    private void ProcessReceive(SocketAsyncEventArgs e)
    {
        // check if the remote host closed the connection
        AsyncUserToken token = (AsyncUserToken)e.UserToken;
        if (e.BytesTransferred > 0 && e.SocketError == SocketError.Success)
        {
            //increment the count of the total bytes receive by the server
            Interlocked.Add(ref m_totalBytesRead, e.BytesTransferred);
            Console.WriteLine("The server has read a total of {0} bytes", m_totalBytesRead);
            
            //echo the data received back to the client
            e.SetBuffer(e.Offset, e.BytesTransferred);
            bool willRaiseEvent = token.Socket.SendAsync(e);
            if (!willRaiseEvent)
            {
                ProcessSend(e);
            }
          
        }
        else
        {
            CloseClientSocket(e);
        }
    }

    // This method is invoked when an asynchronous send operation completes.  
    // The method issues another receive on the socket to read any additional 
    // data sent from the client
    //
    // <param name="e"></param>
    private void ProcessSend(SocketAsyncEventArgs e)
    {
        if (e.SocketError == SocketError.Success)
        {
            // done echoing data back to the client
            AsyncUserToken token = (AsyncUserToken)e.UserToken;
            // read the next block of data send from the client
            bool willRaiseEvent = token.Socket.ReceiveAsync(e);
            if (!willRaiseEvent)
            {
                ProcessReceive(e);
            }
        }
        else
        {
            CloseClientSocket(e);
        }
    }

    private void CloseClientSocket(SocketAsyncEventArgs e)
    {
        AsyncUserToken token = e.UserToken as AsyncUserToken;

        // close the socket associated with the client
        try
        {
            token.Socket.Shutdown(SocketShutdown.Send);
        }
        // throws if client process has already closed
        catch (Exception) { }
        token.Socket.Close();

        // decrement the counter keeping track of the total number of clients connected to the server
        Interlocked.Decrement(ref m_numConnectedSockets);
        
        // Free the SocketAsyncEventArg so they can be reused by another client
        m_readWritePool.Push(e);
        
        m_maxNumberAcceptedClients.Release();
        Console.WriteLine("A client has been disconnected from the server. There are {0} clients connected to the server", m_numConnectedSockets);
    }

}    

Комментарии

Класс является частью набора улучшений System.Net.Sockets.Socket класса, предоставляющих альтернативную асинхронную модель, которая может использоваться специализированными высокопроизводительными приложениями сокетов. SocketAsyncEventArgsThe SocketAsyncEventArgs class is part of a set of enhancements to the System.Net.Sockets.Socket class that provide an alternative asynchronous pattern that can be used by specialized high-performance socket applications. Этот класс был специально разработан для сетевых серверных приложений, требующих высокой производительности.This class was specifically designed for network server applications that require high performance. Приложение может использовать расширенный асинхронный шаблон исключительно или только в целевых активных областях (например, при получении больших объемов данных).An application can use the enhanced asynchronous pattern exclusively or only in targeted hot areas (for example, when receiving large amounts of data).

Главное преимущество этих улучшений — устранение необходимости в повторном выделении и синхронизации объектов во время асинхронных операций ввода-вывода больших объемов данных на сокете.The main feature of these enhancements is the avoidance of the repeated allocation and synchronization of objects during high-volume asynchronous socket I/O. Шаблон разработки "начало/конец", реализованный System.Net.Sockets.Socket классом, System.IAsyncResult требует выделения объекта для каждой асинхронной операции сокета.The Begin/End design pattern currently implemented by the System.Net.Sockets.Socket class requires a System.IAsyncResult object be allocated for each asynchronous socket operation.

В новых System.Net.Sockets.Socket улучшенных классах асинхронные операции сокета описываются многократно используемыми SocketAsyncEventArgs объектами, выделенными и обслуживаемыми приложением.In the new System.Net.Sockets.Socket class enhancements, asynchronous socket operations are described by reusable SocketAsyncEventArgs objects allocated and maintained by the application. Высокопроизводительному приложению сокета лучше всего известно, сколько перекрывающихся операций сокета необходимо поддерживать.High-performance socket applications know best the amount of overlapped socket operations that must be sustained. Приложение может создать столько объектов SocketAsyncEventArgs, сколько ему требуется.The application can create as many of the SocketAsyncEventArgs objects that it needs. Например, если серверному приложению требуется 15 операций по приему сокетов, которые в любое время поддерживаются для поддержки входящих клиентских подключений, он может выделить 15 SocketAsyncEventArgs многократно используемых объектов для этой цели.For example, if a server application needs to have 15 socket accept operations outstanding at all times to support incoming client connection rates, it can allocate 15 reusable SocketAsyncEventArgs objects for that purpose.

Шаблон выполнения асинхронной операции на сокете с помощью этого класса состоит из перечисленных ниже действий.The pattern for performing an asynchronous socket operation with this class consists of the following steps:

  1. Выделите новый объект контекста SocketAsyncEventArgs или получите свободный объект из пула приложений.Allocate a new SocketAsyncEventArgs context object, or get a free one from an application pool.

  2. Задайте свойства объекта контекста для выполнения операции (метод обратного вызова завершения, буфер данных, смещение в буфере и максимальный объем передаваемых данных, например).Set properties on the context object to the operation about to be performed (the completion callback method, the data buffer, the offset into the buffer, and the maximum amount of data to transfer, for example).

  3. Вызовите соответствующий метод сокета (xxxAsync), чтобы инициировать асинхронную операцию.Call the appropriate socket method (xxxAsync) to initiate the asynchronous operation.

  4. Если асинхронный метод сокета (xxxAsync) возвращает значение true, в обратном вызове запросите свойства контекста для состояния завершения.If the asynchronous socket method (xxxAsync) returns true, in the callback, query the context properties for completion status.

  5. Если асинхронный метод сокета (xxxAsync) возвращает значение false, операция завершается синхронно.If the asynchronous socket method (xxxAsync) returns false, the operation completed synchronously. Результат операции можно запросить из свойств контекста.The context properties may be queried for the operation result.

  6. Используйте контекст повторно для другой операции, верните его в пул или удалите.Reuse the context for another operation, put it back in the pool, or discard it.

Время существования нового объекта контекста асинхронной операции сокета определяется ссылками на код приложения и асинхронные ссылки ввода-вывода.The lifetime of the new asynchronous socket operation context object is determined by references by the application code and asynchronous I/O references. Приложению не требуется сохранять ссылку на объект контекста асинхронной операции на сокете после ее передачи в качестве параметра в один из методов асинхронной операции на сокете.It is not necessary for the application to retain a reference to an asynchronous socket operation context object after it is submitted as a parameter to one of the asynchronous socket operation methods. Ссылка сохраняется до тех пор, пока не будет возвращен обратный вызов завершения.It will remain referenced until the completion callback returns. Однако полезно, чтобы приложение сохраняло ссылку на контекст, чтобы его можно было повторно использовать для последующей асинхронной операции сокета.However it is advantageous for the application to retain the reference to the context so that it can be reused for a future asynchronous socket operation.

Конструкторы

SocketAsyncEventArgs() SocketAsyncEventArgs() SocketAsyncEventArgs() SocketAsyncEventArgs()

Создает пустой экземпляр класса SocketAsyncEventArgs.Creates an empty SocketAsyncEventArgs instance.

Свойства

AcceptSocket AcceptSocket AcceptSocket AcceptSocket

Возвращает или задает сокет для применения или сокет, созданный для принятия запроса на подключения, с помощью асинхронного метода сокета.Gets or sets the socket to use or the socket created for accepting a connection with an asynchronous socket method.

Buffer Buffer Buffer Buffer

Получает буфер данных для применения в асинхронном методе сокета.Gets the data buffer to use with an asynchronous socket method.

BufferList BufferList BufferList BufferList

Возвращает или задает массив буферов данных для применения в асинхронном методе сокета.Gets or sets an array of data buffers to use with an asynchronous socket method.

BytesTransferred BytesTransferred BytesTransferred BytesTransferred

Получает количество байтов, переданных в операции сокета.Gets the number of bytes transferred in the socket operation.

ConnectByNameError ConnectByNameError ConnectByNameError ConnectByNameError

Получает исключение в случае сбоя соединения при использовании DnsEndPoint.Gets the exception in the case of a connection failure when a DnsEndPoint was used.

ConnectSocket ConnectSocket ConnectSocket ConnectSocket

Созданный и подключенный объект Socket после успешного выполнения метода ConnectAsync.The created and connected Socket object after successful completion of the ConnectAsync method.

Count Count Count Count

Получает значение, равное максимальному количеству данных (в байтах), которое может быть отправлено или получено в асинхронной операции.Gets the maximum amount of data, in bytes, to send or receive in an asynchronous operation.

DisconnectReuseSocket DisconnectReuseSocket DisconnectReuseSocket DisconnectReuseSocket

Возвращает или задает значение, указывающее, может ли сокет быть повторно использован после операции отключения.Gets or sets a value that specifies if socket can be reused after a disconnect operation.

LastOperation LastOperation LastOperation LastOperation

Получает тип операции сокета, которая была выполнена последней с этим объектом контекста.Gets the type of socket operation most recently performed with this context object.

MemoryBuffer MemoryBuffer MemoryBuffer MemoryBuffer
Offset Offset Offset Offset

Получает смещение (в байтах) в буфере данных, на который ссылается свойство Buffer.Gets the offset, in bytes, into the data buffer referenced by the Buffer property.

ReceiveMessageFromPacketInfo ReceiveMessageFromPacketInfo ReceiveMessageFromPacketInfo ReceiveMessageFromPacketInfo

Получает IP-адрес и интерфейс получаемого пакета.Gets the IP address and interface of a received packet.

RemoteEndPoint RemoteEndPoint RemoteEndPoint RemoteEndPoint

Возвращает или задает удаленную конечную точка IP для асинхронной операции.Gets or sets the remote IP endpoint for an asynchronous operation.

SendPacketsElements SendPacketsElements SendPacketsElements SendPacketsElements

Возвращает или задает массив буферов для отправки для асинхронной операции, используемой методом SendPacketsAsync(SocketAsyncEventArgs).Gets or sets an array of buffers to be sent for an asynchronous operation used by the SendPacketsAsync(SocketAsyncEventArgs) method.

SendPacketsFlags SendPacketsFlags SendPacketsFlags SendPacketsFlags

Возвращает или задает битовую комбинацию значений TransmitFileOptions для асинхронной операции, используемой методом SendPacketsAsync(SocketAsyncEventArgs).Gets or sets a bitwise combination of TransmitFileOptions values for an asynchronous operation used by the SendPacketsAsync(SocketAsyncEventArgs) method.

SendPacketsSendSize SendPacketsSendSize SendPacketsSendSize SendPacketsSendSize

Возвращает или задает размер (в байтах) блока данных, используемый в операции отправки.Gets or sets the size, in bytes, of the data block used in the send operation.

SocketClientAccessPolicyProtocol SocketClientAccessPolicyProtocol SocketClientAccessPolicyProtocol SocketClientAccessPolicyProtocol

Получает или задает Протокол, используемый, чтобы загрузить файл политики доступа к сокету клиента.Gets or sets the protocol to use to download the socket client access policy file.

SocketError SocketError SocketError SocketError

Возвращает или задает результат асинхронной операции сокета.Gets or sets the result of the asynchronous socket operation.

SocketFlags SocketFlags SocketFlags SocketFlags

Получает результат асинхронной операции сокета или задает поведение асинхронной операции.Gets the results of an asynchronous socket operation or sets the behavior of an asynchronous operation.

UserToken UserToken UserToken UserToken

Возвращает или задает объект пользователя или приложения, связанный с данной асинхронной операцией сокета.Gets or sets a user or application object associated with this asynchronous socket operation.

Методы

Dispose() Dispose() Dispose() Dispose()

Освобождает неуправляемые ресурсы, используемые экземпляром класса SocketAsyncEventArgs, и при необходимости удаляет управляемые ресурсы.Releases the unmanaged resources used by the SocketAsyncEventArgs instance and optionally disposes of the managed resources.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
Finalize() Finalize() Finalize() Finalize()

Освобождает ресурсы, используемые классом SocketAsyncEventArgs.Frees resources used by the SocketAsyncEventArgs class.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
OnCompleted(SocketAsyncEventArgs) OnCompleted(SocketAsyncEventArgs) OnCompleted(SocketAsyncEventArgs) OnCompleted(SocketAsyncEventArgs)

Представляет метод, вызываемый после завершения асинхронной операции.Represents a method that is called when an asynchronous operation completes.

SetBuffer(Byte[], Int32, Int32) SetBuffer(Byte[], Int32, Int32) SetBuffer(Byte[], Int32, Int32) SetBuffer(Byte[], Int32, Int32)

Задает буфер данных для применения в асинхронном методе сокета.Sets the data buffer to use with an asynchronous socket method.

SetBuffer(Int32, Int32) SetBuffer(Int32, Int32) SetBuffer(Int32, Int32) SetBuffer(Int32, Int32)

Задает буфер данных для применения в асинхронном методе сокета.Sets the data buffer to use with an asynchronous socket method.

SetBuffer(Memory<Byte>) SetBuffer(Memory<Byte>) SetBuffer(Memory<Byte>) SetBuffer(Memory<Byte>)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

События

Completed Completed Completed Completed

Событие, используемое для завершения асинхронной операции.The event used to complete an asynchronous operation.

Применяется к

Дополнительно