IpcServerChannel Class

.NET Framework (current version)

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)

Inheritance Hierarchy

System::Object
System.Runtime.Remoting.Channels.Ipc::IpcServerChannel

Syntax

C++

public ref class IpcServerChannel : IChannelReceiver, IChannel, 
	ISecurableChannel

Constructors

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

Properties

	Name	Description
	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

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(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^)	This API supports the product infrastructure and is not intended to be used directly from your code. 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^%)	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.
	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.)

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.

Examples

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

C++

#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();
}

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

C++

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

public:
   Counter()
   {
      count = 0;
   }

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

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

Version Information

.NET Framework
Available since 2.0

Thread Safety

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