IpHttpServerChannel Class
From RemObjects Software
This is a RemObjects SDK Architecture entry
Feel free to add your notes to this topic below.
Overview (.NET)
The IpHttpServerChannel is the default server component used to make your services accessible via the HTTP protocol.
This channel uses the Internet Pack to provide a HTTP Server listening on the configured Port and will dispatch all incoming requests to the RemObjects SDK Invoker.
Compatible Clients
Namespace
Declaration (C#)
[DefaultProperty("Port")] [System.Drawing.ToolboxBitmap(typeof(RemObjects.SDK.Server.ServerChannel), "Glyphs.IpHttpServerChannel.bmp")] [ServerChannel, Default, DefaultClientChannel(typeof(RemObjects.SDK.IpHttpClientChannel))] [LicenseProvider(typeof(ROLicenseProvider))] public class IpHttpServerChannel : HttpServerChannel;
Hierarchy
- HttpServerChannel
- RemObjects.SDK.Server.IpHttpServerChannel
Properties
| | | |
|---|---|---|
| HttpServer | HttpServer | Gives access to the underlying Internet Pack HttpServer component that is used to handle the HTTP communication with clients.
You will usually not want to touch this sub-component directly, but if the need arises, this property allows you to do so. |
| KeepAlive | Boolean | Controls whether to use HTTP Keep-Alive to keep the connection alive between requests. If enabled (true) , once a request is made and a connection is established, this connection is kept open and used for future requests. |
| Port | Integer | Specifies the TCP port that the server is listening on. By default, the RemObjects SDK HTTP Servers use port 8099 to avoid conflicts with existing web servers running on port 80, but you can change this to any other value that is available on your system. |
Methods
| | |
|---|---|
| IpHttpServerChannel | Default constructor for IpHttpServerChannel. |
Events
| | |
|---|---|
| OnAdjustConvertedRodl | If a message component implements the IRodlConverter interface, it will be given a chance to process the RODL file included with the server to produce a different format. For example, the SOAP message implementation will convert the RODL to a WSDL file that can be consumed by other non-RO clients.
After this conversion has taken place, the OnAdjustConvertedRodl event will be triggered, giving you a chance to inspect the resulting stream. |
| OnAdjustRodl | When a client requests the RODL file via a GET request, this event is fired to give user code a chance to inspect and modify the RODL.
For example, user code could want to hide certain elements of the RODL, change them or send back different data altogether. |
| OnGetRodl | When a client requests the RODL file via a GET request, this event is fired to give user code a chance to provide a RODL from a custom source, before trying to locate the RODL as resource.
If the event returns an assigned Stream, that stream will be used to send back to the client (and said stream should contain a valid RODL XML structure). If null is returned, the RODL will be loaded from resource. |
| OnHttpRequest | For any incoming request that is not matched by one of the configured MessageDispatchers, this event fires and allows the user code to provide custom handling for the request.
If no event handlers are assigned, a HTTP Error 500 with message "No dispatcher configured for /path." will be sent, where "/path" is the path requested from the client. |
See Also
Product: RemObjects SDK
Current version: RemObjects SDK 'Vinci' (5.0)
Lists — Glossary — Features — How To — Components — Tools — Samples — Articles — Architecture — Issues
