TcpListener.Server Property

Reference

Definition

Namespace:: System.Net.Sockets

Assemblies:: netstandard.dll, System.Net.Sockets.dll

Assembly:: System.Net.Sockets.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: TCPListener.cs

Source:: TCPListener.cs

Source:: TCPListener.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the underlying network Socket.

public:
 property System::Net::Sockets::Socket ^ Server { System::Net::Sockets::Socket ^ get(); };

protected:
 property System::Net::Sockets::Socket ^ Server { System::Net::Sockets::Socket ^ get(); };

public System.Net.Sockets.Socket Server { get; }

protected System.Net.Sockets.Socket Server { get; }

member this.Server : System.Net.Sockets.Socket

Public ReadOnly Property Server As Socket

Protected ReadOnly Property Server As Socket

Property Value

Socket

The underlying Socket.

Examples

The following code example demonstrates the use of the Server property. The underlying Socket is retrieved and the Linger Socket option is configured to time out after 10 seconds if data still remains in the network buffer after the connection is closed.

public static void listenerOption(string host, int port)
{
    IPHostEntry server = Dns.Resolve(host);
    IPAddress ipAddress = server.AddressList[0];

    Console.WriteLine("listening on {0}, port {1}", ipAddress, port);
    TcpListener listener = new TcpListener(ipAddress, port);
    Socket listenerSocket = listener.Server;		

    LingerOption lingerOption = new LingerOption(true, 10);
    listenerSocket.SetSocketOption(SocketOptionLevel.Socket, 
                      SocketOptionName.Linger, 
                      lingerOption);

    // start listening and process connections here.
    listener.Start();
}

Public Shared Sub listenerOption(host As String, port As Integer)
   Dim server As IPHostEntry = Dns.Resolve(host)
   Dim ipAddress As IPAddress = server.AddressList(0)
   
   Console.WriteLine("listening on {0}, port {1}", ipAddress, port)
   Dim listener As New TcpListener(ipAddress, port)
   Dim listenerSocket As Socket = listener.Server
   
   Dim lingerOption As New LingerOption(True, 10)
   listenerSocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption)
   
   ' start listening and process connections here.
   listener.Start()
End Sub

Remarks

TcpListener creates a Socket to listen for incoming client connection requests. Classes deriving from TcpListener can use this property to get this Socket. Use the underlying Socket returned by the Server property if you require access beyond that which TcpListener provides.

Note

The Server property only returns the Socket used to listen for incoming client connection requests. Use the AcceptSocket method to accept a pending connection request and obtain a Socket for sending and receiving data. You can also use the AcceptTcpClient method to accept a pending connection request and obtain a TcpClient for sending and receiving data.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.3, 1.4, 1.6, 2.0, 2.1

Share via