Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
IpcChannel Class

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

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
{
[SecurityPermission(SecurityAction.Demand)]
    public static void Main(string[] args)
    {
        // Create the server channel.
        IpcChannel serverChannel = 
            new IpcChannel("localhost:9090"); 

        // Register the server channel.
        System.Runtime.Remoting.Channels.ChannelServices.RegisterChannel(
            serverChannel);

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

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

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

        // Expose an object for remote calls.
        System.Runtime.Remoting.RemotingConfiguration.
            RegisterWellKnownServiceType(
                typeof(RemoteObject), "RemoteObject.rem", 
                System.Runtime.Remoting.WellKnownObjectMode.Singleton);

        // 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.ReadLine();
        Console.WriteLine("The server is exiting.");
    }
}
#using <mscorlib.dll>
#using <System.dll>
#using <System.Runtime.Remoting.dll>
#using "common.dll"
using namespace System;
using namespace System::Runtime::Remoting::Channels::Ipc;

void main()
{
    // Create the server channel.
    IpcChannel* serverChannel = 
        new IpcChannel(S"localhost:9090"); 

    // Register the server channel.
    System::Runtime::Remoting::Channels::ChannelServices::RegisterChannel(
        serverChannel);

    // Show the name of the channel.
    Console::WriteLine(S"The name of the channel is {0}.", 
        serverChannel->ChannelName);

    // Show the priority of the channel.
    Console::WriteLine(S"The priority of the channel is {0}.", __box(serverChannel->ChannelPriority));

    // Show the URIs associated with the channel.
    System::Runtime::Remoting::Channels::ChannelDataStore* channelData = 
        static_cast<System::Runtime::Remoting::Channels::ChannelDataStore*>( 
        serverChannel->ChannelData);
    System::Collections::IEnumerator* myEnum = channelData->ChannelUris->GetEnumerator();
    while (myEnum->MoveNext())
    {
        String* uri = __try_cast<String*>(myEnum->Current);
        Console::WriteLine(S"The channel URI is {0}.", uri);
    }

    // Expose an object for remote calls.
    System::Runtime::Remoting::RemotingConfiguration::
        RegisterWellKnownServiceType(
            __typeof(RemoteObject), S"RemoteObject.rem", 
            System::Runtime::Remoting::WellKnownObjectMode::Singleton);

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

    // Wait for the user prompt.
    Console::WriteLine(S"Press ENTER to exit the server.");
    Console::ReadLine();
    Console::WriteLine(S"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
{
[SecurityPermission(SecurityAction.Demand)]
    public static void Main(string[] args)
    {
        // Create the channel.
        IpcChannel channel = new IpcChannel();

        // Register the channel.
        System.Runtime.Remoting.Channels.ChannelServices.
            RegisterChannel(channel);

        // Register as client for remote object.
        System.Runtime.Remoting.WellKnownClientTypeEntry remoteType = 
            new System.Runtime.Remoting.WellKnownClientTypeEntry(
                typeof(RemoteObject),
                "ipc://localhost:9090/RemoteObject.rem");
        System.Runtime.Remoting.RemotingConfiguration.
            RegisterWellKnownClientType(remoteType);

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

        // 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.",
            service.GetCount());
    }
}
#using <mscorlib.dll>
#using <System.dll>
#using <System.Runtime.Remoting.dll>
#using "common.dll"
using namespace System;
using namespace System::Runtime::Remoting::Channels::Ipc;

void main()
{
    // Create the channel.
    IpcChannel* channel = new IpcChannel();

    // Register the channel.
    System::Runtime::Remoting::Channels::ChannelServices::
        RegisterChannel(channel);

    // Register as client for remote object.
    System::Runtime::Remoting::WellKnownClientTypeEntry* remoteType = 
        new System::Runtime::Remoting::WellKnownClientTypeEntry(
            __typeof(RemoteObject),
            S"ipc://localhost:9090/RemoteObject.rem");
    System::Runtime::Remoting::RemotingConfiguration::
        RegisterWellKnownClientType(remoteType);

    // Create a message sink.
    String* objectUri;
    System::Runtime::Remoting::Messaging::IMessageSink* messageSink =
        channel->CreateMessageSink(
            S"ipc://localhost:9090/RemoteObject.rem", 0,
            &objectUri);
    Console::WriteLine(S"The URI of the message sink is {0}.",
        objectUri);
    if (messageSink != 0)
    {
        Console::WriteLine(S"The type of the message sink is {0}.",
            messageSink->GetType());
    }

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

    // Invoke a method on the remote object.
    Console::WriteLine(S"The client is invoking the remote object.");
    Console::WriteLine(S"The remote object has been called {0} times.", __box(service->GetCount()));
}

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.");
        callCount++;
        return(callCount);
    }
}
#using <mscorlib.dll>
using namespace System;

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

public:
    int GetCount()
    {
        Console::WriteLine(S"GetCount has been called.");
        callCount++;
        return(callCount);
    }
};

System.Object
  System.Runtime.Remoting.Channels.Ipc.IpcChannel

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2015 Microsoft