HttpServerChannel Class

Definition

Implements a server channel for remote calls that uses the HTTP protocol to transmit messages.

public ref class HttpServerChannel : System::Runtime::Remoting::Channels::BaseChannelWithProperties, System::Runtime::Remoting::Channels::IChannelReceiver, System::Runtime::Remoting::Channels::IChannelReceiverHook
public class HttpServerChannel : System.Runtime.Remoting.Channels.BaseChannelWithProperties, System.Runtime.Remoting.Channels.IChannelReceiver, System.Runtime.Remoting.Channels.IChannelReceiverHook
type HttpServerChannel = class
    inherit BaseChannelWithProperties
    interface IChannelReceiver
    interface IChannel
    interface IChannelReceiverHook
Public Class HttpServerChannel
Inherits BaseChannelWithProperties
Implements IChannelReceiver, IChannelReceiverHook
Inheritance
Implements

Examples

The following code example shows how to use a HttpServerChannel object 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.dll>
#using <System.Runtime.Remoting.dll>
#using "common.dll"
using namespace System;
using namespace System::Runtime::Remoting;
using namespace System::Runtime::Remoting::Channels;
using namespace System::Runtime::Remoting::Channels::Http;

int main()
{
   // Create the server channel.
   HttpServerChannel^ serverChannel = gcnew HttpServerChannel( 9090 );
   
   // Register the server channel.
   ChannelServices::RegisterChannel( serverChannel );
   
   // Display the channel's scheme.
   Console::WriteLine( L"The channel scheme is {0}.", serverChannel->ChannelScheme );
   
   // Display the channel's URI.
   Console::WriteLine( L"The channel URI is {0}.", serverChannel->GetChannelUri() );
   
   // Expose an object for remote calls.
   RemotingConfiguration::RegisterWellKnownServiceType(
      RemoteObject::typeid, L"RemoteObject.rem", WellKnownObjectMode::Singleton );
   
   // Get the channel's sink chain.
   IServerChannelSink^ sinkChain = serverChannel->ChannelSinkChain;
   Console::WriteLine( L"The type of the server channel's sink chain is {0}.", sinkChain->GetType() );
   
   // See if the channel wants to listen.
   bool wantsToListen = serverChannel->WantsToListen;
   Console::WriteLine( L"The value of WantsToListen is {0}.", wantsToListen );
   
   // Parse the channel's URI.
   array<String^>^ urls = serverChannel->GetUrlsForUri( L"RemoteObject.rem" );
   if ( urls->Length > 0 )
   {
      String^ objectUrl = urls[ 0 ];
      String^ objectUri;
      String^ channelUri = serverChannel->Parse( objectUrl,  objectUri );
      Console::WriteLine( L"The object URI is {0}.", objectUri );
      Console::WriteLine( L"The channel URI is {0}.", channelUri );
      Console::WriteLine( L"The object URL is {0}.", objectUrl );
   }

   
   // Wait for the user prompt.
   Console::WriteLine( L"Press ENTER to exit the server." );
   Console::ReadLine();
   Console::WriteLine( L"The server is exiting." );
}
using System;
using System.Runtime.Remoting;
using System.Runtime.Remoting.Channels;
using System.Runtime.Remoting.Channels.Http;
using System.Security.Permissions;

public class Server
{
[SecurityPermission(SecurityAction.Demand)]
    public static void Main(string[] args)
    {
        // Create the server channel.
        HttpServerChannel serverChannel = new HttpServerChannel(9090);

        // Register the server channel.
        ChannelServices.RegisterChannel(serverChannel);

        // Display the channel's scheme.
        Console.WriteLine("The channel scheme is {0}.",
            serverChannel.ChannelScheme);

        // Display the channel's URI.
        Console.WriteLine("The channel URI is {0}.",
            serverChannel.GetChannelUri());

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

        // Get the channel's sink chain.
        IServerChannelSink sinkChain = serverChannel.ChannelSinkChain;
        Console.WriteLine(
            "The type of the server channel's sink chain is {0}.",
            sinkChain.GetType().ToString());

        // See if the channel wants to listen.
        bool wantsToListen = serverChannel.WantsToListen;
        Console.WriteLine(
            "The value of WantsToListen is {0}.",
            wantsToListen);

        // 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.");
    }
}

The following code example shows a client for this server.

#using <System.dll>
#using <System.Runtime.Remoting.dll>
#using "common.dll"
using namespace System;
using namespace System::Runtime::Remoting;
using namespace System::Runtime::Remoting::Channels;
using namespace System::Runtime::Remoting::Channels::Http;

void main()
{
   // Create the channel.
   HttpClientChannel^ channel = gcnew HttpClientChannel;
   
   // Register the channel.
   ChannelServices::RegisterChannel( channel );
   
   // Register as client for remote object.
   WellKnownClientTypeEntry^ remoteType = gcnew WellKnownClientTypeEntry(
      RemoteObject::typeid,L"http://localhost:9090/RemoteObject.rem" );
   RemotingConfiguration::RegisterWellKnownClientType( remoteType );
   
   // Create an instance of the remote object.
   RemoteObject^ service = gcnew RemoteObject;
   
   // Invoke a method on the remote object.
   Console::WriteLine( L"The client is invoking the remote object." );
   Console::WriteLine( L"The remote object has been called {0} times.", service->GetCount() );
}
using System;
using System.Runtime.Remoting;
using System.Runtime.Remoting.Channels;
using System.Runtime.Remoting.Channels.Http;

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

        // Register the channel.
        ChannelServices.RegisterChannel(channel);

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

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

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

using namespace System;
using namespace System::Runtime::Remoting;

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

public:
   int GetCount()
   {
      callCount++;
      return (callCount);
   }

};
using System;
using System.Runtime.Remoting;

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

    public int GetCount()
    {
        callCount++;
        return(callCount);
    }
}

Remarks

Channels transport messages across remoting boundaries (for example, between computers on application domains). The HttpServerChannel class transports messages using the HTTP protocol.

Channels are used by the .NET Framework remoting infrastructure to transport remote calls. When a client makes a call to a remote object, the call is serialized into a message that is sent by a client channel and received by a server channel. It is then deserialized and processed. Any returned values are transmitted by the server channel and received by the client channel.

To perform additional processing of messages on the server-side, you can specify an implementation of the IServerChannelSinkProvider through which all messages processed by the HttpServerChannel are passed.

The HttpServerChannel accepts messages serialized in either binary or SOAP format.

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

Constructors

HttpServerChannel()

Initializes a new instance of the HttpServerChannel class.

HttpServerChannel(IDictionary, IServerChannelSinkProvider)

Initializes a new instance of the HttpServerChannel class with the specified channel properties and sink.

HttpServerChannel(Int32)

Initializes a new instance of the HttpServerChannel class that listens on the specified port.

HttpServerChannel(String, Int32)

Initializes a new instance of the HttpServerChannel class with the given name and that listens on the specified port.

HttpServerChannel(String, Int32, IServerChannelSinkProvider)

Initializes a new instance of the HttpServerChannel class at the specified port with the given name, which listens on the specified port, and uses the specified sink.

Fields

SinksWithProperties

Indicates the top channel sink in the channel sink stack.

(Inherited from BaseChannelWithProperties)

Properties

ChannelData

Gets channel-specific data.

ChannelName

Gets the name of the current channel.

ChannelPriority

Gets the priority of the current channel.

ChannelScheme

Gets the type of listener to hook into (for example, "http").

ChannelSinkChain

Gets the channel sink chain that the current channel is using.

Count

Gets the number of properties associated with the channel object.

(Inherited from BaseChannelObjectWithProperties)
IsFixedSize

Gets a value that indicates whether the number of properties that can be entered into the channel object is fixed.

(Inherited from BaseChannelObjectWithProperties)
IsReadOnly

Gets a value that indicates whether the collection of properties in the channel object is read-only.

(Inherited from BaseChannelObjectWithProperties)
IsSynchronized

Gets a value that indicates whether the dictionary of channel object properties is synchronized.

(Inherited from BaseChannelObjectWithProperties)
Item[Object]

Returns the specified channel property.

Keys

Gets a ICollection of keys the channel properties are associated with.

Properties

Gets a IDictionary of the channel properties associated with the current channel object.

(Inherited from BaseChannelWithProperties)
SyncRoot

Gets an object that is used to synchronize access to the BaseChannelObjectWithProperties.

(Inherited from BaseChannelObjectWithProperties)
Values

Gets a ICollection of the values of the properties associated with the channel object.

(Inherited from BaseChannelObjectWithProperties)
WantsToListen

Gets a Boolean value that indicates whether IChannelReceiverHook wants to be hooked into the outside listener service.

Methods

Add(Object, Object)

Throws a NotSupportedException.

(Inherited from BaseChannelObjectWithProperties)
AddHookChannelUri(String)

Adds a URI on which the channel hook must listen.

Clear()

Throws a NotSupportedException.

(Inherited from BaseChannelObjectWithProperties)
Contains(Object)

Returns a value that indicates whether the channel object contains a property that is associated with the specified key.

(Inherited from BaseChannelObjectWithProperties)
CopyTo(Array, Int32)

Throws a NotSupportedException.

(Inherited from BaseChannelObjectWithProperties)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetChannelUri()

Returns the URI of the current channel.

GetEnumerator()

Returns a IDictionaryEnumerator that enumerates over all the properties associated with the channel object.

(Inherited from BaseChannelObjectWithProperties)
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 an object with the specified URI, hosted on the current HttpChannel.

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.

Remove(Object)

Throws a NotSupportedException.

(Inherited from BaseChannelObjectWithProperties)
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)

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns a IEnumerator that enumerates over all the properties that are associated with the channel object.

(Inherited from BaseChannelObjectWithProperties)

Extension Methods

Cast<TResult>(IEnumerable)

Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

Enables parallelization of a query.

AsQueryable(IEnumerable)

Converts an IEnumerable to an IQueryable.

Applies to

See also