This documentation is archived and is not being maintained.

TcpClientChannel Class

For remote calls, implements a client channel that uses the TCP protocol to transmit messages.

System.Object
  System.Runtime.Remoting.Channels.Tcp.TcpClientChannel

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

public class TcpClientChannel : IChannelSender, 
	IChannel, ISecurableChannel

The TcpClientChannel type exposes the following members.

  NameDescription
Public methodTcpClientChannel()Initializes a new instance of the TcpClientChannel class.
Public methodTcpClientChannel(IDictionary, IClientChannelSinkProvider)Initializes a new instance of the TcpClientChannel class with the specified configuration properties and sink.
Public methodTcpClientChannel(String, IClientChannelSinkProvider)Initializes a new instance of the TcpClientChannel class with the specified name and sink.
Top

  NameDescription
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
Top

  NameDescription
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.)
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 methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Channels transport messages across remoting boundaries (for example, computers or application domains). The TcpClientChannel class transports messages using the TCP protocol.

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 on the client side, you can specify an implementation of the IClientChannelSinkProvider interface through which all messages processed by the TcpClientChannel are passed.

By default, the TcpClientChannel class uses a binary formatter to serialize all messages.

A TcpClientChannel 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 TcpClientChannel constructor). For a list of these configuration properties, see the documentation for TcpClientChannel.

The following code example shows the use of the TcpClientChannel class to call a remote type.


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

public class Client
{
    [SecurityPermission(SecurityAction.LinkDemand)]
    public static void Main()
    {

        // Set up a client channel.
        TcpClientChannel clientChannel = new TcpClientChannel();
        ChannelServices.RegisterChannel(clientChannel);

        // Show the name and priority of the channel.
        Console.WriteLine("Channel Name: {0}", clientChannel.ChannelName);
        Console.WriteLine("Channel Priority: {0}", clientChannel.ChannelPriority);

        // Obtain a proxy for a remote object.
        RemotingConfiguration.RegisterWellKnownClientType(
            typeof(Remotable), "tcp://localhost:9090/Remotable.rem"
        );

        // Call a method on the object.
        Remotable remoteObject = new Remotable();
        Console.WriteLine( remoteObject.GetCount() );
    }

}


The remote type called in the example above is defined by the following code.


using System;
using System.Runtime.Remoting;

public class Remotable : MarshalByRefObject
{

    private int callCount = 0;

    public int GetCount()
    {
        callCount++;
        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.
Show: