SocketAsyncEventArgs SocketAsyncEventArgs SocketAsyncEventArgs SocketAsyncEventArgs Class

Definition

Stellt einen asynchronen Socketvorgang dar.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
Vererbung
SocketAsyncEventArgsSocketAsyncEventArgsSocketAsyncEventArgsSocketAsyncEventArgs
Implementiert

Beispiele

Im folgenden Codebeispiel wird die Verbindungslogik für den Socketserver, die verwendet implementiert die SocketAsyncEventArgs Klasse.The following code example implements the connection logic for the socket server that uses the SocketAsyncEventArgs class. Alle Daten, die vom Client gelesen wird nach dem Akzeptieren einer Verbindungs zurück an den Client gesendet.After accepting a connection, all data read from the client is sent back to the client. Das Lesen und Echo zurück an den Client-Muster wird fortgesetzt, bis der Client getrennt wird.The read and echo back to the client pattern is continued until the client disconnects. Die BufferManager-Klasse, die von diesem Beispiel verwendet wird, wird angezeigt, im Codebeispiel für die SetBuffer(Byte[], Int32, Int32) Methode.The BufferManager class that is used by this example is displayed in the code example for the SetBuffer(Byte[], Int32, Int32) method. SocketAsyncEventArgsPool-Klasse, die in diesem Beispiel dient wird angezeigt, in dem Codebeispiel für die SocketAsyncEventArgs Konstruktor.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);
    }

}    

Hinweise

Die SocketAsyncEventArgs Klasse ist Teil einer Reihe von Verbesserungen an der System.Net.Sockets.Socket Klasse, die ein alternatives asynchrones Muster bereitstellen, das von spezialisierten Socketanwendungen mit hoher Leistung verwendet werden kann.The 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. Diese Klasse wurde speziell für netzwerkserveranwendungen entwickelt, die eine hohe Leistung erfordern.This class was specifically designed for network server applications that require high performance. Eine Anwendung kann die erweiterte asynchrone Muster ausschließlich oder nur in bestimmten Bereichen (z. B., wenn Sie große Mengen von Daten zu empfangen).An application can use the enhanced asynchronous pattern exclusively or only in targeted hot areas (for example, when receiving large amounts of data).

Die Hauptfunktion dieser Erweiterungen ist die Vermeidung der wiederholten Zuordnung und Synchronisierung von Objekten während asynchroner Socket-E/A mit hohem Volumen.The main feature of these enhancements is the avoidance of the repeated allocation and synchronization of objects during high-volume asynchronous socket I/O. Das Begin/End-Entwurfsmuster, die derzeit von implementiert die System.Net.Sockets.Socket Klasse erfordert eine System.IAsyncResult Objekt für jeden asynchronen Socketvorgang zugeordnet werden.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.

In der neuen System.Net.Sockets.Socket Klasse Verbesserungen, asynchrone Socket-Vorgänge in wiederverwendbare beschrieben werden SocketAsyncEventArgs Objekte zugeordnet und von der Anwendung verwaltet.In the new System.Net.Sockets.Socket class enhancements, asynchronous socket operations are described by reusable SocketAsyncEventArgs objects allocated and maintained by the application. Socketanwendungen mit hoher Leistung kennen die Menge an überlappenden Socketvorgängen, die aufrechterhalten werden müssen, am besten.High-performance socket applications know best the amount of overlapped socket operations that must be sustained. Die Anwendung kann so viele SocketAsyncEventArgs-Objekte erstellen wie nötig.The application can create as many of the SocketAsyncEventArgs objects that it needs. Z. B. wenn eine Serveranwendung muss in 15 socketannahmevorgänge ausstehenden Vorgänge zu jeder Zeit, um eingehende clientverbindungsraten zu unterstützen, sie können zuordnen 15 wiederverwendbare SocketAsyncEventArgs Objekte für diesen Zweck.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.

