This documentation is archived and is not being maintained.

TcpChannel Class

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 ref class TcpChannel : IChannelReceiver, 
	IChannelSender, IChannel, ISecurableChannel

The TcpChannel type exposes the following members.

Public methodTcpChannel()Initializes a new instance of the TcpChannel class, activating only a client channel, and not a server channel.
Public methodTcpChannel(Int32)Initializes a new instance of the TcpChannel class with a server channel that listens on the specified port.
Public methodTcpChannel(IDictionary, IClientChannelSinkProvider, IServerChannelSinkProvider)Initializes a new instance of the TcpChannel class with the specified configuration properties and sinks.

Public propertyChannelDataGets the channel-specific data.
Public propertyChannelNameGets the name of the current channel.
Public propertyChannelPriorityGets the priority of the current channel.
Public propertyIsSecuredGets or sets a Boolean value that indicates whether the current channel is secure.

Public methodCreateMessageSinkReturns a channel message sink that delivers messages to the specified URL or channel data object.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUrlsForUriReturns an array of all the URLs for an object with the specified URI, hosted on the current TcpChannel.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodParseExtracts the channel URI and the remote well-known object URI from the specified URL.
Public methodStartListeningInstructs the current channel to start listening for requests.
Public methodStopListeningInstructs the current channel to stop listening for requests.
Public methodToStringReturns 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.Runtime.Remoting.dll>
#using <System.dll>
#using <common.dll>

using namespace System;
using namespace System::Runtime::Remoting;
using namespace System::Runtime::Remoting::Channels;
using namespace System::Runtime::Remoting::Channels::Tcp;
using namespace System::Security::Permissions;

int main(array<String^>^ args)
    // Create the server channel.
    TcpChannel^ serverChannel = gcnew 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;
    for each (String^ uri in data->ChannelUris)
        Console::WriteLine("The channel URI is {0}.", uri);

    // Expose an object for remote calls.
        RemoteObject::typeid, "RemoteObject.rem", 

    // Parse the channel's URI.
    array<String^>^ urls = serverChannel->GetUrlsForUri("RemoteObject.rem");
    if (urls->Length > 0)
        String^ objectUrl = urls[0];
        String^ objectUri;
        String^ channelUri = serverChannel->Parse(objectUrl, 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.Runtime.Remoting.dll>
#using <System.dll>
#using <common.dll>

using namespace System;
using namespace System::Runtime::Remoting;
using namespace System::Runtime::Remoting::Channels;
using namespace System::Runtime::Remoting::Channels::Tcp;
using namespace System::Security::Permissions;

int main(array<String^>^ args)
    // Create the channel.
    TcpChannel^ clientChannel = gcnew TcpChannel();

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

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

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

    // Create an instance of the remote object.
    RemoteObject^ service = gcnew 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 namespace System;
using namespace System::Runtime::Remoting;

// Remote object.
public ref class RemoteObject: public MarshalByRefObject
   int callCount;

      : callCount( 0 )

   int GetCount()
      return (callCount);


.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

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