IpcServerChannel Class

Definition

Namespace:

System.Runtime.Remoting.Channels.Ipc

Assembly:

System.Runtime.Remoting.dll

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

public ref class IpcServerChannel : System::Runtime::Remoting::Channels::IChannelReceiver, System::Runtime::Remoting::Channels::ISecurableChannel

public class IpcServerChannel : System.Runtime.Remoting.Channels.IChannelReceiver, System.Runtime.Remoting.Channels.ISecurableChannel

type IpcServerChannel = class
    interface IChannelReceiver
    interface IChannel
    interface ISecurableChannel

Public Class IpcServerChannel
Implements IChannelReceiver, ISecurableChannel

Inheritance

Object

IpcServerChannel

Implements

IChannel IChannelReceiver ISecurableChannel

Examples

The following code example illustrates how to use the IpcServerChannel class.

#using <system.runtime.remoting.dll>
#using <System.dll>
#using <Counter.dll>

using namespace System;
using namespace System::Runtime::Remoting;
using namespace System::Runtime::Remoting::Channels;
using namespace System::Runtime::Remoting::Channels::Ipc;

public ref class IpcServer
{
public:
   void IpcServerTest()
   {
      // Create and register an IPC channel
      IpcServerChannel^ serverChannel = gcnew IpcServerChannel( L"remote" );
      ChannelServices::RegisterChannel( serverChannel );

      // Expose an object
      RemotingConfiguration::RegisterWellKnownServiceType( Counter::typeid, L"counter", WellKnownObjectMode::Singleton );
      
      // Wait for calls
      Console::WriteLine( L"Listening on {0}", serverChannel->GetChannelUri() );

      Console::ReadLine();
   }
};

int main()
{
   IpcServer^ is = gcnew IpcServer;
   is->IpcServerTest();
}

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");
        ChannelServices.RegisterChannel(serverChannel);

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

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

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

using namespace System;
public ref class Counter: public MarshalByRefObject
{
private:
   int count;

public:
   Counter()
   {
      count = 0;
   }

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

using System;

public class Counter : MarshalByRefObject {

  private int count = 0;

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

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

Remarks

Important

Calling methods from this class with untrusted data is a security risk. Call the methods from this class only with trusted data. For more information, see Validate All Inputs.

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

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.

Constructors

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

Properties

ChannelData	Gets channel-specific data.
ChannelName	Gets the name of the current channel.
ChannelPriority	Gets the priority of the current channel.
IsSecured	Gets or sets a Boolean value that indicates whether the current channel is secure.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetChannelUri()	Returns the URI of the current channel.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetUrlsForUri(String)	Returns an array of all the URLs for the object with the specified URI, hosted on the current IpcChannel instance.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Parse(String, String)	Extracts the channel URI and the remote well-known object URI from the specified URL.
StartListening(Object)	Instructs the current channel to start listening for requests.
StopListening(Object)	Instructs the current channel to stop listening for requests.
ToString()	Returns a string that represents the current object. (Inherited from Object)