TcpClientChannel Class

TcpClientChannel Class

 

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)

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

public class TcpClientChannel : IChannelSender, IChannel, ISecurableChannel

NameDescription
System_CAPS_pubmethodTcpClientChannel()

Initializes a new instance of the TcpClientChannel class.

System_CAPS_pubmethodTcpClientChannel(IDictionary, IClientChannelSinkProvider)

Initializes a new instance of the TcpClientChannel class with the specified configuration properties and sink.

System_CAPS_pubmethodTcpClientChannel(String, IClientChannelSinkProvider)

Initializes a new instance of the TcpClientChannel class with the specified name and sink.

NameDescription
System_CAPS_pubpropertyChannelName

Gets the name of the current channel.

System_CAPS_pubpropertyChannelPriority

Gets the priority of the current channel.

System_CAPS_pubpropertyIsSecured

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

NameDescription
System_CAPS_pubmethodCreateMessageSink(String, Object, String)

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

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_protmethodFinalize()

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

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetType()

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

System_CAPS_protmethodMemberwiseClone()

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.

System_CAPS_pubmethodToString()

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

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
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
Show:
© 2016 Microsoft