TcpListener.Stop Method

Closes the listener.

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

public void Stop()

ExceptionCondition
SocketException

Use the SocketException.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 in MSDN for a detailed description of the error.

Stop closes the listener. Any unaccepted connection requests in the queue will be lost. Remote hosts waiting for a connection to be accepted will throw a SocketException. You are responsible for closing your accepted connections separately.

NoteNote:

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

Notes to Callers:

The Stop method also closes the underlying Socket, and creates a new Socket for the TcpListener. If you set any properties on the underlying Socket prior to calling the Stop method, those properties will not carry over to the new Socket.

The following code example demonstrates using the Stop method to close the underlying Socket.

using System;
using System.IO;
using System.Net;
using System.Net.Sockets;
using System.Text;

class MyTcpListener
{
  public static void Main()
  { 
    TcpListener server=null;   
    try
    {
      // Set the TcpListener on port 13000.
      Int32 port = 13000;
      IPAddress localAddr = IPAddress.Parse("127.0.0.1");

      // TcpListener server = new TcpListener(port);
      server = new TcpListener(localAddr, port);

      // Start listening for client requests.
      server.Start();

      // Buffer for reading data
      Byte[] bytes = new Byte[256];
      String data = null;

      // Enter the listening loop. 
      while(true) 
      {
        Console.Write("Waiting for a connection... ");

        // Perform a blocking call to accept requests. 
        // You could also user server.AcceptSocket() here.
        TcpClient client = server.AcceptTcpClient();            
        Console.WriteLine("Connected!");

        data = null;

        // Get a stream object for reading and writing
        NetworkStream stream = client.GetStream();

        int i;

        // Loop to receive all the data sent by the client. 
        while((i = stream.Read(bytes, 0, bytes.Length))!=0) 
        {   
          // Translate data bytes to a ASCII string.
          data = System.Text.Encoding.ASCII.GetString(bytes, 0, i);
          Console.WriteLine("Received: {0}", data);

          // Process the data sent by the client.
          data = data.ToUpper();

          byte[] msg = System.Text.Encoding.ASCII.GetBytes(data);

          // Send back a response.
          stream.Write(msg, 0, msg.Length);
          Console.WriteLine("Sent: {0}", data);            
        }

        // Shutdown and end connection
        client.Close();
      }
    }
    catch(SocketException e)
    {
      Console.WriteLine("SocketException: {0}", e);
    }
    finally
    {
       // Stop listening for new clients.
       server.Stop();
    }


    Console.WriteLine("\nHit enter to continue...");
    Console.Read();
  }   
}
#using <mscorlib.dll>
#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Net;
using namespace System::Net::Sockets;
using namespace System::Text;

void main() {    
    try {
        // Set the TcpListener on port 13000.
        Int32 port = 13000;
        IPAddress* localAddr = IPAddress::Parse(S"127.0.0.1");

        // TcpListener* server = new TcpListener(port);
        TcpListener* server = new TcpListener(localAddr, port);

        // Start listening for client requests.
        server->Start();

        // Buffer for reading data
        Byte bytes[] = new Byte[256];
        String* data = 0;

        // Enter the listening loop.
        while (true) {
            Console::Write(S"Waiting for a connection... ");

            // Perform a blocking call to accept requests.
            // You could also user server.AcceptSocket() here.
            TcpClient* client = server->AcceptTcpClient();            
            Console::WriteLine(S"Connected!");

            data = 0;

            // Get a stream Object* for reading and writing
            NetworkStream* stream = client->GetStream();

            Int32 i;

            // Loop to receive all the data sent by the client.
            while (i = stream->Read(bytes, 0, bytes->Length)) {   
                // Translate data bytes to a ASCII String*.
                data = Text::Encoding::ASCII->GetString(bytes, 0, i);
                Console::WriteLine(S"Received: {0}", data);

                // Process the data sent by the client.
                data = data->ToUpper();

                Byte msg[] = Text::Encoding::ASCII->GetBytes(data);

                // Send back a response.
                stream->Write(msg, 0, msg->Length);
                Console::WriteLine(S"Sent: {0}", data);            
            }

            // Shutdown and end connection
            client->Close();
        }
    } catch (SocketException* e) {
        Console::WriteLine(S"SocketException: {0}", e);
    }

    Console::WriteLine(S"\nHit enter to continue...");
    Console::Read();
}   

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft