TcpListener.Start Method

Definition

Namespace:

System.Net.Sockets

Assemblies:

netstandard.dll, System.Net.Sockets.dll

Starts listening for incoming connection requests.

Overloads

Start()	Starts listening for incoming connection requests.
Start(Int32)	Starts listening for incoming connection requests with a maximum number of pending connection.

Start()

Source:

TCPListener.cs

Starts listening for incoming connection requests.

C#

public void Start();

Exceptions

SocketException

Use the ErrorCode property to obtain the specific error code. When you have obtained this code, you can refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Examples

The following code example demonstrates how Start is used to listen for incoming client connection attempts.

C#

public static void DoStart(TcpListener t, int backlog)
{
    // Start listening for client connections with the
    // specified backlog.
    t.Start(backlog);
    Console.WriteLine("started listening");
}

Remarks

The Start method initializes the underlying Socket, binds it to a local endpoint, and listens for incoming connection attempts. If a connection request is received, the Start method will queue the request and continue listening for additional requests until you call the Stop method. If TcpListener receives a connection request after it has already queued the maximum number of connections, it will throw a SocketException on the client.

To remove a connection from the incoming connection queue, use either the AcceptTcpClient method or the AcceptSocket method. The AcceptTcpClient method will remove a connection from the queue and return a TcpClient that you can use to send and receive data. The AcceptSocket method will return a Socket that you can use to do the same. If your application only requires synchronous I/O, use AcceptTcpClient. For more detailed behavioral control, use AcceptSocket. Both of these methods block until a connection request is available in the queue.

Use the Stop method to close the TcpListener and stop listening. You are responsible for closing your accepted connections separately.

Note

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

See also

• Listen(Int32)
• Bind(EndPoint)
• AcceptTcpClient()
• Stop()

Start(Int32)

Source:

TCPListener.cs

Starts listening for incoming connection requests with a maximum number of pending connection.

C#

public void Start(int backlog);

Parameters

backlog

Int32

The maximum length of the pending connections queue.

Exceptions

SocketException

An error occurred while accessing the socket.

ArgumentOutOfRangeException

The backlog parameter is less than zero or exceeds the maximum number of permitted connections.

InvalidOperationException

The underlying Socket is null.

Examples

The following code example demonstrates how Start is used to listen for incoming client connection attempts.

C#

public static void DoStart(TcpListener t, int backlog)
{
    // Start listening for client connections with the
    // specified backlog.
    t.Start(backlog);
    Console.WriteLine("started listening");
}

Remarks

The Start method initializes the underlying Socket, binds it to a local endpoint, and listens for incoming connection attempts. If a connection request is received, Start will queue the request and continue listening for additional requests until you call the Stop method. If TcpListener receives a connection request after it has already queued the maximum number of connections it will throw a SocketException on the client.

To remove a connection from the incoming connection queue, use either the AcceptTcpClient method or the AcceptSocket method. The AcceptTcpClient method will remove a connection from the queue and return a TcpClient that you can use to send and receive data. The AcceptSocket method will return a Socket that you can use to do the same. If your application only requires synchronous I/O, use the AcceptTcpClient. For more detailed behavioral control, use AcceptSocket method. Both of these methods block until a connection request is available in the queue.

Use the Stop method to close the TcpListener and stop listening. You are responsible for closing your accepted connections separately.

Note

Use the SocketException.ErrorCode property to obtain the specific error code and refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Note

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

See also

• Listen(Int32)
• Bind(EndPoint)
• AcceptTcpClient()
• AcceptSocket()
• Stop()