This documentation is archived and is not being maintained.

IpcServerChannel Class

Implements a server channel for remote calls that uses the IPC system to transmit messages.


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

public class IpcServerChannel : IChannelReceiver, 
	IChannel, ISecurableChannel

The IpcServerChannel type exposes the following members.

Public methodIpcServerChannel(String)Initializes a new instance of the IpcServerChannel class with the specified IPC port name.
Public methodIpcServerChannel(IDictionary, IServerChannelSinkProvider)Initializes a new instance of the IpcServerChannel class with the specified channel properties and sink.
Public methodIpcServerChannel(String, String)Initializes a new instance of the IpcServerChannel class with the specified channel name and IPC port name.
Public methodIpcServerChannel(IDictionary, IServerChannelSinkProvider, CommonSecurityDescriptor)Initializes a new instance of the IpcServerChannel class with the specified channel properties, sink, and security descriptor.
Public methodIpcServerChannel(String, String, IServerChannelSinkProvider)Initializes a new instance of the IpcServerChannel class with the specified channel name, IPC port name, and sink.

Public propertyChannelDataGets 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 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 methodGetChannelUriReturns the URI of the current channel.
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 methodGetUrlsForUriInfrastructure. Returns an array of all the URLs for the object with the specified URI, hosted on the current IpcChannel instance.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodParseInfrastructure. Extracts 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 IpcServerChannel 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 server side, specify an implementation of the IServerChannelSinkProvider interface through which all messages processed by the IpcServerChannel instance are passed.

The IpcServerChannel instance accepts messages serialized in either binary or SOAP format.

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

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 illustrates how to use the IpcServerChannel class.

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

public class IpcServer

    public static void Main ()
        // Create and register an IPC channel
        IpcServerChannel serverChannel = new IpcServerChannel("remote");

        // Expose an object
        RemotingConfiguration.RegisterWellKnownServiceType( typeof(Counter), "counter", WellKnownObjectMode.Singleton );

        // Wait for calls
        Console.WriteLine("Listening on {0}", serverChannel.GetChannelUri());


The preceding code is used to expose the following remote object.

using System;

public class Counter : MarshalByRefObject {

  private int count = 0;

  public int Count { get {
  } }


For an example of a client using this object remotely, see IpcClientChannel.

.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.