SocketAsyncEventArgs 클래스

  • 참조

정의

네임스페이스:
System.Net.Sockets
어셈블리:
System.dll, System.Net.Sockets.dll
어셈블리:
System.Net.Sockets.dll
어셈블리:
System.dll
어셈블리:
netstandard.dll

비동기 소켓 작업을 나타냅니다.

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
상속
Object
EventArgs
SocketAsyncEventArgs
구현
IDisposable

예제

다음 코드 예제에서는 클래스를 사용 하는 소켓 서버에 대 한 연결 논리를 구현 합니다 SocketAsyncEventArgs . 연결을 수락하면 클라이언트에서 읽은 모든 데이터가 클라이언트로 다시 전송됩니다. 클라이언트가 연결을 끊을 때까지 클라이언트 패턴에 대한 읽기 및 에코가 계속됩니다. 이 예제에서 사용하는 BufferManager 클래스는 메서드의 코드 예제에 SetBuffer(Byte[], Int32, Int32) 표시됩니다. 이 예제에서 사용되는 SocketAsyncEventArgsPool 클래스는 생성자에 대한 코드 예제에 SocketAsyncEventArgs 표시됩니다.

// 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
        SocketAsyncEventArgs acceptEventArg = new SocketAsyncEventArgs();
        acceptEventArg.Completed += new EventHandler<SocketAsyncEventArgs>(AcceptEventArg_Completed);
        StartAccept(acceptEventArg);

        //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)
    {
        // loop while the method completes synchronously
        bool willRaiseEvent = false;
        while (!willRaiseEvent)
        {
            m_maxNumberAcceptedClients.WaitOne();

            // socket must be cleared since the context object is being reused
            acceptEventArg.AcceptSocket = null;            
            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);
        
        // Accept the next connection request
        StartAccept(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);
        }
    }

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

설명

합니다 SocketAsyncEventArgs 향상 된 기능 집합의 일부인 클래스는 System.Net.Sockets.Socket 특수화 된 고성능 소켓 애플리케이션에서 사용할 수 있는 대체 비동기 패턴을 제공 하는 클래스입니다. 이 클래스는 높은 성능이 필요한 네트워크 서버 애플리케이션에 대 한 설계 되었습니다. 애플리케이션 향상 된 비동기 패턴을 단독으로 사용할 수 또는 대상 핫 영역 (예: 많은 양의 데이터를 수신 하는 경우).

이러한 개선 사항의 주요 기능은 대량 비동기 소켓 I/O 중 개체의 반복 할당 및 동기화를 방지할 수 있습니다. 현재 클래스에서 System.Net.Sockets.Socket 구현하는 Begin/End 디자인 패턴을 사용하려면 각 비동기 소켓 작업에 대해 개체를 할당해야 합니다 System.IAsyncResult .

새 System.Net.Sockets.Socket 클래스 개선 사항에서 비동기 소켓 작업에서 다시 사용할 수 있는 설명 SocketAsyncEventArgs 개체 할당 및 애플리케이션에서 유지 관리 합니다. 고성능 소켓 애플리케이션은 유지해야 하는 겹쳐진 소켓 작업량을 가장 잘 알고 있습니다. 애플리케이션은 SocketAsyncEventArgs 개체를 필요한 개수만큼 만들 수 있습니다. 예를 들어 서버 애플리케이션을 15 개의 소켓 들어오는 클라이언트 연결 속도 지원 하기 위해 항상 완료 되지 않은 작업을 허용 해야 하는 경우 다시 사용할 수 있는 15 할당할 수 있습니다 SocketAsyncEventArgs 해당 용도 대 한 개체입니다.

이 클래스를 사용하여 비동기 소켓 작업을 수행하기 위한 패턴은 다음 단계로 구성됩니다.

  1. 새 SocketAsyncEventArgs 컨텍스트 개체를 할당하거나 애플리케이션 풀에서 무료 개체를 가져옵니다.

  2. 컨텍스트 개체의 속성을 수행할 작업(예: 완료 콜백 메서드, 데이터 버퍼, 버퍼에 대한 오프셋 및 전송할 최대 데이터 양)으로 설정합니다.

  3. 적절한 소켓 메서드(xxxAsync)를 호출하여 비동기 작업을 시작합니다.

  4. 비동기 소켓 메서드(xxxAsync)가 true를 반환하는 경우 콜백에서 컨텍스트 속성을 쿼리하여 완료 상태를 확인합니다.

  5. 비동기 소켓 메서드(xxxAsync)가 false를 반환하면 작업이 동기적으로 완료됩니다. 컨텍스트 속성에서 작업 결과를 쿼리할 수 있습니다.

  6. 컨텍스트를 다른 작업에 다시 사용하거나, 풀에 다시 넣거나, 삭제합니다.

새 비동기 소켓 작업 컨텍스트 개체의 수명은 애플리케이션 코드와 비동기 I/O 참조에서 참조 하 여 결정 됩니다. 비동기 소켓 작업 방법 중 하나에 매개 변수로 제출된 후 애플리케이션이 비동기 소켓 작업 컨텍스트 개체에 대한 참조를 유지할 필요는 없습니다. 완료 콜백이 반환될 때까지 참조된 상태로 유지됩니다. 그러나 이후 비동기 소켓 작업에 대 한 다시 사용할 수 있도록 컨텍스트에 대 한 참조를 유지 하도록 애플리케이션에 대 한 것이 유용 합니다.

생성자

SocketAsyncEventArgs()

빈 SocketAsyncEventArgs 인스턴스를 만듭니다.
SocketAsyncEventArgs(Boolean)

SocketAsyncEventArgs을 초기화합니다.

속성

AcceptSocket

비동기 소켓 메서드를 통해 연결을 허용하기 위해 만들었거나 사용할 소켓을 가져오거나 설정합니다.
Buffer

비동기 소켓 메서드에 사용할 데이터 버퍼를 가져옵니다.
BufferList

비동기 소켓 메서드에 사용할 데이터 버퍼의 배열을 가져오거나 설정합니다.
BytesTransferred

소켓 작업에서 전송된 바이트 수를 가져옵니다.
ConnectByNameError

DnsEndPoint를 사용할 때 연결 실패가 발생하는 경우의 예외를 가져옵니다.
ConnectSocket

Socket 메서드가 성공적으로 완료된 후 만들어지고 연결되는 ConnectAsync 개체입니다.
Count

비동기 작업을 통해 보내거나 받을 최대 데이터 양(바이트)을 가져옵니다.
DisconnectReuseSocket

연결 끊기 작업이 완료된 후 소켓을 다시 사용할 수 있는지 여부를 지정하는 값을 가져오거나 설정합니다.
LastOperation

이 컨텍스트 개체를 사용하여 가장 최근에 수행한 소켓 작업의 유형을 가져옵니다.
MemoryBuffer

비동기 소켓 메서드를 사용하여 버퍼로 사용할 메모리 영역을 가져옵니다.
Offset

Buffer 속성에서 참조하는 데이터 버퍼의 오프셋(바이트)을 가져옵니다.
ReceiveMessageFromPacketInfo

받은 패킷의 IP 주소 및 인터페이스를 가져옵니다.
RemoteEndPoint

비동기 작업의 원격 IP 엔드포인트를 가져오거나 설정합니다.
SendPacketsElements

SendPacketsAsync(SocketAsyncEventArgs) 메서드로 비동기 작업을 수행할 때 보낼 버퍼의 배열을 가져오거나 설정합니다.
SendPacketsFlags

TransmitFileOptions 메서드로 비동기 작업을 수행할 때 사용하는 SendPacketsAsync(SocketAsyncEventArgs) 값의 비트 조합을 가져오거나 설정합니다.
SendPacketsSendSize

보내기 작업에 사용되는 데이터 블록의 크기(바이트)를 가져오거나 설정합니다.
SocketClientAccessPolicyProtocol
사용되지 않습니다.

소켓 클라이언트 액세스 정책 파일을 다운로드하는 데 사용할 프로토콜을 가져오거나 설정합니다.
SocketError

비동기 소켓 작업의 결과를 가져오거나 설정합니다.
SocketFlags

비동기 소켓 작업의 결과를 가져오거나 비동기 작업의 동작을 설정합니다.
UserToken

이 비동기 소켓 작업과 연결된 사용자 또는 애플리케이션 개체를 가져오거나 설정합니다.

메서드

Dispose()

SocketAsyncEventArgs 인스턴스에서 사용하는 관리되지 않는 리소스를 해제하고, 관리되는 리소스를 선택적으로 삭제합니다.
Equals(Object)

지정된 개체가 현재 개체와 같은지 확인합니다.

(다음에서 상속됨 Object)
Finalize()

SocketAsyncEventArgs 클래스에서 사용한 리소스를 해제합니다.
GetHashCode()

기본 해시 함수로 작동합니다.

(다음에서 상속됨 Object)
GetType()

현재 인스턴스의 Type을 가져옵니다.

(다음에서 상속됨 Object)
MemberwiseClone()

현재 Object의 단순 복사본을 만듭니다.

(다음에서 상속됨 Object)
OnCompleted(SocketAsyncEventArgs)

비동기 작업이 완료되면 호출할 메서드를 나타냅니다.
SetBuffer(Byte[], Int32, Int32)

비동기 소켓 메서드에 사용할 데이터 버퍼를 설정합니다.
SetBuffer(Int32, Int32)

비동기 소켓 메서드에 사용할 데이터 버퍼를 설정합니다.
SetBuffer(Memory<Byte>)

비동기 소켓 메서드를 사용하여 버퍼로 사용할 메모리 영역을 설정합니다.
ToString()

현재 개체를 나타내는 문자열을 반환합니다.

(다음에서 상속됨 Object)

이벤트

Completed

비동기 작업을 완료하는 데 사용할 이벤트입니다.

적용 대상

추가 정보