System.Runtime.Remoting.Channels.Http.HttpServerChannel Class

Summary

Provides an implementation for a server channel that uses the HTTP protocol to transmit messages.

C# Syntax:

public class HttpServerChannel : BaseChannelWithProperties, IChannelReceiver, IChannel, IChannelReceiverHook

By default, the HttpServerChannel accepts messages in either SOAP or binary format.

Channels transport messages between applications across remoting boundaries (for example application domains, processes, and machines). These crossings include both inbound and outbound. The current channel listens on an endpoint for inbound. The HttpServerChannel converts the messages sent along it from the HTTP protocol into message objects.

If there are common language runtimes at both ends of the channel, then a session is created between the two ends, in order to connect the client and server sink chains on either side of the boundary together. The client part of the channel is located at the end of the client context sink chain. The server part of the channel is located at the start of the server context sink chain. Messages are delivered to the client part of the channel, travel through it, and are received by the HttpServerChannel. The channel then delivers the messages to the first server context sink.

IChannel implementations use channel configuration properties to configure the channel at run time. Channel properties can be specified in a configuration file, or programmatically, inside of an IDictionary. In a configuration file all values are represented by strings, but when building a property IDictionary programmatically, value types can be specified with their native values or with strings.

The following table shows the channel configuration properties that can be specified for the current channel.

Property	Description
name	Indicates the name of the channel. This property is used to retrieve a specific channel when calling ChannelServices.GetChannel . If this property is not set, the system defaults to "http". If you want to register more than one HttpChannel , each must have a unique name. Set this property to the String.Empty string ("") if you want to ignore names and avoid naming collisions. The system will allow any number of channels with the String.Empty name.
priority	An integer representing the priority assigned to this channel. For server channels, the priority controls the order in which the channel data appears in an ObjRef . Clients will try to connect to the server channels in the order that they are listed in the ObjRef . The default priority is 1, and negative numbers are allowed. The default priority is 1, and negative numbers are allowed.
port	An integer specifying the port on which the channel will listen.
supressChannelData	true or false . Specifies that the channel will not contribute to the HttpChannel.ChannelData .
useIpAddress	true or false . Specifies whether the channel will use the IP address in the publication URL instead of the computer name.
listen	true or false . Specifies whether to allow activation to hook into the outside listener service.
bindTo	An IP address resolving to the current computer that specifies which NIC to bind the current channel to.
machineName	A string that specifies the machine name used with the current channel. Overrides the useIpAddress configuration property and the machine name channel data.

System.Runtime.Remoting.Channels.Http Namespace See also:
MSDN: channelformatterconfigurationproperties

System.Runtime.Remoting.Channels.Http.HttpServerChannel Member List:

Public Constructors

ctor #1	Overloaded: .ctor() Default constructor. This constructor is called by derived class constructors to initialize state in this type. Initializes a new instance of the HttpServerChannel class with default values.
ctor #2	Overloaded: .ctor(int port) Initializes a new instance of the HttpServerChannel class at the specified port.
ctor #3	Overloaded: .ctor(IDictionary properties, IServerChannelSinkProvider sinkProvider) Initializes a new instance of the HttpServerChannel class with the specified channel properties and the provided IServerChannelSinkProvider.
ctor #4	Overloaded: .ctor(string name, int port) Initializes a new instance of the HttpServerChannel class with the given name at the specified port.
ctor #5	Overloaded: .ctor(string name, int port, IServerChannelSinkProvider sinkProvider) Initializes a new instance of the HttpServerChannel class at the specified port with the given name and IServerChannelSinkProvider.

Public Properties

ChannelData	Read-only Gets the channel specific data.
ChannelName	Read-only Gets the name of the current channel.
ChannelPriority	Read-only Gets the priority of the channel.
ChannelScheme	Read-only
ChannelSinkChain	Read-only Gets the channel sink chain that the current channel is using.
Count (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Count Gets the number of properties associated with the current channel object.
IsFixedSize (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsFixedSize Gets a Boolean value indicating whether the number of properties that can be entered into the current channel object is fixed.
IsReadOnly (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsReadOnly Gets a Boolean value indicating whether the collection of properties in the current channel object is read-only.
IsSynchronized (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsSynchronized Gets a value indicating whether the current dictionary of channel object properties is synchronized.
Item	Read-write Overridden: Gets or sets a channel property associated with the specified key.
Keys	Read-only Overridden: Gets an ICollection of keys the channel properties are associated with.
Properties (inherited from System.Runtime.Remoting.Channels.BaseChannelWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelWithProperties.Properties Gets an IDictionary of the channel properties associated with the current channel object.
SyncRoot (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.SyncRoot Gets an object that is used to synchronize access to the BaseChannelObjectWithProperties.
Values (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Values Gets an ICollection of the values of the properties associated with the current channel object.
WantsToListen	Read-write Gets a Boolean value indicating whether IChannelReceiverHook wants to be hooked into the outside listener service.

Public Methods

Add (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Add The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.
AddHookChannelUri	Adds a URI on which the channel hook must listen.
Clear (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Clear The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.
Contains (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Contains Returns a Boolean value indicating whether the current channel object contains a property associated with the specified key.
CopyTo (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.CopyTo The current method is not supported by the BaseChannelObjectWithProperties.
Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetChannelUri	Returns the URI of the current channel.
GetEnumerator (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.GetEnumerator Returns an IDictionaryEnumerator that enumerates over all the properties associated with the current channel object.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
GetUrlsForUri	Returns an array of all the URLs for an object with the specified URI, hosted on the current HttpChannel.
Parse	Extracts the channel URI and the remote well-known object URI from the specified URL.
Remove (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Remove The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.
StartListening	Instructs the current channel to start listening for requests.
StopListening	Instructs the current channel to stop listening for requests.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Fields

SinksWithProperties (inherited from System.Runtime.Remoting.Channels.BaseChannelWithProperties)

See base class member description: System.Runtime.Remoting.Channels.BaseChannelWithProperties.SinksWithProperties Indicates the top channel sink in the channel sink stack.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties
• System.Runtime.Remoting.Channels.BaseChannelWithProperties
• System.Runtime.Remoting.Channels.Http.HttpServerChannel

System.Runtime.Remoting.Channels.Http.HttpServerChannel Member Details

Summary

Initializes a new instance of the HttpServerChannel class with default values.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:

public HttpServerChannel();

Return to top

Summary

Initializes a new instance of the HttpServerChannel class at the specified port.

C# Syntax:

public HttpServerChannel(    int port );

port

The port at which to activate the new instance of HttpServerChannel.

Return to top

Summary

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

C# Syntax:

public HttpServerChannel(    IDictionary properties,    IServerChannelSinkProvider sinkProvider );

properties

An IDictionary of the channel properties that hold the configuration information for the current channel.

sinkProvider

The IServerChannelSinkProvider to use with the new instance of the HttpServerChannel.

Exceptions

Exception Type	Condition
ArgumentException	A provided channel property was badly formatted.

Channel sinks provide a plug-in point that allows access to the underlying messages flowing through the channel as well as the stream used by the transport mechanism to send messages to a remote object. Channel sinks are also responsible for transporting messages between the client and the server.

Note For more information, see the conceptual topic at MSDN: sinkssinkchains.

Note Channel properties are used to configure the channel at run time. For a list of possible channel properties and an example, see the conceptual topic at MSDN: channelformatterconfigurationproperties.

Return to top

Summary

Initializes a new instance of the HttpServerChannel class with the given name at the specified port.

C# Syntax:

public HttpServerChannel(    string name,    int port );

name

The name of the new instance of the HttpServerChannel.

port

The port at which to activate the new instance of the HttpServerChannel.

This constructor sets the HttpServerChannel.ChannelName property using the name parameter.

Return to top

Summary

Initializes a new instance of the HttpServerChannel class at the specified port with the given name and IServerChannelSinkProvider.

C# Syntax:

public HttpServerChannel(    string name,    int port,    IServerChannelSinkProvider sinkProvider );

name

The name of the new instance of the HttpServerChannel.

port

The port at which to activate the new instance of the HttpServerChannel.

sinkProvider

The IServerChannelSinkProvider to use with the new instance of HttpServerChannel.

This constructor sets the HttpServerChannel.ChannelName property using the name parameter.

Channel sinks provide a plug-in point that allows access to the underlying messages flowing through the channel as well as the stream used by the transport mechanism to send messages to a remote object. Channel sinks are also responsible for transporting messages between the client and the server.

Note For more information, see the conceptual topic at MSDN: sinkssinkchains.

Note Channel properties are used to configure the channel at run time. For a list of possible channel properties and an example, see the conceptual topic at MSDN: channelformatterconfigurationproperties.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelWithProperties.SinksWithProperties

Summary

Indicates the top channel sink in the channel sink stack.

C# Syntax:

protected IChannelSinkBase SinksWithProperties;

Channel sinks provide a plug-in point that allows access to the underlying messages flowing through the channel as well as the stream used by the transport mechanism to send messages to a remote object. Channel sinks are linked together in a chain of channel sink providers, and all channel messages flow through this chain of sinks before the messages are serialized and transported.

Return to top

Summary

Gets the channel specific data.

C# Syntax:

public object ChannelData {get;}

Implements:

IChannelReceiver.ChannelData

This property is used when RemotingServices.Marshal is called and an ObjRef is created.

Return to top

Summary

Gets the name of the current channel.

C# Syntax:

public string ChannelName {get;}

Implements:

IChannel.ChannelName

This property is used to retrieve a specific channel when calling ChannelServices.GetChannel. If this property is not set, the system defaults to "http". If you want to register more than one HttpServerChannel, each must have a unique name. Set this property to the String.Empty string ("") if you want to ignore names and avoid naming collisions. The system will allow any number of channels with the String.Empty name.

Return to top

Summary

Gets the priority of the channel.

C# Syntax:

public int ChannelPriority {get;}

Implements:

IChannel.ChannelPriority

For server channels, the priority controls the order in which the channel data appears in an ObjRef. Clients will try to connect to the server channels in the order that they are listed in the ObjRef. The default priority is 1, and negative numbers are allowed.

Return to top

Summary

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

C# Syntax:

public string ChannelScheme {get;}

Implements:

IChannelReceiverHook.ChannelScheme

This value is not case-sensitive.

Return to top

Summary

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

C# Syntax:

public IServerChannelSink ChannelSinkChain {get;}

Implements:

IChannelReceiverHook.ChannelSinkChain

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Count

Summary

Gets the number of properties associated with the current channel object.

C# Syntax:

public virtual int Count {get;}

Implements:

ICollection.Count

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsFixedSize

Summary

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

C# Syntax:

public virtual bool IsFixedSize {get;}

Implements:

IDictionary.IsFixedSize

In the current implementation BaseChannelObjectWithProperties.IsFixedSize returns true.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsReadOnly

Summary

Gets a Boolean value indicating whether the collection of properties in the current channel object is read-only.

C# Syntax:

public virtual bool IsReadOnly {get;}

Implements:

IDictionary.IsReadOnly

In the current implementation BaseChannelObjectWithProperties.IsReadOnly returns false.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsSynchronized

Summary

Gets a value indicating whether the current dictionary of channel object properties is synchronized.

C# Syntax:

public virtual bool IsSynchronized {get;}

Implements:

ICollection.IsSynchronized

The current implementation of BaseChannelObjectWithProperties.IsSynchronized returns false.

Return to top

Summary

Gets or sets a channel property associated with the specified key.

C# Syntax:

public override object this[object key] {get; set;}

key

The key the requested property is associated with.

Implements:

IDictionary.Item

Note Channel properties are used to configure the channel at run time. For a list of possible channel properties and an example, see the conceptual topic at MSDN: channelformatterconfigurationproperties.

Return to top

Summary

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

C# Syntax:

public override ICollection Keys {get;}

Implements:

IDictionary.Keys

Note Channel properties are used to configure the channel at run time. For a list of possible channel properties and an example, see the conceptual topic at MSDN: channelformatterconfigurationproperties.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelWithProperties.Properties

Summary

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

C# Syntax:

public override IDictionary Properties {get;}

Channel properties are used to configure the channel at run time.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.SyncRoot

Summary

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

C# Syntax:

public virtual object SyncRoot {get;}

Implements:

ICollection.SyncRoot

The current implementation of BaseChannelObjectWithProperties.SyncRoot returns a reference to the current instance of BaseChannelObjectWithProperties.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Values

Summary

Gets an ICollection of the values of the properties associated with the current channel object.

C# Syntax:

public virtual ICollection Values {get;}

Implements:

IDictionary.Values

Return to top

Summary

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

C# Syntax:

public bool WantsToListen {get; set;}

Implements:

IChannelReceiverHook.WantsToListen

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Add

Summary

The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.

C# Syntax:

public virtual void Add(    object key,    object value );

key

Indicates the key associated with the object contained in the value parameter.

value

Indicates the value to add.

Exceptions

Exception Type	Condition
NotSupportedException	The method was called.

Implements:

IDictionary.Add

Return to top

Summary

Adds a URI on which the channel hook must listen.

C# Syntax:

public void AddHookChannelUri(    string channelUri );

channelUri

A URI on which the channel hook must listen.

Implements:

IChannelReceiverHook.AddHookChannelUri

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Clear

Summary

The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.

C# Syntax:

public virtual void Clear();

Exceptions

Exception Type	Condition
NotSupportedException	The method was called.

Implements:

IDictionary.Clear

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Contains

Summary

Returns a Boolean value indicating whether the current channel object contains a property associated with the specified key.

C# Syntax:

public virtual bool Contains(    object key );

key

The key the requested property is associated with.

Return Value:

A Boolean value indicating whether the current channel object contains a property associated with the specified key.

Implements:

IDictionary.Contains

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.CopyTo

Summary

The current method is not supported by the BaseChannelObjectWithProperties.

C# Syntax:

public virtual void CopyTo(    Array array,    int index );

array

The array to copy the properties to.

index

The index where to begin copying.

Exceptions

Exception Type	Condition
NotSupportedException	The method was called.

Implements:

ICollection.CopyTo

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~HttpServerChannel();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Returns the URI of the current channel.

C# Syntax:

public string GetChannelUri();

Return Value:

The URI of the current channel.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.GetEnumerator

Summary

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

C# Syntax:

public virtual IDictionaryEnumerator GetEnumerator();

Return Value:

An IDictionaryEnumerator that enumerates over all the properties associated with the current channel object.

Implements:

IDictionary.GetEnumerator

Return to top

Inherited
See base class member description: System.Object.GetHashCode

C# Syntax:

public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Returns an array of all the URLs for an object with the specified URI, hosted on the current HttpChannel.

C# Syntax:

public virtual string[] GetUrlsForUri(    string objectUri );

objectUri

The URI of the object for which URLs are required.

Return Value:

An array of the URLs for an object with the specified URI, hosted on the current HttpChannel.

Implements:

IChannelReceiver.GetUrlsForUri

The current method is used by ChannelServices.GetUrlsForObject.

using System;
using System.Runtime.Remoting;
using System.Runtime.Remoting.Channels.Http;

class Class1 {
   public static void Main() {

      // Create a remotable object.
      HttpChannel httpChannel = new HttpChannel(8085);

      WellKnownServiceTypeEntry WKSTE = 
         new WellKnownServiceTypeEntry(typeof(HelloService),
                                       "Service", 
                                       WellKnownObjectMode.Singleton);
      RemotingConfiguration.RegisterWellKnownServiceType(WKSTE);

      RemotingConfiguration.ApplicationName = "HelloServer";

      // Print out the urls for HelloServer.
      string[] urls = httpChannel.GetUrlsForUri("HelloServer");
      
      foreach (string url in urls)
         System.Console.WriteLine("{0}", url);
      
   }
}

    

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Extracts the channel URI and the remote well-known object URI from the specified URL.

C# Syntax:

public string Parse(    string url,    out string objectURI );

url

The URL from which to extract the URIs.

objectURI

When this method returns, contains a String that holds the URI of the remote well-known object. This parameter is passed uninitialized.

Return Value:

The channel URI.

Implements:

IChannel.Parse

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Remove

Summary

The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.

C# Syntax:

public virtual void Remove(    object key );

key

The key that the object being removed is associated with.

Exceptions

Exception Type	Condition
NotSupportedException	The method was called.

Implements:

IDictionary.Remove

Return to top

Summary

Instructs the current channel to start listening for requests.

C# Syntax:

public void StartListening(    object data );

data

Should always be null for HttpChannel.

Implements:

IChannelReceiver.StartListening

The data object can be used to pass specific initialization state to the channel.

Return to top

Summary

Instructs the current channel to stop listening for requests.

C# Syntax:

public void StopListening(    object data );

data

Should always be null for HttpChannel.

Implements:

IChannelReceiver.StopListening

The data object can be used to pass specific state to the channel.

Return to top

Inherited
See base class member description: System.Object.ToString

C# Syntax:

public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Top of page