Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.
This topic has not yet been rated - Rate this topic

Socket.EndAccept Method (Byte[], IAsyncResult)

Asynchronously accepts an incoming connection attempt and creates a new Socket object to handle remote host communication. This method returns a buffer that contains the initial data transferred.

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

public Socket EndAccept (
	out byte[] buffer,
	IAsyncResult asyncResult
)
public Socket EndAccept (
	/** @attribute OutAttribute() */ /** @ref */ byte[] buffer, 
	IAsyncResult asyncResult
)
Not applicable.

Parameters

buffer

An array of type Byte that contains the bytes transferred.

asyncResult

An IAsyncResult object that stores state information for this asynchronous operation as well as any user defined data.

Return Value

A Socket object to handle communication with the remote host.
Exception typeCondition

NotSupportedException

Windows NT is required for this method.

ObjectDisposedException

The Socket object has been closed.

ArgumentNullException

asyncResult is empty.

ArgumentException

asyncResult was not created by a call to BeginAccept.

InvalidOperationException

EndAccept method was previously called.

SocketException

An error occurred when attempting to access the Socket See the Remarks section for more information.

EndAccept completes a call to BeginAccept. Before calling BeginAccept, you need to create a callback method that is invoked by the AsyncCallback delegate. This callback method executes in a separate thread, and is called by the system after the BeginAccept method returns.

Within the callback method, call the AsyncState method of the asyncResult parameter to obtain the Socket on which the connection attempt is being made. After obtaining the Socket, you can call the EndAccept method to successfully complete the connection attempt. The buffer parameter of this overload contains the data that was received in the call to BeginAccept and the bytesTransferred parameter contains the number of bytes that were transferred in the call.

The EndAccept method blocks until a connection is pending in the incoming connection queue. The EndAccept method accepts the incoming connection and returns a new Socket that can be used to send data to and receive data from the remote host.

NoteNote:

If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation in the MSDN library for a detailed description of the error.

NoteNote:

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing.

The following code example uses BeginAccept to create and connect a socket and accept the initial 10 bytes of data. The callback delegate calls EndAccept to end the asynchronous request. The number of bytes transmitted and the data are returned in the buffer and bytesTransferred parameters of this method and are displayed on the console.

    // This server waits for a connection and then uses asynchronous operations to
    // accept the connection with initial data sent from the client.
         
    
    // Establish the local endpoint for the socket.

    IPHostEntry ipHostInfo = Dns.GetHostEntry(Dns.GetHostName());
    IPAddress ipAddress = ipHostInfo.AddressList[0];
    IPEndPoint localEndPoint = new IPEndPoint(ipAddress, 11000);
   
    // Create a TCP/IP socket.
    Socket listener = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp );

    // Bind the socket to the local endpoint, and listen for incoming connections.
    listener.Bind(localEndPoint);
    listener.Listen(100);

    while (true) 
    {
        // Set the event to nonsignaled state.
        allDone.Reset();

        // Start an asynchronous socket to listen for connections and receive data from the client.
        Console.WriteLine("Waiting for a connection...");

        // Accept the connection and receive the first 10 bytes of data.
        int receivedDataSize = 10;
        listener.BeginAccept(receivedDataSize, new AsyncCallback(AcceptReceiveCallback), listener);
         
        // Wait until a connection is made and processed before continuing.
        allDone.WaitOne();
    }
      
}


public static void AcceptReceiveCallback(IAsyncResult ar) 
{
    // Get the socket that handles the client request.
    Socket listener = (Socket) ar.AsyncState;
    
    // End the operation and display the received data on the console.
    byte[] Buffer;
    int bytesTransferred;
    Socket handler = listener.EndAccept(out Buffer, out bytesTransferred, ar);
    string stringTransferred = Encoding.ASCII.GetString(Buffer, 0, bytesTransferred);
     
    Console.WriteLine(stringTransferred);
    Console.WriteLine("Size of data transferred is {0}", bytesTransferred);
          
    // Create the state object for the asynchronous receive.
    StateObject state = new StateObject();
    state.workSocket = handler;
    handler.BeginReceive( state.buffer, 0, StateObject.BufferSize, 0,
    new AsyncCallback(ReadCallback), state);
}

    // This server waits for a connection and then uses asynchronous 
    // operations to
    // accept the connection with initial data sent from the client.
    // Establish the local endpoint for the socket.
    IPHostEntry ipHostInfo = Dns.GetHostEntry(Dns.GetHostName());
    IPAddress ipAddress = ipHostInfo.get_AddressList()[0];
    IPEndPoint localEndPoint = new IPEndPoint(ipAddress, 11000);
    // Create a TCP/IP socket.
    Socket listener = new Socket(AddressFamily.InterNetwork, 
        SocketType.Stream, ProtocolType.Tcp);
    // Bind the socket to the local endpoint, and listen for incoming 
    // connections.
    listener.Bind(localEndPoint);
    listener.Listen(100);

    while (true) {
        // Set the event to nonsignaled state.
        allDone.Reset();
        // Start an asynchronous socket to listen for connections and 
        // receive data from the client.
        Console.WriteLine("Waiting for a connection...");
        // Accept the connection and receive the first 10 bytes of data.
        int receivedDataSize = 10;
        listener.BeginAccept(receivedDataSize, 
            new AsyncCallback(AcceptReceiveCallback), listener);
        // Wait until a connection is made and processed before continuing.
        allDone.WaitOne();
    }
} //Listen

public static void AcceptReceiveCallback(IAsyncResult ar)
{
    // Get the socket that handles the client request.
    Socket listener = (Socket)ar.get_AsyncState();
    // End the operation and display the received data on the console.
    ubyte buffer[] = {};
    int bytesTransferred = 0;
    Socket handler = listener.EndAccept(buffer, bytesTransferred, ar);
    String stringTransferred = Encoding.get_ASCII().GetString(buffer,
        0, bytesTransferred);

    Console.WriteLine(stringTransferred);
    Console.WriteLine("Size of data transferred is {0}", 
        (System.Int32)bytesTransferred);
    // Create the state object for the asynchronous receive.
    StateObject state = new StateObject();
    state.workSocket = handler;
    handler.BeginReceive(state.buffer, 0, StateObject.BufferSize, 
        (SocketFlags)0, new AsyncCallback(ReadCallback), state);
} //AcceptReceiveCallback

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.