TcpClientChannel Class

.NET Framework (current version)

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

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

Inheritance Hierarchy

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

Syntax

C++

public ref class TcpClientChannel : IChannelSender, IChannel, 
	ISecurableChannel

Constructors

	Name	Description
	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

	Name	Description
	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

	Name	Description
	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.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(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.)

Remarks

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.

Examples

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

C++

#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() );
}

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

C++

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);
   }
};

Version Information

.NET Framework
Available since 1.1

Thread Safety

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