Export (0) Print
Expand All

HttpClientChannel Class

Implements a client 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 HttpClientChannel : BaseChannelWithProperties, 
	IChannelSender, IChannel, ISecurableChannel

The HttpClientChannel type exposes the following members.

  NameDescription
Public methodHttpClientChannel()Initializes a new instance of the HttpClientChannel class.
Public methodHttpClientChannel(IDictionary, IClientChannelSinkProvider)Initializes a new instance of the HttpClientChannel class with the specified configuration properties and sink.
Public methodHttpClientChannel(String, IClientChannelSinkProvider)Initializes a new instance of the HttpClientChannel class with the specified name and sink.
Top

  NameDescription
Public propertyChannelNameGets the name of the current channel.
Public propertyChannelPriorityGets the priority of the current channel.
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 propertyIsSecuredGets or sets whether the client channel is secured.
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.)
Public propertyKeysGets a ICollection of keys that 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.)
Top

  NameDescription
Public methodAddThrows a NotSupportedException. (Inherited from BaseChannelObjectWithProperties.)
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 methodCreateMessageSinkReturns a channel message sink that delivers messages to the specified URL or channel data object.
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 methodGetEnumeratorReturns a IDictionaryEnumerator that enumerates over all the properties associated with the channel object. (Inherited from BaseChannelObjectWithProperties.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
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 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 or application domains). The HttpClientChannel 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 client-side, you can specify an implementation of the IClientChannelSinkProvider through which all messages processed by the HttpClientChannel are passed.

By default, the HttpServerChannel uses a SOAP formatter to serialize all messages.

A HttpClientChannel 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 HttpClientChannel constructor). For a list of these configuration properties, see Channel and Formatter Configuration Properties.

The following code example shows how to use a HttpClientChannel 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;

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

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

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

        // 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;
using System.Security.Permissions;

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

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

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

        // Create a message sink. 
        string objectUri;
        System.Runtime.Remoting.Messaging.IMessageSink messageSink = 
            clientChannel.CreateMessageSink(
            "http://localhost:9090/RemoteObject.rem", 
            null, out objectUri);
        Console.WriteLine(
            "The URI of the message sink is {0}.", 
            objectUri);
        if (messageSink != null)
        {
            Console.WriteLine("The type of the message sink is {0}.", 
                messageSink.GetType().ToString());
        }

        // Display the channel's properties using Keys and Item. 
        foreach(string key in clientChannel.Keys)
        {
            Console.WriteLine(
                "clientChannel[{0}] = <{1}>", 
                key, clientChannel[key]);
        }

        // Parse the channel's URI. 
        string objectUrl = "http://localhost:9090/RemoteObject.rem";
        string channelUri = clientChannel.Parse(objectUrl, out objectUri);
        Console.WriteLine("The object URL is {0}.", objectUrl);
        Console.WriteLine("The object URI is {0}.", objectUri);
        Console.WriteLine("The channel URI is {0}.", channelUri);

        // 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()
    {
        Console.WriteLine("GetCount was called.");
        callCount++;
        return(callCount);
    }

}

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft