IpSuperHttpServerChannel Class

This is a Library topic for RemObjects SDK for .NET
This page is generated from external data, please do not update
Namespaces — Interfaces — Classes — Enums — Implements
Contents |
Overview
Enhanced HTTP based server which provides a sophisticated and flexible communication channel that uses persistent connections to enable true asynchronous calls and server callbacks.
Location
- Assembly: RemObjects.SDK.Server.dll
- Namespace: RemObjects.SDK.Server
- Ancestry: System.ComponentModel.Component | Channel | ServerChannel | SuperHttpServer | IpSuperHttpServerChannel
Implemented interfaces
Properties
| Active (declared in ServerChannel) |
|---|
|
Toggles whether the server component is active or not. Set it to true (either from code or in the Property Pane) to have your server active and listening for requests from clients or set it to false to prevent new requests from being accepted.
|
| ChannelType (declared in SuperHttpServer) |
|
This property is needed to determine the type of the server channel for internal purposes. It has "superhttp" value.
|
| ConnectionTimeout (declared in SuperHttpServer) |
|
The timeout, in seconds, after which the idle connection will be closed. The default value is 300 (i.e. 5 minutes).
|
| CustomParameters (declared in ServerChannel) |
|
|
| Dispatchers (declared in ServerChannel) |
|
Organizes the different Dispatchers configured for the server. Depending on the server type, different dispatchers can be made accessible through different names (for example the HTTP based servers use the Path provided with the HTTP request to determine the dispatcher) or the dispatcher marked as Default will be used. Note: A design time editor for the Dispatcher collection is provided in the IDE, which you can invoke by clicking the ellipsis (...) button in the Properties Pane. You can use this editor to create new MessageDispatcher instances at design time and link them to the specific message components you have dropped onto your form.
|
| ExtendedDispatchers (declared in SuperHttpServer) |
|
|
| HasAfterReceiveStream protected (declared in Channel) |
|
|
| HasBeforeSendStream protected (declared in Channel) |
|
|
| Initializing protected (declared in ServerChannel) |
|
|
| MaxPackageSize |
|
|
| Messages (declared in ServerChannel) |
|
|
| Port |
|
|
| SendClientAccessPolicyXml (declared in SuperHttpServer) |
|
Determines how the server channel handles requests for ClientAccessPolicy.xml (security policy file used by Silverlight). * AllowNone - Denies all requests. * AllowAll - Allows all requests. * Custom - Provides a custom security policy file via OnCustomClientAccessPolicy event handler.
|
| SendCrossOriginHeader (declared in SuperHttpServer) |
|
|
| ServeInfoPage (declared in SuperHttpServer) |
|
Allows the HTTP server to serve up a page with human-readable information about the server when being accessed from a web browser. This information page will contain details about the registered dispatchers and documentation for the services:
|
| ServePlainHttpRequests (declared in SuperHttpServer) |
|
|
| Server |
|
|
| ServerName |
|
|
| ServeRodl (declared in ServerChannel) |
|
Toggles whether clients can request the RODL file for this server via IRodlAccess or channel-specific means (such as by submitting a HTTP GET request to an HTTP server). By default, this option is turned on; set this property to false if you want to prevent clients from retrieving the RODL file from the server.
|
| ThreadPool (declared in SuperHttpServer) |
|
|
Instance Methods
| constructor () |
|---|
|
|
| constructor (Boolean) protected (declared in ServerChannel) |
|
|
| constructor (IContainer) |
|
|
| Activate (declared in ServerChannel) |
|
Alias for the Open method.
|
| Close (declared in ServerChannel) |
|
Closes the ServerChannel component and stops it from accepting any more incoming requests.
|
| CopyProperties protected (declared in Channel) |
|
|
| Deactivate (declared in ServerChannel) |
|
Alias for the Close method.
|
| Dispatch protected (declared in ServerChannel) |
|
|
| Dispose protected (declared in SuperHttpServer) |
|
|
| DoClose protected |
|
|
| DoEndInit protected (declared in ServerChannel) |
|
|
| DoOpen protected |
|
|
| HandleRequest protected (declared in SuperHttpServer) |
|
|
| HandleUnknownRequest protected |
|
|
| Open (declared in ServerChannel) |
|
Opens the ServerChannel component and starts accepting incoming requests. Depending on the server type, this usually involves starting to listen on a network socket or polling some source for waiting messages.
|
| Register (declared in SuperHttpServer) |
|
|
| ResponseFailed protected (declared in SuperHttpServer) |
|
This method will be called by the subclasses when a response has not succesfully been sent. If UserData contains waiting connections (SuperHttpServerConnection.WaitingConnections) the server channel will attempt to send a response using them, otherwise UserData will be enqueued by ResponseQueue (SuperHttpServerConnection.ResponseQueue). protected
|
| SendResponse protected |
|
|
| SetDefaultHeaders (HttpHeaders) protected (declared in SuperHttpServer) |
|
|
| SetDefaultHeaders (HttpHeaders, String) protected (declared in SuperHttpServer) |
|
|
| StartListening (declared in ServerChannel) |
|
Alias for the Open method.
|
| StopListening (declared in ServerChannel) |
|
Alias for the Close method.
|
| TriggerAfterClose protected (declared in ServerChannel) |
|
|
| TriggerAfterOpen protected (declared in ServerChannel) |
|
|
| TriggerAfterReceiveStream protected (declared in Channel) |
|
|
| TriggerBeforeClose protected (declared in ServerChannel) |
|
|
| TriggerBeforeOpen protected (declared in ServerChannel) |
|
|
| TriggerBeforeSendStream protected (declared in Channel) |
|
|
| TriggerOnAdjustConvertedRodl protected (declared in SuperHttpServer) |
|
Calls the OnAdjustConvertedRodl event handler and sets the position within the provided RODL stream to the beginning. protected
|
| TriggerOnAdjustRodl protected (declared in SuperHttpServer) |
|
Calls the OnAdjustRodl event handler and sets the position within the provided RODL stream to the beginning.
|
| TriggerOnCustomClientAccessPolicy protected (declared in SuperHttpServer) |
|
Calls the OnCustomClientAccessPolicy event handler. Returns the security policy file generated by its handler (via aPolicyContent parameter by reference). Can be called only from the ancestor class.
|
| TriggerOnCustomCrossOrigin protected (declared in SuperHttpServer) |
|
|
| TriggerOnGetRodl protected (declared in SuperHttpServer) |
|
Calls the OnGetRodl event handler and sets the position within the provided RODL stream to the beginning.
|
| TriggerOnHttpRequest protected |
|
|
| Unregister (declared in SuperHttpServer) |
|
|
Events
| AfterClose (declared in ServerChannel) |
|---|
|
|
| AfterOpen (declared in ServerChannel) |
|
|
| AfterReceiveStream (declared in Channel) |
|
This event is triggered by client and server channels directly after a request or response stream has been received and before the stream gets parsed into a message. User code can assign handlers to this event to process, inspect or modify incoming messages, before they get handled by the RemObjects SDK framework. The passed Stream is a MemoryStream and may be modified. If no handlers are assigned to the AfterReceiveStream event, the message will load the data directly from the incoming medium (usually the network stream); assigning event handlers to AfterReceiveStream will induce a slight overhead as the data will first be copied into a local memory buffer for the event handler. This should not have any noticeably effect except for very large messages or on resource-limited systems such as Compact Framework Clients, but if utmost performance is important, take this note into consideration.
C#: event StreamEventHandler AfterReceiveStream VB: Event AfterReceiveStream As StreamEventHandler
|
| BeforeClose (declared in ServerChannel) |
|
|
| BeforeOpen (declared in ServerChannel) |
|
|
| BeforeSendStream (declared in Channel) |
|
This event is triggered by client and server channels directly before a request or response stream will be sent over the network. User code can assign handlers to this event to process, inspect or modify incoming messages before they get sent out to the remote system. The passed Stream is a MemoryStream and may be modified.
C#: event StreamEventHandler BeforeSendStream VB: Event BeforeSendStream As StreamEventHandler
|
| OnAdjustConvertedRodl (declared in SuperHttpServer) |
|
This event is fired only if a RODL is requested via MessageDispathes which supports the IRodlConverter (f.e. SoapMessage). It is fired after the RODL is converted via the IRodlConverter interface (in case of SoapMessage this means after the RODL was converted to the corresponding WSDL).
C#: event OnAdjustAsyncHttpRodlHandler OnAdjustConvertedRodl VB: Event OnAdjustConvertedRodl As OnAdjustAsyncHttpRodlHandler
|
| OnAdjustRodl (declared in SuperHttpServer) |
|
This event is fired after the service RODL is acquired.
C#: event OnAdjustAsyncHttpRodlHandler OnAdjustRodl VB: Event OnAdjustRodl As OnAdjustAsyncHttpRodlHandler
|
| OnCustomClientAccessPolicy (declared in SuperHttpServer) |
|
This event is fired when the SendClientAccessPolicyXml property is set to Custom. Allows more precise management of client access policies. The handler of this event generates a valid ClientAccessPolicy.xml and puts it to the aPolicyContent parameter.
C#: event OnCustomClientAccessPolicyHandler OnCustomClientAccessPolicy VB: Event OnCustomClientAccessPolicy As OnCustomClientAccessPolicyHandler
|
| OnCustomCrossOrigin (declared in SuperHttpServer) |
|
|
| OnGetRodl (declared in SuperHttpServer) |
|
This event is fired when a service RODL is requested.
C#: event OnAdjustAsyncHttpRodlHandler OnGetRodl VB: Event OnGetRodl As OnAdjustAsyncHttpRodlHandler
|
| OnHttpRequest |
|
C#: event OnAsyncHttpRequestHandler OnHttpRequest VB: Event OnHttpRequest As OnAsyncHttpRequestHandler |
See Also
- Lists
- RemObjects SDK for .NET: Namespaces — Interfaces — Classes — Enums — Implements
- RemObjects SDK shared: Data Types – File Types
- other editions
- RemObjects SDK for Xcode: Protocols — Classes — Enums — Aliases — Implements
- RemObjects SDK for Delphi: Interfaces — Classes — Aliases — Implements
- RemObjects SDK for Java: Namespaces — Interfaces — Classes — Enums — Implements
- RemObjects SDK for JavaScript: Objects

Product: RemObjects SDK
Available Editions: RemObjects SDK for .NET, Xcode, Delphi, Java and JavaScript