Das Muster zum Ausführen eines asynchronen Socketvorgangs mit dieser Klasse besteht aus den folgenden Schritten:The pattern for performing an asynchronous socket operation with this class consists of the following steps:

  1. Zuweisen eines neuen SocketAsyncEventArgs-Kontextobjekt oder Abrufen eines kostenlosen aus einem Anwendungspool.Allocate a new SocketAsyncEventArgs context object, or get a free one from an application pool.

  2. Festlegen von Eigenschaften für den Kontext-Objekt in den Vorgang zu sein ausgeführt (die Vervollständigung Callback-Methode, im Datenpuffer, der Offset im Puffer und die maximale Menge der Daten zu übertragen, z. B.).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. Aufrufen der entsprechenden Socketmethode (XxxAsync) zum Initiieren des asynchronen Vorgangs.Call the appropriate socket method (xxxAsync) to initiate the asynchronous operation.

  4. Wenn die asynchrone Socketmethode (XxxAsync) im Rückruf true zurückgibt, Fragen Sie die Eigenschaften für den Abschlussstatus.If the asynchronous socket method (xxxAsync) returns true, in the callback, query the context properties for completion status.

  5. Wenn die asynchrone Socketmethode (XxxAsync) auf "false" zurückgibt, der Vorgang synchron abgeschlossen wurde.If the asynchronous socket method (xxxAsync) returns false, the operation completed synchronously. Die Kontexteigenschaften könnten möglicherweise für das Betriebsergebnis abgefragt werden.The context properties may be queried for the operation result.

  6. Verwenden Sie den Kontext für einen anderen Vorgang erneut, fügen Sie ihn wieder in den Pool ein, oder verwerfen Sie ihn.Reuse the context for another operation, put it back in the pool, or discard it.

Die Lebensdauer des Kontextobjekts neue asynchrone Socket-Vorgang wird vom Anwendungscode und asynchrone e/a-Verweise durch Verweise bestimmt.The lifetime of the new asynchronous socket operation context object is determined by references by the application code and asynchronous I/O references. Es ist nicht erforderlich, dass die Anwendung einen Verweis auf das Kontextobjekt des asynchronen Socketvorgangs beibehält, nachdem er als Parameter an eine der Methoden des asynchronen Socketvorgangs gesendet wurde.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. Der Verweis bleibt bestehen, bis der Abschlussrückruf zurückgegeben wird.It will remain referenced until the completion callback returns. Jedoch ist es vorteilhaft sein, für die Anwendung den Verweis auf den Kontext beibehalten werden sollen, damit er für einen weiteren asynchronen Socketvorgang wiederverwendet werden kann.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.

Konstruktoren

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

Erstellt eine leere SocketAsyncEventArgs-Instanz.Creates an empty SocketAsyncEventArgs instance.

Eigenschaften

AcceptSocket AcceptSocket AcceptSocket AcceptSocket

Ruft den Socket ab, der zum Akzeptieren einer Verbindung mit einer asynchronen Socketmethode erstellt wird, oder legt ihn fest.Gets or sets the socket to use or the socket created for accepting a connection with an asynchronous socket method.

Buffer Buffer Buffer Buffer

Ruft den Datenpuffer ab, der mit einer asynchronen Socketmethode verwendet werden soll.Gets the data buffer to use with an asynchronous socket method.

BufferList BufferList BufferList BufferList

Ruft ein Array von Datenpuffern ab, die mit einer asynchronen Socketmethode verwendet werden sollen, oder legt es fest.Gets or sets an array of data buffers to use with an asynchronous socket method.

BytesTransferred BytesTransferred BytesTransferred BytesTransferred

Ruft die Anzahl der im Socketvorgang übertragenen Bytes ab.Gets the number of bytes transferred in the socket operation.

ConnectByNameError ConnectByNameError ConnectByNameError ConnectByNameError

Ruft die Ausnahme im Fall eines Verbindungsfehlers ab, wenn DnsEndPoint verwendet wurde.Gets the exception in the case of a connection failure when a DnsEndPoint was used.

ConnectSocket ConnectSocket ConnectSocket ConnectSocket

Das erstellte und verbundene Socket-Objekt nach dem erfolgreichen Beenden der ConnectAsync-Methode.The created and connected Socket object after successful completion of the ConnectAsync method.

Count Count Count Count

Ruft die maximale Datenmenge in Bytes ab, die in einem asynchronen Vorgang gesendet oder empfangen wird.Gets the maximum amount of data, in bytes, to send or receive in an asynchronous operation.

DisconnectReuseSocket DisconnectReuseSocket DisconnectReuseSocket DisconnectReuseSocket

Ruft einen Wert ab, der angibt, ob ein Socket nach einem Trennvorgang wiederverwendet werden kann, oder legt ihn fest.Gets or sets a value that specifies if socket can be reused after a disconnect operation.

LastOperation LastOperation LastOperation LastOperation

