HttpSysServerChannel

Overview

This is a simple HTTP server channel. It is based on http.sys and the .NET wrapper classes. http.sys is a kernel level HTTP stack provided by Microsoft, available in Windows starting from XP SP2. It provides the basic HTTP functionality for IIS on these systems, and has several advantages: * The bulk of the core HTTP processing is done on kernel level, which makes it faster and more reliable. * It allows RO standalone .exe servers to benefit of all the work and finetuning Microsoft puts into this kernel driver, without needing to run (or even install) IIS itself. * It lets your RO standalone .exe server share the same port with IIS (or other services using http.sys, such as SQL Server 2005), simply by providing a unique domain name. Similar to how IIS allows you to set up virtual sites on the same ip/port combination by using HTTP/1.1's Host field, RO servers can now participate in this. You can for example have IIS listening on http://www.yourdomain.com, and your standalone RO server on http://services.yourdomain.com on the same IP address. http.sys will automatically direct each request to the proper server application.

To set up the channel, open the Bindings property editor and specify one or more hostname/port combinations. Make sure they do not conflict with any you have set up in IIS (for example, you cannot use the same host and port in both). Also remember that this channel requires XPSP2 or a newer operating system.

In addition to sharing a port/ip combo with IIS or other servers provided by Microsoft, you can of course also use it to run several independent RO servers on different domain names on the same server.

Warning: The application using this server channel must be launched with administrative privileges. Otherwise servicing requests from outside the local host is impossible due to Microsoft's restrictions.

Note: You can use SSL encryption with this channel. For more details, see the Remoting SDK FAQ.

Location

 

constructor

Creates a new instance of the HttpSysServerChannel class.

 

constructor

 

HttpSysServerChannel()

 

Sub New

constructor (IContainer)

 

constructor(container: IContainer)

 

HttpSysServerChannel(IContainer container)

 

Sub New (container As IContainer)

Parameters:

  • container:

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.

 

property Active: Boolean read write;

 

Boolean Active { get; set; }

 

Property Active As Boolean

add_AdjustConvertedRodl    (declared in ServerChannel)

 

method add_AdjustConvertedRodl(value: EventHandler<RodlEventArgs>)

 

void add_AdjustConvertedRodl(EventHandler<RodlEventArgs> value)

 

Sub add_AdjustConvertedRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

add_AdjustRodl    (declared in ServerChannel)

 

method add_AdjustRodl(value: EventHandler<RodlEventArgs>)

 

void add_AdjustRodl(EventHandler<RodlEventArgs> value)

 

Sub add_AdjustRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

add_AfterClose    (declared in ServerChannel)

 

method add_AfterClose(value: EventHandler)

 

void add_AfterClose(EventHandler value)

 

Sub add_AfterClose(value As EventHandler)

Parameters:

  • value:

add_AfterOpen    (declared in ServerChannel)

 

method add_AfterOpen(value: EventHandler)

 

void add_AfterOpen(EventHandler value)

 

Sub add_AfterOpen(value As EventHandler)

Parameters:

  • value:

add_AfterReceiveStream    (declared in Channel)

 

method add_AfterReceiveStream(value: EventHandler<StreamEventArgs>)

 

void add_AfterReceiveStream(EventHandler<StreamEventArgs> value)

 

Sub add_AfterReceiveStream(value As EventHandler<StreamEventArgs>)

Parameters:

  • value:

add_BeforeClose    (declared in ServerChannel)

 

method add_BeforeClose(value: EventHandler)

 

void add_BeforeClose(EventHandler value)

 

Sub add_BeforeClose(value As EventHandler)

Parameters:

  • value:

add_BeforeOpen    (declared in ServerChannel)

 

method add_BeforeOpen(value: EventHandler)

 

void add_BeforeOpen(EventHandler value)

 

Sub add_BeforeOpen(value As EventHandler)

Parameters:

  • value:

add_BeforeSendStream    (declared in Channel)

 

method add_BeforeSendStream(value: EventHandler<StreamEventArgs>)

 

void add_BeforeSendStream(EventHandler<StreamEventArgs> value)

 

Sub add_BeforeSendStream(value As EventHandler<StreamEventArgs>)

Parameters:

  • value:

add_CustomClientAccessPolicy    (declared in HttpServerChannel)

 

method add_CustomClientAccessPolicy(value: EventHandler<ClientAccessPolicyEventArgs>)

 

void add_CustomClientAccessPolicy(EventHandler<ClientAccessPolicyEventArgs> value)

 

Sub add_CustomClientAccessPolicy(value As EventHandler<ClientAccessPolicyEventArgs>)

Parameters:

  • value:

add_GetRodl    (declared in ServerChannel)

 

method add_GetRodl(value: EventHandler<RodlEventArgs>)

 

void add_GetRodl(EventHandler<RodlEventArgs> value)

 

Sub add_GetRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

add_HttpRequest

 

method add_HttpRequest(value: HttpSysRequestEventHandler)

 

void add_HttpRequest(HttpSysRequestEventHandler value)

 

Sub add_HttpRequest(value As HttpSysRequestEventHandler)

Parameters:

  • value:

add_OnCustomCrossOrigin    (declared in HttpServerChannel)

 

method add_OnCustomCrossOrigin(value: EventHandler<CustomCrossOriginEventArgs>)

 

void add_OnCustomCrossOrigin(EventHandler<CustomCrossOriginEventArgs> value)

 

Sub add_OnCustomCrossOrigin(value As EventHandler<CustomCrossOriginEventArgs>)

Parameters:

  • value:

AdjustConvertedRodl    (declared in ServerChannel)

 

event AdjustConvertedRodl: EventHandler<RodlEventArgs>;

 

delegate EventHandler<RodlEventArgs> AdjustConvertedRodl()

 

Event AdjustConvertedRodl As EventHandler<RodlEventArgs>

AdjustRodl    (declared in ServerChannel)

 

event AdjustRodl: EventHandler<RodlEventArgs>;

 

delegate EventHandler<RodlEventArgs> AdjustRodl()

 

Event AdjustRodl As EventHandler<RodlEventArgs>

AfterClose    (declared in ServerChannel)

 

event AfterClose: EventHandler;

 

delegate EventHandler AfterClose()

 

Event AfterClose As EventHandler

AfterOpen    (declared in ServerChannel)

 

event AfterOpen: EventHandler;

 

delegate EventHandler AfterOpen()

 

Event AfterOpen As EventHandler

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 Remoting 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.

 

event AfterReceiveStream: EventHandler<StreamEventArgs>;

 

delegate EventHandler<StreamEventArgs> AfterReceiveStream()

 

Event AfterReceiveStream As EventHandler<StreamEventArgs>

BeforeClose    (declared in ServerChannel)

 

event BeforeClose: EventHandler;

 

delegate EventHandler BeforeClose()

 

Event BeforeClose As EventHandler

BeforeOpen    (declared in ServerChannel)

 

event BeforeOpen: EventHandler;

 

delegate EventHandler BeforeOpen()

 

Event BeforeOpen As EventHandler

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.

 

event BeforeSendStream: EventHandler<StreamEventArgs>;

 

delegate EventHandler<StreamEventArgs> BeforeSendStream()

 

Event BeforeSendStream As EventHandler<StreamEventArgs>

Bindings

Collection of HttpSysBinding instances. Each HttpSysBinding defines the domain name/port pair the server channel should listen to.

Note: After a channel is opened, you can still change any available properties of HttpSysBinding instances, but these changes will not take effect until the server channel is reopened.

 

property Bindings: List<HttpSysBinding> read;

 

List<HttpSysBinding> Bindings { get; }

 

Property ReadOnly Bindings As List<HttpSysBinding>

ChannelType    (declared in HttpServerChannel)

Returns 'http'. This property is used by the ZeroConf infrastructure.

 

property ChannelType: String read;

 

String ChannelType { get; }

 

Property ReadOnly ChannelType As String

Close    (declared in ServerChannel)

Closes the ServerChannel component and stops it from accepting any more incoming requests.

 

method Close

 

void Close()

 

Sub Close

CloseChannel  protected    (declared in HttpServerChannel)

 

method CloseChannel

 

void CloseChannel()

 

Sub CloseChannel

CloseHttpChannel  protected

 

method CloseHttpChannel

 

void CloseHttpChannel()

 

Sub CloseHttpChannel

CopyProperties  protected    (declared in Channel)

 

method CopyProperties(source: Channel)

 

void CopyProperties(Channel source)

 

Sub CopyProperties(source As Channel)

Parameters:

  • source:

CustomClientAccessPolicy    (declared in HttpServerChannel)

 

event CustomClientAccessPolicy: EventHandler<ClientAccessPolicyEventArgs>;

 

delegate EventHandler<ClientAccessPolicyEventArgs> CustomClientAccessPolicy()

 

Event CustomClientAccessPolicy As EventHandler<ClientAccessPolicyEventArgs>

CustomParameters    (declared in ServerChannel)

 

property CustomParameters: Dictionary<String, String> read;

 

Dictionary<String, String> CustomParameters { get; }

 

Property ReadOnly CustomParameters As Dictionary<String, String>

DecodeBasicAuthCredentials    (declared in HttpServerChannel)

 

class method DecodeBasicAuthCredentials(encodedCredentials: String; out username: String; out password: String)

 

static void DecodeBasicAuthCredentials(String encodedCredentials, out String username, out String password)

 

Shared Sub DecodeBasicAuthCredentials(encodedCredentials As String, <OutAttribute> ByRef username As String, <OutAttribute> ByRef password As String)

Parameters:

  • encodedCredentials:
  • username:
  • password:

DEFAULT_HTML_CONTENT_TYPE  protected    (declared in HttpServerChannel)

 

const DEFAULT_HTML_CONTENT_TYPE: String = "text/html; charset=utf-8";

 

const String DEFAULT_HTML_CONTENT_TYPE = "text/html; charset=utf-8"

 

Dim DEFAULT_HTML_CONTENT_TYPE As String = "text/html; charset=utf-8"

DEFAULT_TEXT_CONTENT_TYPE  protected    (declared in HttpServerChannel)

 

const DEFAULT_TEXT_CONTENT_TYPE: String = "text/plain; charset=utf-8";

 

const String DEFAULT_TEXT_CONTENT_TYPE = "text/plain; charset=utf-8"

 

Dim DEFAULT_TEXT_CONTENT_TYPE As String = "text/plain; charset=utf-8"

DEFAULT_XML_CONTENT_TYPE  protected    (declared in HttpServerChannel)

 

const DEFAULT_XML_CONTENT_TYPE: String = "text/xml; charset=utf-8";

 

const String DEFAULT_XML_CONTENT_TYPE = "text/xml; charset=utf-8"

 

Dim DEFAULT_XML_CONTENT_TYPE As String = "text/xml; charset=utf-8"

Dispatch  protected    (declared in ServerChannel)

 

method Dispatch(message: IMessage; channelInfo: IServerChannelInfo)

 

void Dispatch(IMessage message, IServerChannelInfo channelInfo)

 

Sub Dispatch(message As IMessage, channelInfo As IServerChannelInfo)

Parameters:

  • message:
  • channelInfo:

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.

 

property Dispatchers: MessageDispatchers read;

 

MessageDispatchers Dispatchers { get; }

 

Property ReadOnly Dispatchers As MessageDispatchers

Dispose  protected    (declared in HttpServerChannel)

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

ExtendedDispatchers    (declared in HttpServerChannel)

Gets list of extended dispatchers attached to the server channel instance.

Extended dispatchers are dispatchers that perform special tasks other than calling server services. A good example of an extended dispatcher is JavaScriptHttpDispatcher dispatcher.

 

property ExtendedDispatchers: ExtendedDispatcherList read;

 

ExtendedDispatcherList ExtendedDispatchers { get; }

 

Property ReadOnly ExtendedDispatchers As ExtendedDispatcherList

FormatErrorMessage (Exception): String  protected    (declared in HttpServerChannel)

Returns the ready Html page containing information about occurred exception.

The default implementation of this method uses page template provided by the HtmlServerInfo class. Overriding this method allows to display custom Html error pages.

 

method FormatErrorMessage(exception: Exception): String

 

String FormatErrorMessage(Exception exception)

 

Function FormatErrorMessage(exception As Exception) As String

Parameters:

  • exception: Exception to display

FormatErrorMessage (String): String  protected    (declared in HttpServerChannel)

Returns the ready Html page containing provided error message.

The default implementation of this method uses page template provided by the HtmlServerInfo class. Overriding this method allows to display custom Html error pages.

 

method FormatErrorMessage(message: String): String

 

String FormatErrorMessage(String message)

 

Function FormatErrorMessage(message As String) As String

Parameters:

  • message: Error message

GetClientAccessPolicy  protected    (declared in HttpServerChannel)

 

method GetClientAccessPolicy: String

 

String GetClientAccessPolicy()

 

Function GetClientAccessPolicy As String

GetFavIconStream  protected    (declared in HttpServerChannel)

 

method GetFavIconStream: Stream

 

Stream GetFavIconStream()

 

Function GetFavIconStream As Stream

GetMessageDispatcher  protected    (declared in HttpServerChannel)

 

method GetMessageDispatcher(fullPath: String; rootPath: String): MessageDispatcher

 

MessageDispatcher GetMessageDispatcher(String fullPath, String rootPath)

 

Function GetMessageDispatcher(fullPath As String, rootPath As String) As MessageDispatcher

Parameters:

  • fullPath:
  • rootPath:

GetRodl    (declared in ServerChannel)

 

event GetRodl: EventHandler<RodlEventArgs>;

 

delegate EventHandler<RodlEventArgs> GetRodl()

 

Event GetRodl As EventHandler<RodlEventArgs>

GetServerRodl  protected    (declared in ServerChannel)

 

method GetServerRodl(context: Object; dispatcher: MessageDispatcher; serviceName: String; out contentType: String): Stream

 

Stream GetServerRodl(Object context, MessageDispatcher dispatcher, String serviceName, out String contentType)

 

Function GetServerRodl(context As Object, dispatcher As MessageDispatcher, serviceName As String, <OutAttribute> ByRef contentType As String) As Stream

Parameters:

  • context:
  • dispatcher:
  • serviceName:
  • contentType:

HasAfterReceiveStream  protected    (declared in Channel)

 

property HasAfterReceiveStream: Boolean read;

 

Boolean HasAfterReceiveStream { get; }

 

Property ReadOnly HasAfterReceiveStream As Boolean

HasBeforeSendStream  protected    (declared in Channel)

 

property HasBeforeSendStream: Boolean read;

 

Boolean HasBeforeSendStream { get; }

 

Property ReadOnly HasBeforeSendStream As Boolean

HttpRequest

 

event HttpRequest: HttpSysRequestEventHandler;
delegate: method HttpRequest(sender: Object; e: HttpSysRequestEventArgs)

 

delegate HttpSysRequestEventHandler HttpRequest()
delegate: void HttpRequest(Object sender, HttpSysRequestEventArgs e)

 

Event HttpRequest As HttpSysRequestEventHandler
delegate: Sub HttpRequest(sender As Object, e As HttpSysRequestEventArgs)

Initializing  protected    (declared in ServerChannel)

 

property Initializing: Boolean read;

 

Boolean Initializing { get; }

 

Property ReadOnly Initializing As Boolean

IsClientAccessPolicyRequested  protected    (declared in HttpServerChannel)

 

class method IsClientAccessPolicyRequested(request: String): Boolean

 

static Boolean IsClientAccessPolicyRequested(String request)

 

Shared Function IsClientAccessPolicyRequested(request As String) As Boolean

Parameters:

  • request:

IsServerDocumentationPageRequested  protected    (declared in HttpServerChannel)

 

class method IsServerDocumentationPageRequested(isInfoPageEnabled: Boolean; request: String): Boolean

 

static Boolean IsServerDocumentationPageRequested(Boolean isInfoPageEnabled, String request)

 

Shared Function IsServerDocumentationPageRequested(isInfoPageEnabled As Boolean, request As String) As Boolean

Parameters:

  • isInfoPageEnabled:
  • request:

IsServerFavIconRequested  protected    (declared in HttpServerChannel)

 

class method IsServerFavIconRequested(isInfoPageEnabled: Boolean; request: String): Boolean

 

static Boolean IsServerFavIconRequested(Boolean isInfoPageEnabled, String request)

 

Shared Function IsServerFavIconRequested(isInfoPageEnabled As Boolean, request As String) As Boolean

Parameters:

  • isInfoPageEnabled:
  • request:

IsServerInfoPageRequested  protected    (declared in HttpServerChannel)

 

class method IsServerInfoPageRequested(isInfoPageEnabled: Boolean; request: String): Boolean

 

static Boolean IsServerInfoPageRequested(Boolean isInfoPageEnabled, String request)

 

Shared Function IsServerInfoPageRequested(isInfoPageEnabled As Boolean, request As String) As Boolean

Parameters:

  • isInfoPageEnabled:
  • request:

IsTrialMode  protected    (declared in ServerChannel)

 

property IsTrialMode: Boolean read;

 

Boolean IsTrialMode { get; }

 

Property ReadOnly IsTrialMode As Boolean

Listener

The underlying HttpListener object that is used by server channel. You can use this property to finetune HttpListener properties.

 

property Listener: HttpListener read;

 

HttpListener Listener { get; }

 

Property ReadOnly Listener As HttpListener

Messages    (declared in ServerChannel)

 

property Messages: List<String> read;

 

List<String> Messages { get; }

 

Property ReadOnly Messages As List<String>

OnCustomCrossOrigin    (declared in HttpServerChannel)

 

event OnCustomCrossOrigin: EventHandler<CustomCrossOriginEventArgs>;

 

delegate EventHandler<CustomCrossOriginEventArgs> OnCustomCrossOrigin()

 

Event OnCustomCrossOrigin As EventHandler<CustomCrossOriginEventArgs>

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.

 

method Open

 

void Open()

 

Sub Open

OpenChannel  protected    (declared in HttpServerChannel)

 

method OpenChannel

 

void OpenChannel()

 

Sub OpenChannel

OpenHttpChannel  protected

 

method OpenHttpChannel

 

void OpenHttpChannel()

 

Sub OpenHttpChannel

PROBE_REQUEST  protected    (declared in ServerChannel)

 

const PROBE_REQUEST: String = "PROBE";

 

const String PROBE_REQUEST = "PROBE"

 

Dim PROBE_REQUEST As String = "PROBE"

PROBE_REQUEST_LENGTH  protected    (declared in ServerChannel)

 

const PROBE_REQUEST_LENGTH: Int32 = 5;

 

const Int32 PROBE_REQUEST_LENGTH = 5

 

Dim PROBE_REQUEST_LENGTH As Int32 = 5

PROBE_RESPONSE_LENGTH  protected    (declared in ServerChannel)

 

const PROBE_RESPONSE_LENGTH: Int32 = 8;

 

const Int32 PROBE_RESPONSE_LENGTH = 8

 

Dim PROBE_RESPONSE_LENGTH As Int32 = 8

Register    (declared in HttpServerChannel)

 

method Register(dispatcher: IHttpDispatcher)

 

void Register(IHttpDispatcher dispatcher)

 

Sub Register(dispatcher As IHttpDispatcher)

Parameters:

  • dispatcher:

remove_AdjustConvertedRodl    (declared in ServerChannel)

 

method remove_AdjustConvertedRodl(value: EventHandler<RodlEventArgs>)

 

void remove_AdjustConvertedRodl(EventHandler<RodlEventArgs> value)

 

Sub remove_AdjustConvertedRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

remove_AdjustRodl    (declared in ServerChannel)

 

method remove_AdjustRodl(value: EventHandler<RodlEventArgs>)

 

void remove_AdjustRodl(EventHandler<RodlEventArgs> value)

 

Sub remove_AdjustRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

remove_AfterClose    (declared in ServerChannel)

 

method remove_AfterClose(value: EventHandler)

 

void remove_AfterClose(EventHandler value)

 

Sub remove_AfterClose(value As EventHandler)

Parameters:

  • value:

remove_AfterOpen    (declared in ServerChannel)

 

method remove_AfterOpen(value: EventHandler)

 

void remove_AfterOpen(EventHandler value)

 

Sub remove_AfterOpen(value As EventHandler)

Parameters:

  • value:

remove_AfterReceiveStream    (declared in Channel)

 

method remove_AfterReceiveStream(value: EventHandler<StreamEventArgs>)

 

void remove_AfterReceiveStream(EventHandler<StreamEventArgs> value)

 

Sub remove_AfterReceiveStream(value As EventHandler<StreamEventArgs>)

Parameters:

  • value:

remove_BeforeClose    (declared in ServerChannel)

 

method remove_BeforeClose(value: EventHandler)

 

void remove_BeforeClose(EventHandler value)

 

Sub remove_BeforeClose(value As EventHandler)

Parameters:

  • value:

remove_BeforeOpen    (declared in ServerChannel)

 

method remove_BeforeOpen(value: EventHandler)

 

void remove_BeforeOpen(EventHandler value)

 

Sub remove_BeforeOpen(value As EventHandler)

Parameters:

  • value:

remove_BeforeSendStream    (declared in Channel)

 

method remove_BeforeSendStream(value: EventHandler<StreamEventArgs>)

 

void remove_BeforeSendStream(EventHandler<StreamEventArgs> value)

 

Sub remove_BeforeSendStream(value As EventHandler<StreamEventArgs>)

Parameters:

  • value:

remove_CustomClientAccessPolicy    (declared in HttpServerChannel)

 

method remove_CustomClientAccessPolicy(value: EventHandler<ClientAccessPolicyEventArgs>)

 

void remove_CustomClientAccessPolicy(EventHandler<ClientAccessPolicyEventArgs> value)

 

Sub remove_CustomClientAccessPolicy(value As EventHandler<ClientAccessPolicyEventArgs>)

Parameters:

  • value:

remove_GetRodl    (declared in ServerChannel)

 

method remove_GetRodl(value: EventHandler<RodlEventArgs>)

 

void remove_GetRodl(EventHandler<RodlEventArgs> value)

 

Sub remove_GetRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

remove_HttpRequest

 

method remove_HttpRequest(value: HttpSysRequestEventHandler)

 

void remove_HttpRequest(HttpSysRequestEventHandler value)

 

Sub remove_HttpRequest(value As HttpSysRequestEventHandler)

Parameters:

  • value:

remove_OnCustomCrossOrigin    (declared in HttpServerChannel)

 

method remove_OnCustomCrossOrigin(value: EventHandler<CustomCrossOriginEventArgs>)

 

void remove_OnCustomCrossOrigin(EventHandler<CustomCrossOriginEventArgs> value)

 

Sub remove_OnCustomCrossOrigin(value As EventHandler<CustomCrossOriginEventArgs>)

Parameters:

  • value:

RemoveQueryParameters  protected    (declared in HttpServerChannel)

 

class method RemoveQueryParameters(path: String): String

 

static String RemoveQueryParameters(String path)

 

Shared Function RemoveQueryParameters(path As String) As String

Parameters:

  • path:

SecurityOptions    (declared in HttpServerChannel)

Gives access to server security options of this server channel instance. Using this property, you can set up MaxRequestSize, MaxRequestTime etc.

 

property SecurityOptions: ServerSecurityOptions read write;

 

ServerSecurityOptions SecurityOptions { get; set; }

 

Property SecurityOptions As ServerSecurityOptions

SendClientAccessPolicyXml    (declared in HttpServerChannel)

Determines how the server channel should handle requests for clientaccesspolicy.xml (security policy file used by Silverlight). Can be set to: * AllowNone (deny all requests). * AllowAll (allow all requests). * Custom (provides a custom security policy file via OnCustomClientAccessPolicy event handler).

 

property SendClientAccessPolicyXml: ClientAccessPolicyType read write;

 

ClientAccessPolicyType SendClientAccessPolicyXml { get; set; }

 

Property SendClientAccessPolicyXml As ClientAccessPolicyType

SendCrossOriginHeader    (declared in HttpServerChannel)

Gets or sets a flag indicating whether the server should handle the incoming CORS requests or ignore them.

 

property SendCrossOriginHeader: Boolean read write;

 

Boolean SendCrossOriginHeader { get; set; }

 

Property SendCrossOriginHeader As Boolean

SendExceptionsAs500    (declared in HttpServerChannel)

If set to true, messages about exceptions occurred on the server will be sent with a HTTP Error 500 header set (standard HTTP header for internal server errors).

 

property SendExceptionsAs500: Boolean read write;

 

Boolean SendExceptionsAs500 { get; set; }

 

Property SendExceptionsAs500 As Boolean

ServeInfoPage    (declared in HttpServerChannel)

Determines if the server info page should be served or not

 

property ServeInfoPage: Boolean read write;

 

Boolean ServeInfoPage { get; set; }

 

Property ServeInfoPage As Boolean

ServerName

The server name, which is exposed via HTTP response's header properties.

 

property ServerName: String read write;

 

String ServerName { get; set; }

 

Property ServerName As String

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.

 

property ServeRodl: Boolean read write;

 

Boolean ServeRodl { get; set; }

 

Property ServeRodl As Boolean

SplitRequestPath  protected    (declared in HttpServerChannel)

 

class method SplitRequestPath(path: String; out dispatcher: String; out subPath: String)

 

static void SplitRequestPath(String path, out String dispatcher, out String subPath)

 

Shared Sub SplitRequestPath(path As String, <OutAttribute> ByRef dispatcher As String, <OutAttribute> ByRef subPath As String)

Parameters:

  • path:
  • dispatcher:
  • subPath:

TriggerAdjustConvertedRodl  protected    (declared in ServerChannel)

 

method TriggerAdjustConvertedRodl(e: RodlEventArgs)

 

void TriggerAdjustConvertedRodl(RodlEventArgs e)

 

Sub TriggerAdjustConvertedRodl(e As RodlEventArgs)

Parameters:

  • e:

TriggerAdjustRodl  protected    (declared in ServerChannel)

 

method TriggerAdjustRodl(e: RodlEventArgs)

 

void TriggerAdjustRodl(RodlEventArgs e)

 

Sub TriggerAdjustRodl(e As RodlEventArgs)

Parameters:

  • e:

TriggerAfterClose  protected    (declared in ServerChannel)

 

method TriggerAfterClose

 

void TriggerAfterClose()

 

Sub TriggerAfterClose

TriggerAfterOpen  protected    (declared in ServerChannel)

 

method TriggerAfterOpen

 

void TriggerAfterOpen()

 

Sub TriggerAfterOpen

TriggerAfterReceiveStream  protected    (declared in Channel)

 

method TriggerAfterReceiveStream(var stream: Stream)

 

void TriggerAfterReceiveStream(ref Stream stream)

 

Sub TriggerAfterReceiveStream(ByRef stream As Stream)

Parameters:

  • stream:

TriggerBeforeClose  protected    (declared in ServerChannel)

 

method TriggerBeforeClose

 

void TriggerBeforeClose()

 

Sub TriggerBeforeClose

TriggerBeforeOpen  protected    (declared in ServerChannel)

 

method TriggerBeforeOpen

 

void TriggerBeforeOpen()

 

Sub TriggerBeforeOpen

TriggerBeforeSendStream  protected    (declared in Channel)

 

method TriggerBeforeSendStream(var stream: Stream)

 

void TriggerBeforeSendStream(ref Stream stream)

 

Sub TriggerBeforeSendStream(ByRef stream As Stream)

Parameters:

  • stream:

TriggerCustomClientAccessPolicy  protected    (declared in HttpServerChannel)

 

method TriggerCustomClientAccessPolicy(e: ClientAccessPolicyEventArgs)

 

void TriggerCustomClientAccessPolicy(ClientAccessPolicyEventArgs e)

 

Sub TriggerCustomClientAccessPolicy(e As ClientAccessPolicyEventArgs)

Parameters:

  • e:

TriggerGetRodl  protected    (declared in ServerChannel)

 

method TriggerGetRodl(e: RodlEventArgs)

 

void TriggerGetRodl(RodlEventArgs e)

 

Sub TriggerGetRodl(e As RodlEventArgs)

Parameters:

  • e:

TriggerHttpRequest  protected

 

method TriggerHttpRequest(e: HttpSysRequestEventArgs)

 

void TriggerHttpRequest(HttpSysRequestEventArgs e)

 

Sub TriggerHttpRequest(e As HttpSysRequestEventArgs)

Parameters:

  • e:

TriggerOnCustomCrossOrigin  protected    (declared in HttpServerChannel)

 

method TriggerOnCustomCrossOrigin(e: CustomCrossOriginEventArgs)

 

void TriggerOnCustomCrossOrigin(CustomCrossOriginEventArgs e)

 

Sub TriggerOnCustomCrossOrigin(e As CustomCrossOriginEventArgs)

Parameters:

  • e:

Unregister    (declared in HttpServerChannel)

 

method Unregister(dispatcher: IHttpDispatcher)

 

void Unregister(IHttpDispatcher dispatcher)

 

Sub Unregister(dispatcher As IHttpDispatcher)

Parameters:

  • dispatcher:

 

DEFAULT_HTML_CONTENT_TYPE  protected    (declared in HttpServerChannel)

 

const DEFAULT_HTML_CONTENT_TYPE: String = "text/html; charset=utf-8";

 

const String DEFAULT_HTML_CONTENT_TYPE = "text/html; charset=utf-8"

 

Dim DEFAULT_HTML_CONTENT_TYPE As String = "text/html; charset=utf-8"

DEFAULT_TEXT_CONTENT_TYPE  protected    (declared in HttpServerChannel)

 

const DEFAULT_TEXT_CONTENT_TYPE: String = "text/plain; charset=utf-8";

 

const String DEFAULT_TEXT_CONTENT_TYPE = "text/plain; charset=utf-8"

 

Dim DEFAULT_TEXT_CONTENT_TYPE As String = "text/plain; charset=utf-8"

DEFAULT_XML_CONTENT_TYPE  protected    (declared in HttpServerChannel)

 

const DEFAULT_XML_CONTENT_TYPE: String = "text/xml; charset=utf-8";

 

const String DEFAULT_XML_CONTENT_TYPE = "text/xml; charset=utf-8"

 

Dim DEFAULT_XML_CONTENT_TYPE As String = "text/xml; charset=utf-8"

PROBE_REQUEST  protected    (declared in ServerChannel)

 

const PROBE_REQUEST: String = "PROBE";

 

const String PROBE_REQUEST = "PROBE"

 

Dim PROBE_REQUEST As String = "PROBE"

PROBE_REQUEST_LENGTH  protected    (declared in ServerChannel)

 

const PROBE_REQUEST_LENGTH: Int32 = 5;

 

const Int32 PROBE_REQUEST_LENGTH = 5

 

Dim PROBE_REQUEST_LENGTH As Int32 = 5

PROBE_RESPONSE_LENGTH  protected    (declared in ServerChannel)

 

const PROBE_RESPONSE_LENGTH: Int32 = 8;

 

const Int32 PROBE_RESPONSE_LENGTH = 8

 

Dim PROBE_RESPONSE_LENGTH As Int32 = 8

 

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.

 

property Active: Boolean read write;

 

Boolean Active { get; set; }

 

Property Active As Boolean

Bindings

Collection of HttpSysBinding instances. Each HttpSysBinding defines the domain name/port pair the server channel should listen to.

Note: After a channel is opened, you can still change any available properties of HttpSysBinding instances, but these changes will not take effect until the server channel is reopened.

 

property Bindings: List<HttpSysBinding> read;

 

List<HttpSysBinding> Bindings { get; }

 

Property ReadOnly Bindings As List<HttpSysBinding>

ChannelType    (declared in HttpServerChannel)

Returns 'http'. This property is used by the ZeroConf infrastructure.

 

property ChannelType: String read;

 

String ChannelType { get; }

 

Property ReadOnly ChannelType As String

CustomParameters    (declared in ServerChannel)

 

property CustomParameters: Dictionary<String, String> read;

 

Dictionary<String, String> CustomParameters { get; }

 

Property ReadOnly CustomParameters As Dictionary<String, String>

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.

 

property Dispatchers: MessageDispatchers read;

 

MessageDispatchers Dispatchers { get; }

 

Property ReadOnly Dispatchers As MessageDispatchers

ExtendedDispatchers    (declared in HttpServerChannel)

Gets list of extended dispatchers attached to the server channel instance.

Extended dispatchers are dispatchers that perform special tasks other than calling server services. A good example of an extended dispatcher is JavaScriptHttpDispatcher dispatcher.

 

property ExtendedDispatchers: ExtendedDispatcherList read;

 

ExtendedDispatcherList ExtendedDispatchers { get; }

 

Property ReadOnly ExtendedDispatchers As ExtendedDispatcherList

HasAfterReceiveStream  protected    (declared in Channel)

 

property HasAfterReceiveStream: Boolean read;

 

Boolean HasAfterReceiveStream { get; }

 

Property ReadOnly HasAfterReceiveStream As Boolean

HasBeforeSendStream  protected    (declared in Channel)

 

property HasBeforeSendStream: Boolean read;

 

Boolean HasBeforeSendStream { get; }

 

Property ReadOnly HasBeforeSendStream As Boolean

Initializing  protected    (declared in ServerChannel)

 

property Initializing: Boolean read;

 

Boolean Initializing { get; }

 

Property ReadOnly Initializing As Boolean

IsTrialMode  protected    (declared in ServerChannel)

 

property IsTrialMode: Boolean read;

 

Boolean IsTrialMode { get; }

 

Property ReadOnly IsTrialMode As Boolean

Listener

The underlying HttpListener object that is used by server channel. You can use this property to finetune HttpListener properties.

 

property Listener: HttpListener read;

 

HttpListener Listener { get; }

 

Property ReadOnly Listener As HttpListener

Messages    (declared in ServerChannel)

 

property Messages: List<String> read;

 

List<String> Messages { get; }

 

Property ReadOnly Messages As List<String>

SecurityOptions    (declared in HttpServerChannel)

Gives access to server security options of this server channel instance. Using this property, you can set up MaxRequestSize, MaxRequestTime etc.

 

property SecurityOptions: ServerSecurityOptions read write;

 

ServerSecurityOptions SecurityOptions { get; set; }

 

Property SecurityOptions As ServerSecurityOptions

SendClientAccessPolicyXml    (declared in HttpServerChannel)

Determines how the server channel should handle requests for clientaccesspolicy.xml (security policy file used by Silverlight). Can be set to: * AllowNone (deny all requests). * AllowAll (allow all requests). * Custom (provides a custom security policy file via OnCustomClientAccessPolicy event handler).

 

property SendClientAccessPolicyXml: ClientAccessPolicyType read write;

 

ClientAccessPolicyType SendClientAccessPolicyXml { get; set; }

 

Property SendClientAccessPolicyXml As ClientAccessPolicyType

SendCrossOriginHeader    (declared in HttpServerChannel)

Gets or sets a flag indicating whether the server should handle the incoming CORS requests or ignore them.

 

property SendCrossOriginHeader: Boolean read write;

 

Boolean SendCrossOriginHeader { get; set; }

 

Property SendCrossOriginHeader As Boolean

SendExceptionsAs500    (declared in HttpServerChannel)

If set to true, messages about exceptions occurred on the server will be sent with a HTTP Error 500 header set (standard HTTP header for internal server errors).

 

property SendExceptionsAs500: Boolean read write;

 

Boolean SendExceptionsAs500 { get; set; }

 

Property SendExceptionsAs500 As Boolean

ServeInfoPage    (declared in HttpServerChannel)

Determines if the server info page should be served or not

 

property ServeInfoPage: Boolean read write;

 

Boolean ServeInfoPage { get; set; }

 

Property ServeInfoPage As Boolean

ServerName

The server name, which is exposed via HTTP response's header properties.

 

property ServerName: String read write;

 

String ServerName { get; set; }

 

Property ServerName As String

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.

 

property ServeRodl: Boolean read write;

 

Boolean ServeRodl { get; set; }

 

Property ServeRodl As Boolean

 

DecodeBasicAuthCredentials    (declared in HttpServerChannel)

 

class method DecodeBasicAuthCredentials(encodedCredentials: String; out username: String; out password: String)

 

static void DecodeBasicAuthCredentials(String encodedCredentials, out String username, out String password)

 

Shared Sub DecodeBasicAuthCredentials(encodedCredentials As String, <OutAttribute> ByRef username As String, <OutAttribute> ByRef password As String)

Parameters:

  • encodedCredentials:
  • username:
  • password:

IsClientAccessPolicyRequested  protected    (declared in HttpServerChannel)

 

class method IsClientAccessPolicyRequested(request: String): Boolean

 

static Boolean IsClientAccessPolicyRequested(String request)

 

Shared Function IsClientAccessPolicyRequested(request As String) As Boolean

Parameters:

  • request:

IsServerDocumentationPageRequested  protected    (declared in HttpServerChannel)

 

class method IsServerDocumentationPageRequested(isInfoPageEnabled: Boolean; request: String): Boolean

 

static Boolean IsServerDocumentationPageRequested(Boolean isInfoPageEnabled, String request)

 

Shared Function IsServerDocumentationPageRequested(isInfoPageEnabled As Boolean, request As String) As Boolean

Parameters:

  • isInfoPageEnabled:
  • request:

IsServerFavIconRequested  protected    (declared in HttpServerChannel)

 

class method IsServerFavIconRequested(isInfoPageEnabled: Boolean; request: String): Boolean

 

static Boolean IsServerFavIconRequested(Boolean isInfoPageEnabled, String request)

 

Shared Function IsServerFavIconRequested(isInfoPageEnabled As Boolean, request As String) As Boolean

Parameters:

  • isInfoPageEnabled:
  • request:

IsServerInfoPageRequested  protected    (declared in HttpServerChannel)

 

class method IsServerInfoPageRequested(isInfoPageEnabled: Boolean; request: String): Boolean

 

static Boolean IsServerInfoPageRequested(Boolean isInfoPageEnabled, String request)

 

Shared Function IsServerInfoPageRequested(isInfoPageEnabled As Boolean, request As String) As Boolean

Parameters:

  • isInfoPageEnabled:
  • request:

RemoveQueryParameters  protected    (declared in HttpServerChannel)

 

class method RemoveQueryParameters(path: String): String

 

static String RemoveQueryParameters(String path)

 

Shared Function RemoveQueryParameters(path As String) As String

Parameters:

  • path:

SplitRequestPath  protected    (declared in HttpServerChannel)

 

class method SplitRequestPath(path: String; out dispatcher: String; out subPath: String)

 

static void SplitRequestPath(String path, out String dispatcher, out String subPath)

 

Shared Sub SplitRequestPath(path As String, <OutAttribute> ByRef dispatcher As String, <OutAttribute> ByRef subPath As String)

Parameters:

  • path:
  • dispatcher:
  • subPath:

 

constructor

Creates a new instance of the HttpSysServerChannel class.

 

constructor

 

HttpSysServerChannel()

 

Sub New

constructor (IContainer)

 

constructor(container: IContainer)

 

HttpSysServerChannel(IContainer container)

 

Sub New (container As IContainer)

Parameters:

  • container:

add_AdjustConvertedRodl    (declared in ServerChannel)

 

method add_AdjustConvertedRodl(value: EventHandler<RodlEventArgs>)

 

void add_AdjustConvertedRodl(EventHandler<RodlEventArgs> value)

 

Sub add_AdjustConvertedRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

add_AdjustRodl    (declared in ServerChannel)

 

method add_AdjustRodl(value: EventHandler<RodlEventArgs>)

 

void add_AdjustRodl(EventHandler<RodlEventArgs> value)

 

Sub add_AdjustRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

add_AfterClose    (declared in ServerChannel)

 

method add_AfterClose(value: EventHandler)

 

void add_AfterClose(EventHandler value)

 

Sub add_AfterClose(value As EventHandler)

Parameters:

  • value:

add_AfterOpen    (declared in ServerChannel)

 

method add_AfterOpen(value: EventHandler)

 

void add_AfterOpen(EventHandler value)

 

Sub add_AfterOpen(value As EventHandler)

Parameters:

  • value:

add_AfterReceiveStream    (declared in Channel)

 

method add_AfterReceiveStream(value: EventHandler<StreamEventArgs>)

 

void add_AfterReceiveStream(EventHandler<StreamEventArgs> value)

 

Sub add_AfterReceiveStream(value As EventHandler<StreamEventArgs>)

Parameters:

  • value:

add_BeforeClose    (declared in ServerChannel)

 

method add_BeforeClose(value: EventHandler)

 

void add_BeforeClose(EventHandler value)

 

Sub add_BeforeClose(value As EventHandler)

Parameters:

  • value:

add_BeforeOpen    (declared in ServerChannel)

 

method add_BeforeOpen(value: EventHandler)

 

void add_BeforeOpen(EventHandler value)

 

Sub add_BeforeOpen(value As EventHandler)

Parameters:

  • value:

add_BeforeSendStream    (declared in Channel)

 

method add_BeforeSendStream(value: EventHandler<StreamEventArgs>)

 

void add_BeforeSendStream(EventHandler<StreamEventArgs> value)

 

Sub add_BeforeSendStream(value As EventHandler<StreamEventArgs>)

Parameters:

  • value:

add_CustomClientAccessPolicy    (declared in HttpServerChannel)

 

method add_CustomClientAccessPolicy(value: EventHandler<ClientAccessPolicyEventArgs>)

 

void add_CustomClientAccessPolicy(EventHandler<ClientAccessPolicyEventArgs> value)

 

Sub add_CustomClientAccessPolicy(value As EventHandler<ClientAccessPolicyEventArgs>)

Parameters:

  • value:

add_GetRodl    (declared in ServerChannel)

 

method add_GetRodl(value: EventHandler<RodlEventArgs>)

 

void add_GetRodl(EventHandler<RodlEventArgs> value)

 

Sub add_GetRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

add_HttpRequest

 

method add_HttpRequest(value: HttpSysRequestEventHandler)

 

void add_HttpRequest(HttpSysRequestEventHandler value)

 

Sub add_HttpRequest(value As HttpSysRequestEventHandler)

Parameters:

  • value:

add_OnCustomCrossOrigin    (declared in HttpServerChannel)

 

method add_OnCustomCrossOrigin(value: EventHandler<CustomCrossOriginEventArgs>)

 

void add_OnCustomCrossOrigin(EventHandler<CustomCrossOriginEventArgs> value)

 

Sub add_OnCustomCrossOrigin(value As EventHandler<CustomCrossOriginEventArgs>)

Parameters:

  • value:

Close    (declared in ServerChannel)

Closes the ServerChannel component and stops it from accepting any more incoming requests.

 

method Close

 

void Close()

 

Sub Close

CloseChannel  protected    (declared in HttpServerChannel)

 

method CloseChannel

 

void CloseChannel()

 

Sub CloseChannel

CloseHttpChannel  protected

 

method CloseHttpChannel

 

void CloseHttpChannel()

 

Sub CloseHttpChannel

CopyProperties  protected    (declared in Channel)

 

method CopyProperties(source: Channel)

 

void CopyProperties(Channel source)

 

Sub CopyProperties(source As Channel)

Parameters:

  • source:

Dispatch  protected    (declared in ServerChannel)

 

method Dispatch(message: IMessage; channelInfo: IServerChannelInfo)

 

void Dispatch(IMessage message, IServerChannelInfo channelInfo)

 

Sub Dispatch(message As IMessage, channelInfo As IServerChannelInfo)

Parameters:

  • message:
  • channelInfo:

Dispose  protected    (declared in HttpServerChannel)

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

FormatErrorMessage (Exception): String  protected    (declared in HttpServerChannel)

Returns the ready Html page containing information about occurred exception.

The default implementation of this method uses page template provided by the HtmlServerInfo class. Overriding this method allows to display custom Html error pages.

 

method FormatErrorMessage(exception: Exception): String

 

String FormatErrorMessage(Exception exception)

 

Function FormatErrorMessage(exception As Exception) As String

Parameters:

  • exception: Exception to display

FormatErrorMessage (String): String  protected    (declared in HttpServerChannel)

Returns the ready Html page containing provided error message.

The default implementation of this method uses page template provided by the HtmlServerInfo class. Overriding this method allows to display custom Html error pages.

 

method FormatErrorMessage(message: String): String

 

String FormatErrorMessage(String message)

 

Function FormatErrorMessage(message As String) As String

Parameters:

  • message: Error message

GetClientAccessPolicy  protected    (declared in HttpServerChannel)

 

method GetClientAccessPolicy: String

 

String GetClientAccessPolicy()

 

Function GetClientAccessPolicy As String

GetFavIconStream  protected    (declared in HttpServerChannel)

 

method GetFavIconStream: Stream

 

Stream GetFavIconStream()

 

Function GetFavIconStream As Stream

GetMessageDispatcher  protected    (declared in HttpServerChannel)

 

method GetMessageDispatcher(fullPath: String; rootPath: String): MessageDispatcher

 

MessageDispatcher GetMessageDispatcher(String fullPath, String rootPath)

 

Function GetMessageDispatcher(fullPath As String, rootPath As String) As MessageDispatcher

Parameters:

  • fullPath:
  • rootPath:

GetServerRodl  protected    (declared in ServerChannel)

 

method GetServerRodl(context: Object; dispatcher: MessageDispatcher; serviceName: String; out contentType: String): Stream

 

Stream GetServerRodl(Object context, MessageDispatcher dispatcher, String serviceName, out String contentType)

 

Function GetServerRodl(context As Object, dispatcher As MessageDispatcher, serviceName As String, <OutAttribute> ByRef contentType As String) As Stream

Parameters:

  • context:
  • dispatcher:
  • serviceName:
  • contentType:

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.

 

method Open

 

void Open()

 

Sub Open

OpenChannel  protected    (declared in HttpServerChannel)

 

method OpenChannel

 

void OpenChannel()

 

Sub OpenChannel

OpenHttpChannel  protected

 

method OpenHttpChannel

 

void OpenHttpChannel()

 

Sub OpenHttpChannel

Register    (declared in HttpServerChannel)

 

method Register(dispatcher: IHttpDispatcher)

 

void Register(IHttpDispatcher dispatcher)

 

Sub Register(dispatcher As IHttpDispatcher)

Parameters:

  • dispatcher:

remove_AdjustConvertedRodl    (declared in ServerChannel)

 

method remove_AdjustConvertedRodl(value: EventHandler<RodlEventArgs>)

 

void remove_AdjustConvertedRodl(EventHandler<RodlEventArgs> value)

 

Sub remove_AdjustConvertedRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

remove_AdjustRodl    (declared in ServerChannel)

 

method remove_AdjustRodl(value: EventHandler<RodlEventArgs>)

 

void remove_AdjustRodl(EventHandler<RodlEventArgs> value)

 

Sub remove_AdjustRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

remove_AfterClose    (declared in ServerChannel)

 

method remove_AfterClose(value: EventHandler)

 

void remove_AfterClose(EventHandler value)

 

Sub remove_AfterClose(value As EventHandler)

Parameters:

  • value:

remove_AfterOpen    (declared in ServerChannel)

 

method remove_AfterOpen(value: EventHandler)

 

void remove_AfterOpen(EventHandler value)

 

Sub remove_AfterOpen(value As EventHandler)

Parameters:

  • value:

remove_AfterReceiveStream    (declared in Channel)

 

method remove_AfterReceiveStream(value: EventHandler<StreamEventArgs>)

 

void remove_AfterReceiveStream(EventHandler<StreamEventArgs> value)

 

Sub remove_AfterReceiveStream(value As EventHandler<StreamEventArgs>)

Parameters:

  • value:

remove_BeforeClose    (declared in ServerChannel)

 

method remove_BeforeClose(value: EventHandler)

 

void remove_BeforeClose(EventHandler value)

 

Sub remove_BeforeClose(value As EventHandler)

Parameters:

  • value:

remove_BeforeOpen    (declared in ServerChannel)

 

method remove_BeforeOpen(value: EventHandler)

 

void remove_BeforeOpen(EventHandler value)

 

Sub remove_BeforeOpen(value As EventHandler)

Parameters:

  • value:

remove_BeforeSendStream    (declared in Channel)

 

method remove_BeforeSendStream(value: EventHandler<StreamEventArgs>)

 

void remove_BeforeSendStream(EventHandler<StreamEventArgs> value)

 

Sub remove_BeforeSendStream(value As EventHandler<StreamEventArgs>)

Parameters:

  • value:

remove_CustomClientAccessPolicy    (declared in HttpServerChannel)

 

method remove_CustomClientAccessPolicy(value: EventHandler<ClientAccessPolicyEventArgs>)

 

void remove_CustomClientAccessPolicy(EventHandler<ClientAccessPolicyEventArgs> value)

 

Sub remove_CustomClientAccessPolicy(value As EventHandler<ClientAccessPolicyEventArgs>)

Parameters:

  • value:

remove_GetRodl    (declared in ServerChannel)

 

method remove_GetRodl(value: EventHandler<RodlEventArgs>)

 

void remove_GetRodl(EventHandler<RodlEventArgs> value)

 

Sub remove_GetRodl(value As EventHandler<RodlEventArgs>)

Parameters:

  • value:

remove_HttpRequest

 

method remove_HttpRequest(value: HttpSysRequestEventHandler)

 

void remove_HttpRequest(HttpSysRequestEventHandler value)

 

Sub remove_HttpRequest(value As HttpSysRequestEventHandler)

Parameters:

  • value:

