TcpClientChannel Class

Definition

Namespace:

System.Runtime.Remoting.Channels.Tcp

Assembly:

System.Runtime.Remoting.dll

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

public ref class TcpClientChannel : System::Runtime::Remoting::Channels::IChannelSender, System::Runtime::Remoting::Channels::ISecurableChannel

public class TcpClientChannel : System.Runtime.Remoting.Channels.IChannelSender, System.Runtime.Remoting.Channels.ISecurableChannel

type TcpClientChannel = class
    interface IChannelSender
    interface IChannel
    interface ISecurableChannel

Public Class TcpClientChannel
Implements IChannelSender, ISecurableChannel

Inheritance

Object

TcpClientChannel

Implements

IChannel IChannelSender ISecurableChannel

Examples

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

#using <System.Runtime.Remoting.dll>
#using <System.dll>
#using <Remotable.dll>

using namespace System;
using namespace System::Runtime::Remoting;
using namespace System::Runtime::Remoting::Channels;
using namespace System::Runtime::Remoting::Channels::Tcp;
int main()
{
   
   // Set up a client channel.
   TcpClientChannel^ clientChannel = gcnew 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( Remotable::typeid, "tcp://localhost:9090/Remotable.rem" );
   
   // Call a method on the object.
   Remotable ^ remoteObject = gcnew Remotable;
   Console::WriteLine( remoteObject->GetCount() );
}

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

public class Client
{
    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 namespace System;
using namespace System::Runtime::Remoting;

public ref class Remotable: public MarshalByRefObject
{
private:
   int callCount;

public:
   Remotable()
      : callCount( 0 )
   {}

   int GetCount()
   {
      callCount++;
      return (callCount);
   }
};

using System;
using System.Runtime.Remoting;

public class Remotable : MarshalByRefObject
{

    private int callCount = 0;

    public int GetCount()
    {
        callCount++;
        return(callCount);
    }
}

Remarks

Important

Calling methods from this class with untrusted data is a security risk. Call the methods from this class only with trusted data. For more information, see Validate All Inputs.

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.

Constructors

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

Properties

ChannelName	Gets the name of the current channel.
ChannelPriority	Gets the priority of the current channel.
IsSecured	Gets or sets a Boolean value that indicates whether the current channel is secure.

Methods

CreateMessageSink(String, Object, String)	Returns a channel message sink that delivers messages to the specified URL or channel data object.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Parse(String, String)	Extracts the channel URI and the remote well-known object URI from the specified URL.
ToString()	Returns a string that represents the current object. (Inherited from Object)