This documentation is archived and is not being maintained.

IpcChannel Class

Provides a channel implementation that uses the IPC protocol to transmit messages.


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

public class IpcChannel : IChannelReceiver, IChannelSender, 
	IChannel, ISecurableChannel

The IpcChannel type exposes the following members.

Public methodIpcChannel()Initializes a new instance of the IpcChannel class, activating only a client channel, and not a server channel.
Public methodIpcChannel(String)Initializes a new instance of the IpcChannel class with a server channel that listens on the specified IPC port.
Public methodIpcChannel(IDictionary, IClientChannelSinkProvider, IServerChannelSinkProvider)Initializes a new instance of the IpcChannel class with the specified configuration properties and sinks.
Public methodIpcChannel(IDictionary, IClientChannelSinkProvider, IServerChannelSinkProvider, CommonSecurityDescriptor)Initializes a new instance of the IpcChannel class with the specified configuration properties and sinks.

Public propertyChannelDataGets the channel-specific data.
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.

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.)
Public methodGetUrlsForUriReturns an array of all the URLs for an object with the specified URI, hosted on the current IpcChannel.
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 methodStartListeningInstructs the current channel to start listening for requests.
Public methodStopListeningInstructs the current channel to stop listening for requests.
Public methodToStringReturns 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 IpcChannel class is a convenience class combining the functionality of the IpcClientChannel class and the IpcServerChannel class.

Caution noteCaution

When setting the exclusiveAddressUse property to false in the properties argument, several IpcServerChannel objects can be registered for the same named pipe. In such a case requests can go to any of the channels registered. This setting is considered secure only if ALCs are also used.

The following code example shows how to use a IpcChannel to set up a remoting server and its client. The example contains three parts:

  • A server

  • A client

  • A remote object used by the server and the client.

The following code example shows a server.

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

public class Server
    public static void Main(string[] args)
        // Create the server channel.
        IpcChannel serverChannel = 
            new IpcChannel("localhost:9090"); 

        // Register the server channel.

        // Show the name of the channel.
        Console.WriteLine("The name of the channel is {0}.", 

        // Show the priority of the channel.
        Console.WriteLine("The priority of the channel is {0}.", 

        // Show the URIs associated with the channel.
        System.Runtime.Remoting.Channels.ChannelDataStore channelData = 
        foreach (string uri in channelData.ChannelUris)
            Console.WriteLine("The channel URI is {0}.", uri);

        // Expose an object for remote calls.
                typeof(RemoteObject), "RemoteObject.rem", 

        // Parse the channel's URI.
        string[] urls = serverChannel.GetUrlsForUri("RemoteObject.rem");
        if (urls.Length > 0)
            string objectUrl = urls[0];
            string objectUri;
            string channelUri = serverChannel.Parse(objectUrl, out objectUri);
            Console.WriteLine("The object URI is {0}.", objectUri);
            Console.WriteLine("The channel URI is {0}.", channelUri);
            Console.WriteLine("The object URL is {0}.", objectUrl);

        // Wait for the user prompt.
        Console.WriteLine("Press ENTER to exit the server.");
        Console.WriteLine("The server is exiting.");

The following code example shows a client for this server.

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

public class Client
    public static void Main(string[] args)
        // Create the channel.
        IpcChannel channel = new IpcChannel();

        // Register the channel.

        // Register as client for remote object.
        System.Runtime.Remoting.WellKnownClientTypeEntry remoteType = 
            new System.Runtime.Remoting.WellKnownClientTypeEntry(

        // Create a message sink.
        string objectUri;
        System.Runtime.Remoting.Messaging.IMessageSink messageSink =
                "ipc://localhost:9090/RemoteObject.rem", null,
                out objectUri);
        Console.WriteLine("The URI of the message sink is {0}.",
        if (messageSink != null)
            Console.WriteLine("The type of the message sink is {0}.",

        // Create an instance of the remote object.
        RemoteObject service = new RemoteObject(); 

        // Invoke a method on the remote object.
        Console.WriteLine("The client is invoking the remote object.");
        Console.WriteLine("The remote object has been called {0} times.",

The following code example shows the remote object used by the server and the client.

using System;

// Remote object.
public class RemoteObject : MarshalByRefObject
    private int callCount = 0;

    public int GetCount()
        Console.WriteLine("GetCount has been called.");

.NET Framework

Supported in: 4, 3.5, 3.0, 2.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.