HttpServerChannel Class

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

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

public class HttpServerChannel : BaseChannelWithProperties, 
	IChannelReceiver, IChannel, IChannelReceiverHook

The HttpServerChannel type exposes the following members.

  NameDescription
Public methodHttpServerChannel()Initializes a new instance of the HttpServerChannel class.
Public methodHttpServerChannel(Int32)Initializes a new instance of the HttpServerChannel class that listens on the specified port.
Public methodHttpServerChannel(IDictionary, IServerChannelSinkProvider)Initializes a new instance of the HttpServerChannel class with the specified channel properties and sink.
Public methodHttpServerChannel(String, Int32)Initializes a new instance of the HttpServerChannel class with the given name and that listens on the specified port.
Public methodHttpServerChannel(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.
Top

  NameDescription
Public propertyChannelDataGets channel-specific data.
Public propertyChannelNameGets the name of the current channel.
Public propertyChannelPriorityGets the priority of the current channel.
Public propertyChannelSchemeGets the type of listener to hook into (for example, "http").
Public propertyChannelSinkChainGets the channel sink chain that the current channel is using.
Public propertyCountGets the number of properties associated with the channel object. (Inherited from BaseChannelObjectWithProperties.)
Public propertyIsFixedSizeGets a value that indicates whether the number of properties that can be entered into the channel object is fixed. (Inherited from BaseChannelObjectWithProperties.)
Public propertyIsReadOnlyGets a value that indicates whether the collection of properties in the channel object is read-only. (Inherited from BaseChannelObjectWithProperties.)
Public propertyIsSynchronizedGets a value that indicates whether the dictionary of channel object properties is synchronized. (Inherited from BaseChannelObjectWithProperties.)
Public propertyItemReturns the specified channel property. (Overrides BaseChannelObjectWithProperties.Item[Object].)
Public propertyKeysGets a ICollection of keys the channel properties are associated with. (Overrides BaseChannelObjectWithProperties.Keys.)
Public propertyPropertiesGets a IDictionary of the channel properties associated with the current channel object. (Inherited from BaseChannelWithProperties.)
Public propertySyncRootGets an object that is used to synchronize access to the BaseChannelObjectWithProperties. (Inherited from BaseChannelObjectWithProperties.)
Public propertyValuesGets a ICollection of the values of the properties associated with the channel object. (Inherited from BaseChannelObjectWithProperties.)
Public propertyWantsToListenGets a Boolean value that indicates whether IChannelReceiverHook wants to be hooked into the outside listener service.
Top

  NameDescription
Public methodAddThrows a NotSupportedException. (Inherited from BaseChannelObjectWithProperties.)
Public methodAddHookChannelUriAdds a URI on which the channel hook must listen.
Public methodClearThrows a NotSupportedException. (Inherited from BaseChannelObjectWithProperties.)
Public methodContainsReturns a value that indicates whether the channel object contains a property that is associated with the specified key. (Inherited from BaseChannelObjectWithProperties.)
Public methodCopyToThrows a NotSupportedException. (Inherited from BaseChannelObjectWithProperties.)
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 methodGetEnumeratorReturns a IDictionaryEnumerator that enumerates over all the properties associated with the channel object. (Inherited from BaseChannelObjectWithProperties.)
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 methodGetUrlsForUriReturns an array of all the URLs for an object with the specified URI, hosted on the current HttpChannel.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodParseExtracts the channel URI and the remote well-known object URI from the specified URL.
Public methodRemoveThrows a NotSupportedException. (Inherited from BaseChannelObjectWithProperties.)
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.)
Top

  NameDescription
Protected fieldSinksWithPropertiesIndicates the top channel sink in the channel sink stack. (Inherited from BaseChannelWithProperties.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorInfrastructure. Returns a IEnumerator that enumerates over all the properties that are associated with the channel object. (Inherited from BaseChannelObjectWithProperties.)
Top

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.

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;
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;
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 System;
using System.Runtime.Remoting;

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

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

}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft