IpcClientChannel Class

 

Implements a client channel for remote calls that uses the IPC protocol to transmit messages.

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

System.Object
  System.Runtime.Remoting.Channels.Ipc.IpcClientChannel

public class IpcClientChannel : IChannelSender, IChannel, ISecurableChannel

NameDescription
System_CAPS_pubmethodIpcClientChannel()

Initializes a new instance of the IpcServerChannel class.

System_CAPS_pubmethodIpcClientChannel(IDictionary, IClientChannelSinkProvider)

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

System_CAPS_pubmethodIpcClientChannel(String, IClientChannelSinkProvider)

Initializes a new instance of the IpcClientChannel 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)

This API supports the product infrastructure and is not intended to be used directly from your code. 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)

This API supports the product infrastructure and is not intended to be used directly from your code. 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 are used by the.NET Framework remoting infrastructure to transport remote calls. When a client calls a remote object, the call is serialized into a message that is sent by a client channel and received by a server channel. After the message is received, it is deserialized and processed. Any returned values are transmitted by the server channel and received by the client channel.

The IpcClientChannel class uses the Windows interprocess communication (IPC) system to transport messages between application domains on the same computer. When communicating between application domains on the same computer, the IPC channel is much faster than the TCP or HTTP channels.

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 IpcClientChannel object will be passed.

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

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

The following code example shows how to use the IpcClientChannel class.

using System;
using System.Runtime.Remoting;
using System.Runtime.Remoting.Channels;
using System.Runtime.Remoting.Channels.Ipc;


public class Client
{
    public static void Main ()
    {
        IpcClientChannel clientChannel = new IpcClientChannel();
        ChannelServices.RegisterChannel(clientChannel);

        RemotingConfiguration.RegisterWellKnownClientType( typeof(Counter) , "ipc://remote/counter" );

        Counter counter = new Counter();
        Console.WriteLine("This is call number {0}.", counter.Count);
    }

}

The preceding code uses the following remote object.

using System;

public class Counter : MarshalByRefObject {

  private int count = 0;

  public int Count { get {
    return(count++);
  } }

}

For an example of a server that exposes this object remotely, see IpcServerChannel.

.NET Framework
Available since 2.0

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: