TcpChannel Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Provides a channel implementation that uses the TCP protocol to transmit messages.

Namespace:   System.Runtime.Remoting.Channels.Tcp
Assembly:  System.Runtime.Remoting (in System.Runtime.Remoting.dll)


public class TcpChannel : IChannelReceiver, IChannel, IChannelSender, 


Initializes a new instance of the TcpChannel class, activating only a client channel, and not a server channel.

System_CAPS_pubmethodTcpChannel(IDictionary, IClientChannelSinkProvider, IServerChannelSinkProvider)

Initializes a new instance of the TcpChannel class with the specified configuration properties and sinks.


Initializes a new instance of the TcpChannel class with a server channel that listens on the specified port.


Gets the channel-specific data.


Gets the name of the current channel.


Gets the priority of the current channel.


Gets or sets a Boolean value that indicates whether the current channel is secure.

System_CAPS_pubmethodCreateMessageSink(String, Object, String)

Returns a channel message sink that delivers messages to the specified URL or channel data object.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Returns an array of all the URLs for an object with the specified URI, hosted on the current TcpChannel.


Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodParse(String, String)

Extracts the channel URI and the remote well-known object URI from the specified URL.


Instructs the current channel to start listening for requests.


Instructs the current channel to stop listening for requests.


Returns a string that represents the current object.(Inherited from Object.)

Channels transport messages across remoting boundaries (for example, between computers on application domains). The TcpChannel class is a convenience class combining the functionality of the TcpClientChannel class and the TcpServerChannel class.

Channels are used by the .NET Framework remoting infrastructure to transport remote calls. When a client makes a call to a remote object, the call is serialized into a message that is sent by a client channel and received by a server channel. It is then deserialized and processed. Any returned values are transmitted by the server channel and received by the client channel.

To perform additional processing of messages, you can specify implementations of the IClientChannelSinkProvider and IServerChannelSinkProvider through which all messages processed by the TcpChannel are passed.

A TcpChannel object has associated configuration properties that can be set at run time either in a configuration file (by invoking the static RemotingConfiguration.Configure method) or programmatically (by passing a IDictionary collection to the TcpChannel constructor). For more information about channel configuration properties, see Channel and Formatter Configuration Properties.


If the server computer is running Windows 95/98/Me, the server TcpChannel cannot be specified as secure.

The following code example shows how to use a TcpChannel to set up a remoting server and its client. The example contains three parts, a server, a client, and a remote object used by the server and the client.

The following code example shows a server:

using System;
using System.Runtime.Remoting;
using System.Runtime.Remoting.Channels;
using System.Runtime.Remoting.Channels.Tcp;
using System.Security.Permissions;

public class Server
    public static void Main(string[] args)
        // Create the server channel.
        TcpChannel serverChannel = new TcpChannel(9090);

        // Register the server channel.

        // Show the name of the channel.
        Console.WriteLine("The name of the channel is {0}.", 

        // Show the priority of the channel.
        Console.WriteLine("The priority of the channel is {0}.", 

        // Show the URIs associated with the channel.
        ChannelDataStore data = (ChannelDataStore) serverChannel.ChannelData;
        foreach (string uri in data.ChannelUris)
            Console.WriteLine("The channel URI is {0}.", uri);

        // Expose an object for remote calls.
            typeof(RemoteObject), "RemoteObject.rem", 

        // Parse the channel's URI.
        string[] urls = serverChannel.GetUrlsForUri("RemoteObject.rem");
        if (urls.Length > 0)
            string objectUrl = urls[0];
            string objectUri;
            string channelUri = serverChannel.Parse(objectUrl, out objectUri);
            Console.WriteLine("The object URL is {0}.", objectUrl);
            Console.WriteLine("The object URI is {0}.", objectUri);
            Console.WriteLine("The channel URI is {0}.", channelUri);

        // Wait for the user prompt.
        Console.WriteLine("Press ENTER to exit the server.");

The following code example shows a client for this server:

using System;
using System.Runtime.Remoting;
using System.Runtime.Remoting.Channels;
using System.Runtime.Remoting.Channels.Tcp;
using System.Security.Permissions;

public class Client
    public static void Main(string[] args)
        // Create the channel.
        TcpChannel clientChannel = new TcpChannel();

        // Register the channel.
        ChannelServices.RegisterChannel(clientChannel, false);

        // Register as client for remote object.
        WellKnownClientTypeEntry remoteType = new WellKnownClientTypeEntry(

        // Create a message sink.
        string objectUri;
        System.Runtime.Remoting.Messaging.IMessageSink messageSink = 
                "tcp://localhost:9090/RemoteObject.rem", null,
                out objectUri);
        Console.WriteLine("The URI of the message sink is {0}.", 
        if (messageSink != null)
            Console.WriteLine("The type of the message sink is {0}.", 

        // Create an instance of the remote object.
        RemoteObject service = new RemoteObject(); 

        // Invoke a method on the remote object.
        Console.WriteLine("The client is invoking the remote object.");
        Console.WriteLine("The remote object has been called {0} times.",

The following code example shows the remote object used by the server and the client:

using System;
using System.Runtime.Remoting;

// Remote object.
public class RemoteObject : MarshalByRefObject
    private int callCount = 0;

    public int GetCount()

.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top