remove_OnCustomCrossOrigin    (declared in HttpServerChannel)

 

method remove_OnCustomCrossOrigin(value: EventHandler<CustomCrossOriginEventArgs>)

 

void remove_OnCustomCrossOrigin(EventHandler<CustomCrossOriginEventArgs> value)

 

Sub remove_OnCustomCrossOrigin(value As EventHandler<CustomCrossOriginEventArgs>)

Parameters:

  • value:

TriggerAdjustConvertedRodl  protected    (declared in ServerChannel)

 

method TriggerAdjustConvertedRodl(e: RodlEventArgs)

 

void TriggerAdjustConvertedRodl(RodlEventArgs e)

 

Sub TriggerAdjustConvertedRodl(e As RodlEventArgs)

Parameters:

  • e:

TriggerAdjustRodl  protected    (declared in ServerChannel)

 

method TriggerAdjustRodl(e: RodlEventArgs)

 

void TriggerAdjustRodl(RodlEventArgs e)

 

Sub TriggerAdjustRodl(e As RodlEventArgs)

Parameters:

  • e:

TriggerAfterClose  protected    (declared in ServerChannel)

 

method TriggerAfterClose

 

void TriggerAfterClose()

 

Sub TriggerAfterClose

TriggerAfterOpen  protected    (declared in ServerChannel)

 

method TriggerAfterOpen

 

void TriggerAfterOpen()

 

Sub TriggerAfterOpen

TriggerAfterReceiveStream  protected    (declared in Channel)

 

method TriggerAfterReceiveStream(var stream: Stream)

 

void TriggerAfterReceiveStream(ref Stream stream)

 

Sub TriggerAfterReceiveStream(ByRef stream As Stream)

Parameters:

  • stream:

TriggerBeforeClose  protected    (declared in ServerChannel)

 

method TriggerBeforeClose

 

void TriggerBeforeClose()

 

Sub TriggerBeforeClose

TriggerBeforeOpen  protected    (declared in ServerChannel)

 

method TriggerBeforeOpen

 

void TriggerBeforeOpen()

 

Sub TriggerBeforeOpen

TriggerBeforeSendStream  protected    (declared in Channel)

 

method TriggerBeforeSendStream(var stream: Stream)

 

void TriggerBeforeSendStream(ref Stream stream)

 

Sub TriggerBeforeSendStream(ByRef stream As Stream)

Parameters:

  • stream:

TriggerCustomClientAccessPolicy  protected    (declared in HttpServerChannel)

 

method TriggerCustomClientAccessPolicy(e: ClientAccessPolicyEventArgs)

 

void TriggerCustomClientAccessPolicy(ClientAccessPolicyEventArgs e)

 

Sub TriggerCustomClientAccessPolicy(e As ClientAccessPolicyEventArgs)

Parameters:

  • e:

TriggerGetRodl  protected    (declared in ServerChannel)

 

method TriggerGetRodl(e: RodlEventArgs)

 

void TriggerGetRodl(RodlEventArgs e)

 

Sub TriggerGetRodl(e As RodlEventArgs)

Parameters:

  • e:

TriggerHttpRequest  protected

 

method TriggerHttpRequest(e: HttpSysRequestEventArgs)

 

void TriggerHttpRequest(HttpSysRequestEventArgs e)

 

Sub TriggerHttpRequest(e As HttpSysRequestEventArgs)

Parameters:

  • e:

TriggerOnCustomCrossOrigin  protected    (declared in HttpServerChannel)

 

method TriggerOnCustomCrossOrigin(e: CustomCrossOriginEventArgs)

 

void TriggerOnCustomCrossOrigin(CustomCrossOriginEventArgs e)

 

Sub TriggerOnCustomCrossOrigin(e As CustomCrossOriginEventArgs)

Parameters:

  • e:

Unregister    (declared in HttpServerChannel)

 

method Unregister(dispatcher: IHttpDispatcher)

 

void Unregister(IHttpDispatcher dispatcher)

 

Sub Unregister(dispatcher As IHttpDispatcher)

Parameters:

  • dispatcher:

 

AdjustConvertedRodl    (declared in ServerChannel)

 

event AdjustConvertedRodl: EventHandler<RodlEventArgs>;

 

delegate EventHandler<RodlEventArgs> AdjustConvertedRodl()

 

Event AdjustConvertedRodl As EventHandler<RodlEventArgs>

AdjustRodl    (declared in ServerChannel)

 

event AdjustRodl: EventHandler<RodlEventArgs>;

 

delegate EventHandler<RodlEventArgs> AdjustRodl()

 

Event AdjustRodl As EventHandler<RodlEventArgs>

AfterClose    (declared in ServerChannel)

 

event AfterClose: EventHandler;

 

delegate EventHandler AfterClose()

 

Event AfterClose As EventHandler

AfterOpen    (declared in ServerChannel)

 

event AfterOpen: EventHandler;

 

delegate EventHandler AfterOpen()

 

Event AfterOpen As EventHandler

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 Remoting 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.

 

event AfterReceiveStream: EventHandler<StreamEventArgs>;

 

delegate EventHandler<StreamEventArgs> AfterReceiveStream()

 

Event AfterReceiveStream As EventHandler<StreamEventArgs>

BeforeClose    (declared in ServerChannel)

 

event BeforeClose: EventHandler;

 

delegate EventHandler BeforeClose()

 

Event BeforeClose As EventHandler

BeforeOpen    (declared in ServerChannel)

 

event BeforeOpen: EventHandler;

 

delegate EventHandler BeforeOpen()

 

Event BeforeOpen As EventHandler

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.

 

event BeforeSendStream: EventHandler<StreamEventArgs>;

 

delegate EventHandler<StreamEventArgs> BeforeSendStream()

 

Event BeforeSendStream As EventHandler<StreamEventArgs>

CustomClientAccessPolicy    (declared in HttpServerChannel)

 

event CustomClientAccessPolicy: EventHandler<ClientAccessPolicyEventArgs>;

 

delegate EventHandler<ClientAccessPolicyEventArgs> CustomClientAccessPolicy()

 

Event CustomClientAccessPolicy As EventHandler<ClientAccessPolicyEventArgs>

GetRodl    (declared in ServerChannel)

 

event GetRodl: EventHandler<RodlEventArgs>;

 

delegate EventHandler<RodlEventArgs> GetRodl()

 

Event GetRodl As EventHandler<RodlEventArgs>

HttpRequest

 

event HttpRequest: HttpSysRequestEventHandler;
delegate: method HttpRequest(sender: Object; e: HttpSysRequestEventArgs)

 

delegate HttpSysRequestEventHandler HttpRequest()
delegate: void HttpRequest(Object sender, HttpSysRequestEventArgs e)

 

Event HttpRequest As HttpSysRequestEventHandler
delegate: Sub HttpRequest(sender As Object, e As HttpSysRequestEventArgs)

OnCustomCrossOrigin    (declared in HttpServerChannel)

 

event OnCustomCrossOrigin: EventHandler<CustomCrossOriginEventArgs>;

 

delegate EventHandler<CustomCrossOriginEventArgs> OnCustomCrossOrigin()

 

Event OnCustomCrossOrigin As EventHandler<CustomCrossOriginEventArgs>