Ruft den Typ des Socketvorgangs ab, der zuletzt mit diesem Kontextobjekt ausgeführt wurde.Gets the type of socket operation most recently performed with this context object.

MemoryBuffer MemoryBuffer MemoryBuffer MemoryBuffer
Offset Offset Offset Offset

Ruft den Offset in Bytes im Datenpuffer ab, auf den von der Buffer-Eigenschaft verwiesen wird.Gets the offset, in bytes, into the data buffer referenced by the Buffer property.

ReceiveMessageFromPacketInfo ReceiveMessageFromPacketInfo ReceiveMessageFromPacketInfo ReceiveMessageFromPacketInfo

Ruft die IP-Adresse und Schnittstelle eines empfangenen Pakets ab.Gets the IP address and interface of a received packet.

RemoteEndPoint RemoteEndPoint RemoteEndPoint RemoteEndPoint

Ruft den Remote-IP-Endpunkt für einen asynchronen Vorgang ab oder legt ihn fest.Gets or sets the remote IP endpoint for an asynchronous operation.

SendPacketsElements SendPacketsElements SendPacketsElements SendPacketsElements

Ruft ein Array von Puffern ab, die für einen von der SendPacketsAsync(SocketAsyncEventArgs)-Methode verwendeten asynchronen Vorgang gesendet werden sollen, oder legt es fest.Gets or sets an array of buffers to be sent for an asynchronous operation used by the SendPacketsAsync(SocketAsyncEventArgs) method.

SendPacketsFlags SendPacketsFlags SendPacketsFlags SendPacketsFlags

Ruft eine bitweise Kombination von TransmitFileOptions-Werten für einen asynchronen Vorgang ab, der von der SendPacketsAsync(SocketAsyncEventArgs)-Methode verwendet wird, oder legt sie fest.Gets or sets a bitwise combination of TransmitFileOptions values for an asynchronous operation used by the SendPacketsAsync(SocketAsyncEventArgs) method.

SendPacketsSendSize SendPacketsSendSize SendPacketsSendSize SendPacketsSendSize

Ruft die Größe des im Sendevorgang verwendeten Datenblocks in Bytes ab oder legt diese fest.Gets or sets the size, in bytes, of the data block used in the send operation.

SocketClientAccessPolicyProtocol SocketClientAccessPolicyProtocol SocketClientAccessPolicyProtocol SocketClientAccessPolicyProtocol

Ruft das Protokoll ab oder legt es fest, das verwenden wird, um die Socketclient-Zugriffsrichtliniendatei herunterzuladen.Gets or sets the protocol to use to download the socket client access policy file.

SocketError SocketError SocketError SocketError

Ruft das Ergebnis des asynchronen Socketvorgangs ab oder legt dieses fest.Gets or sets the result of the asynchronous socket operation.

SocketFlags SocketFlags SocketFlags SocketFlags

Ruft die Ergebnisse eines asynchronen Socketvorgangs ab oder legt das Verhalten eines asynchronen Vorgangs fest.Gets the results of an asynchronous socket operation or sets the behavior of an asynchronous operation.

UserToken UserToken UserToken UserToken

Ruft ein Benutzer- oder Anwendungsobjekt ab, das diesem asynchronen Socketvorgang zugeordnet ist, oder legt es fest.Gets or sets a user or application object associated with this asynchronous socket operation.

Methoden

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

Gibt die von der SocketAsyncEventArgs-Instanz verwendeten nicht verwalteten Ressourcen zurück und verwirft optional die verwalteten Ressourcen.Releases the unmanaged resources used by the SocketAsyncEventArgs instance and optionally disposes of the managed resources.

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

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

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

Gibt von der SocketAsyncEventArgs-Klasse verwendete Ressourcen frei.Frees resources used by the SocketAsyncEventArgs class.

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

Fungiert als Standardhashfunktion.Serves as the default hash function.

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

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

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

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

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

Stellt eine Methode dar, die beim Abschluss eines asynchronen Vorgangs aufgerufen wird.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)

Legt den Datenpuffer fest, der mit einer asynchronen Socketmethode verwendet werden soll.Sets the data buffer to use with an asynchronous socket method.

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

Legt den Datenpuffer fest, der mit einer asynchronen Socketmethode verwendet werden soll.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()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Ereignisse

Completed Completed Completed Completed

Das Ereignis, das zum Abschließen eines asynchronen Vorgangs verwendet wird.The event used to complete an asynchronous operation.

Gilt für:

Siehe auch