HttpServerChannel Class
Implements a server channel for remote calls that uses the HTTP protocol to transmit messages.
System.Runtime.Remoting.Channels::BaseChannelObjectWithProperties
System.Runtime.Remoting.Channels::BaseChannelWithProperties
System.Runtime.Remoting.Channels.Http::HttpServerChannel
Assembly: System.Runtime.Remoting (in System.Runtime.Remoting.dll)
The HttpServerChannel type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | HttpServerChannel() | Initializes a new instance of the HttpServerChannel class. |
![]() | HttpServerChannel(Int32) | Initializes a new instance of the HttpServerChannel class that listens on the specified port. |
![]() | HttpServerChannel(IDictionary, IServerChannelSinkProvider) | Initializes a new instance of the HttpServerChannel class with the specified channel properties and sink. |
![]() | 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. |
| Name | Description | |
|---|---|---|
![]() | 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 | Returns the specified channel property. (Overrides BaseChannelObjectWithProperties::Item[Object].) |
![]() | Keys | Gets a ICollection of keys the channel properties are associated with. (Overrides BaseChannelObjectWithProperties::Keys.) |
![]() | 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. |
| Name | Description | |
|---|---|---|
![]() | Add | Throws a NotSupportedException. (Inherited from BaseChannelObjectWithProperties.) |
![]() | AddHookChannelUri | Adds a URI on which the channel hook must listen. |
![]() | Clear | Throws a NotSupportedException. (Inherited from BaseChannelObjectWithProperties.) |
![]() | Contains | Returns a value that indicates whether the channel object contains a property that is associated with the specified key. (Inherited from BaseChannelObjectWithProperties.) |
![]() | CopyTo | Throws a NotSupportedException. (Inherited from BaseChannelObjectWithProperties.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (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 a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetUrlsForUri | 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 | Extracts the channel URI and the remote well-known object URI from the specified URL. |
![]() | Remove | Throws a NotSupportedException. (Inherited from BaseChannelObjectWithProperties.) |
![]() | StartListening | Instructs the current channel to start listening for requests. |
![]() | StopListening | Instructs the current channel to stop listening for requests. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() | SinksWithProperties | Indicates the top channel sink in the channel sink stack. (Inherited from BaseChannelWithProperties.) |
| Name | Description | |
|---|---|---|
![]() ![]() | IEnumerable::GetEnumerator | Infrastructure. Returns a IEnumerator that enumerates over all the properties that are associated with the channel object. (Inherited from BaseChannelObjectWithProperties.) |
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.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." ); }
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() ); }
The following code example shows the remote object used by the server and the client.
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.
