HttpClientChannel Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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 ref class HttpClientChannel : BaseChannelWithProperties, 
	IChannelSender, IChannel, ISecurableChannel

NameDescription
System_CAPS_pubmethodHttpClientChannel()

Initializes a new instance of the HttpClientChannel class.

System_CAPS_pubmethodHttpClientChannel(IDictionary^, IClientChannelSinkProvider^)

Initializes a new instance of the HttpClientChannel class with the specified configuration properties and sink.

System_CAPS_pubmethodHttpClientChannel(String^, IClientChannelSinkProvider^)

Initializes a new instance of the HttpClientChannel class with the specified name and sink.

NameDescription
System_CAPS_pubpropertyChannelName

Gets the name of the current channel.

System_CAPS_pubpropertyChannelPriority

Gets the priority of the current channel.

System_CAPS_pubpropertyCount

Gets the number of properties associated with the channel object.(Inherited from BaseChannelObjectWithProperties.)

System_CAPS_pubpropertyIsFixedSize

Gets a value that indicates whether the number of properties that can be entered into the channel object is fixed.(Inherited from BaseChannelObjectWithProperties.)

System_CAPS_pubpropertyIsReadOnly

Gets a value that indicates whether the collection of properties in the channel object is read-only.(Inherited from BaseChannelObjectWithProperties.)

System_CAPS_pubpropertyIsSecured

Gets or sets whether the client channel is secured.

System_CAPS_pubpropertyIsSynchronized

Gets a value that indicates whether the dictionary of channel object properties is synchronized.(Inherited from BaseChannelObjectWithProperties.)

System_CAPS_pubpropertyItem[Object^]

Returns the specified channel property.(Overrides BaseChannelObjectWithProperties::Item[Object^].)

System_CAPS_pubpropertyKeys

Gets a ICollection of keys that the channel properties are associated with.(Overrides BaseChannelObjectWithProperties::Keys.)

System_CAPS_pubpropertyProperties

Gets a IDictionary of the channel properties associated with the current channel object.(Inherited from BaseChannelWithProperties.)

System_CAPS_pubpropertySyncRoot

Gets an object that is used to synchronize access to the BaseChannelObjectWithProperties.(Inherited from BaseChannelObjectWithProperties.)

System_CAPS_pubpropertyValues

Gets a ICollection of the values of the properties associated with the channel object.(Inherited from BaseChannelObjectWithProperties.)

NameDescription
System_CAPS_pubmethodAdd(Object^, Object^)
System_CAPS_pubmethodClear()
System_CAPS_pubmethodContains(Object^)

Returns a value that indicates whether the channel object contains a property that is associated with the specified key.(Inherited from BaseChannelObjectWithProperties.)

System_CAPS_pubmethodCopyTo(Array^, Int32)
System_CAPS_pubmethodCreateMessageSink(String^, Object^, String^%)

Returns a channel message sink that delivers messages to the specified URL or channel data object.

System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns a IDictionaryEnumerator that enumerates over all the properties associated with the channel object.(Inherited from BaseChannelObjectWithProperties.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodParse(String^, String^%)

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

System_CAPS_pubmethodRemove(Object^)
System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_protfieldSinksWithProperties

Indicates the top channel sink in the channel sink stack.(Inherited from BaseChannelWithProperties.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable::GetEnumerator()

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a IEnumerator that enumerates over all the properties that are associated with the channel object.(Inherited from BaseChannelObjectWithProperties.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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.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 server channel.
   HttpServerChannel^ serverChannel = gcnew HttpServerChannel( 9090 );

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

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

   // Wait for the user prompt.
   Console::WriteLine( L"Press ENTER to exit the server." );
   Console::ReadLine();
   Console::WriteLine( L"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^ clientChannel = gcnew HttpClientChannel;

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

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

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

   // Display the channel's properties using Keys and Item.
   for each(String^ key in clientChannel->Keys)
   {
       Console::WriteLine("clientChannel[{0}] = <{1}>", key, clientChannel[key]);
   }

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

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

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

#using <System.dll>
using namespace System;
using namespace System::Runtime::Remoting;

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

public:
   int GetCount()
   {
      Console::WriteLine( L"GetCount was called." );
      callCount++;
      return (callCount);
   }

};

.NET Framework
Available since 1.1

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

Return to top
Show: