NamedPipeServerChannel

Overview

The NamedPipeServerChannel class implements the server side of Named Pipes based communication channels. Named pipes can be used to provide communication between processes on the same computer or between processes on different computers across a network.

This channel is mainly used for communication between client and server on the same computer. To use this channel, perform the following steps:

  • On the server side, create an instance of the NamedPipeServerChannel class.
  • Define the Path property string that holds the unique server name.
  • Define the Server property string that holds the server host name or IP address.
  • On the client side, create an instance of the NamedPipeClientChannel class , and set up its Path and Server properties. Note that Path and Server must be the same on both client and server.

Location


 

constructor

Creates an instance of the NamedPipeServerChannel class.

 

constructor

 

NamedPipeServerChannel()

 

Sub New()

constructor (IContainer)

Creates an instance of the NamedPipeServerChannel class within the specified container.

 

constructor(container: IContainer)

 

NamedPipeServerChannel(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

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>

AllowAll

This property controls access to the underlying pipe object. If this property is set to true, full access to the pipe will be granted to everyone, otherwise it will be set to only grant full control to the LocalSystem account, administrators and the creator owner, and to grant read access to members of the Everyone group and the anonymous account.

Note that this property can only be used in a Windows environment.

 

property AllowAll: Boolean read write;

 

Boolean AllowAll { get; set; }

 

Property AllowAll() As Boolean

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>

ChannelType    (declared in ServerChannel)

 

property ChannelType: String read;

 

String ChannelType { get; }

 

ReadOnly Property 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

 

method CloseChannel

 

void CloseChannel()

 

Sub CloseChannel()

CopyProperties  protected    (declared in Channel)

 

method CopyProperties(source: Channel)

 

void CopyProperties(Channel source)

 

Sub CopyProperties(source As Channel)

Parameters:

  • source:

CustomParameters    (declared in ServerChannel)

 

property CustomParameters: IDictionary<String, String> read;

 

IDictionary<String, String> CustomParameters { get; }

 

ReadOnly Property CustomParameters() As IDictionary<String, String>

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; }

 

ReadOnly Property Dispatchers() As MessageDispatchers

Dispose  protected    (declared in ServerChannel)

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

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; serviceGroups: String; out contentType: String): Stream

 

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

 

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

Parameters:

  • context:
  • dispatcher:
  • serviceGroups:
  • contentType:

GetServiceMetaData  protected    (declared in ServerChannel)

 

method GetServiceMetaData(context: Object; dispatcher: MessageDispatcher; serviceName: String; options: Hashtable; out contentType: String): Stream

 

Stream GetServiceMetaData(Object context, MessageDispatcher dispatcher, String serviceName, Hashtable options, out String contentType)

 

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

Parameters:

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

HasAfterReceiveStream  protected    (declared in Channel)

 

property HasAfterReceiveStream: Boolean read;

 

Boolean HasAfterReceiveStream { get; }

 

ReadOnly Property HasAfterReceiveStream() As Boolean

HasBeforeSendStream  protected    (declared in Channel)

 

property HasBeforeSendStream: Boolean read;

 

Boolean HasBeforeSendStream { get; }

 

ReadOnly Property HasBeforeSendStream() As Boolean

Initializing  protected    (declared in ServerChannel)

 

property Initializing: Boolean read;

 

Boolean Initializing { get; }

 

ReadOnly Property Initializing() As Boolean

IS_TRIAL_MODE  protected    (declared in ServerChannel)

 

const IS_TRIAL_MODE: Boolean = False;

 

const Boolean IS_TRIAL_MODE = False

 

Dim IS_TRIAL_MODE As Boolean = False

IsTlsEnabled    (declared in ServerChannel)

 

property IsTlsEnabled: Boolean read;

 

Boolean IsTlsEnabled { get; }

 

ReadOnly Property IsTlsEnabled() As Boolean

Messages    (declared in ServerChannel)

 

property Messages: IList<String> read;

 

IList<String> Messages { get; }

 

ReadOnly Property Messages() As IList<String>

NetworkByteOrder

Defines the order in which bytes are transferred. If true, the channel uses big-endian when transferring the data.

 

property NetworkByteOrder: Boolean read write;

 

Boolean NetworkByteOrder { get; set; }

 

Property NetworkByteOrder() As Boolean

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

 

method OpenChannel

 

void OpenChannel()

 

Sub OpenChannel()

Path

Defines the unique name of the server to use. The name must match the Path property specified on the NamedPipeClientChannel in the client application.

 

property Path: String read write;

 

String Path { get; set; }

 

Property Path() As String

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

SecurityOptions

Exposes a number of settings you can use to protect your server against outside spoofing and denial-of-service attacks. In particular, you can set a maximum message size to be received from clients (to prevent attackers from bringing down your service by sending huge messages) and a maximum time that messages may take to be received (to prevent attackers from wasting server resources by keeping connections open and not, or very slowly, sending data).

 

property SecurityOptions: ServerSecurityOptions read;

 

ServerSecurityOptions SecurityOptions { get; }

 

ReadOnly Property SecurityOptions() As ServerSecurityOptions

Server

Specifies the name of the host running the server.

This can be a host name or IP address on the local network, or "." (default), which indicates the local machine.

 

property Server: String read write;

 

String Server { get; set; }

 

Property Server() 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

ServiceGroup    (declared in ServerChannel)

Allows to get/set Service Groups

 

property ServiceGroup: String read write;

 

String ServiceGroup { get; set; }

 

Property ServiceGroup() As String

ThreadPool

 

property ThreadPool: IThreadPool read write;

 

IThreadPool ThreadPool { get; set; }

 

Property ThreadPool() As IThreadPool

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:

TriggerGetRodl  protected    (declared in ServerChannel)

 

method TriggerGetRodl(e: RodlEventArgs)

 

void TriggerGetRodl(RodlEventArgs e)

 

Sub TriggerGetRodl(e As RodlEventArgs)

Parameters:

  • e:

ValidateServiceGroup    (declared in ServerChannel)

 

method ValidateServiceGroup(serviceGroups: array of String): Boolean

 

Boolean ValidateServiceGroup(String[] serviceGroups)

 

Function ValidateServiceGroup(serviceGroups As String()) As Boolean

Parameters:

  • serviceGroups:

 

IS_TRIAL_MODE  protected    (declared in ServerChannel)

 

const IS_TRIAL_MODE: Boolean = False;

 

const Boolean IS_TRIAL_MODE = False

 

Dim IS_TRIAL_MODE As Boolean = False

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

AllowAll

This property controls access to the underlying pipe object. If this property is set to true, full access to the pipe will be granted to everyone, otherwise it will be set to only grant full control to the LocalSystem account, administrators and the creator owner, and to grant read access to members of the Everyone group and the anonymous account.

Note that this property can only be used in a Windows environment.

 

property AllowAll: Boolean read write;

 

Boolean AllowAll { get; set; }

 

Property AllowAll() As Boolean

ChannelType    (declared in ServerChannel)

 

property ChannelType: String read;

 

String ChannelType { get; }

 

ReadOnly Property ChannelType() As String

CustomParameters    (declared in ServerChannel)

 

property CustomParameters: IDictionary<String, String> read;

 

IDictionary<String, String> CustomParameters { get; }

 

ReadOnly Property CustomParameters() As IDictionary<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; }

 

ReadOnly Property Dispatchers() As MessageDispatchers

HasAfterReceiveStream  protected    (declared in Channel)

 

property HasAfterReceiveStream: Boolean read;

 

Boolean HasAfterReceiveStream { get; }

 

ReadOnly Property HasAfterReceiveStream() As Boolean

HasBeforeSendStream  protected    (declared in Channel)

 

property HasBeforeSendStream: Boolean read;

 

Boolean HasBeforeSendStream { get; }

 

ReadOnly Property HasBeforeSendStream() As Boolean

Initializing  protected    (declared in ServerChannel)

 

property Initializing: Boolean read;

 

Boolean Initializing { get; }

 

ReadOnly Property Initializing() As Boolean

IsTlsEnabled    (declared in ServerChannel)

 

property IsTlsEnabled: Boolean read;

 

Boolean IsTlsEnabled { get; }

 

ReadOnly Property IsTlsEnabled() As Boolean

Messages    (declared in ServerChannel)

 

property Messages: IList<String> read;

 

IList<String> Messages { get; }

 

ReadOnly Property Messages() As IList<String>

NetworkByteOrder

Defines the order in which bytes are transferred. If true, the channel uses big-endian when transferring the data.

 

property NetworkByteOrder: Boolean read write;

 

Boolean NetworkByteOrder { get; set; }

 

Property NetworkByteOrder() As Boolean

Path

Defines the unique name of the server to use. The name must match the Path property specified on the NamedPipeClientChannel in the client application.

 

property Path: String read write;

 

String Path { get; set; }

 

Property Path() As String

SecurityOptions

Exposes a number of settings you can use to protect your server against outside spoofing and denial-of-service attacks. In particular, you can set a maximum message size to be received from clients (to prevent attackers from bringing down your service by sending huge messages) and a maximum time that messages may take to be received (to prevent attackers from wasting server resources by keeping connections open and not, or very slowly, sending data).

 

property SecurityOptions: ServerSecurityOptions read;

 

ServerSecurityOptions SecurityOptions { get; }

 

ReadOnly Property SecurityOptions() As ServerSecurityOptions

Server

Specifies the name of the host running the server.

This can be a host name or IP address on the local network, or "." (default), which indicates the local machine.

 

property Server: String read write;

 

String Server { get; set; }

 

Property Server() 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

ServiceGroup    (declared in ServerChannel)

Allows to get/set Service Groups

 

property ServiceGroup: String read write;

 

String ServiceGroup { get; set; }

 

Property ServiceGroup() As String

ThreadPool

 

property ThreadPool: IThreadPool read write;

 

IThreadPool ThreadPool { get; set; }

 

Property ThreadPool() As IThreadPool

 

constructor

Creates an instance of the NamedPipeServerChannel class.

 

constructor

 

NamedPipeServerChannel()

 

Sub New()

constructor (IContainer)

Creates an instance of the NamedPipeServerChannel class within the specified container.

 

constructor(container: IContainer)

 

NamedPipeServerChannel(IContainer container)

 

Sub New(container As IContainer)

Parameters:

  • container:

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

 

method CloseChannel

 

void CloseChannel()

 

Sub CloseChannel()

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 ServerChannel)

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

GetServerRodl  protected    (declared in ServerChannel)

 

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

 

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

 

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

Parameters:

  • context:
  • dispatcher:
  • serviceGroups:
  • contentType:

GetServiceMetaData  protected    (declared in ServerChannel)

 

method GetServiceMetaData(context: Object; dispatcher: MessageDispatcher; serviceName: String; options: Hashtable; out contentType: String): Stream

 

Stream GetServiceMetaData(Object context, MessageDispatcher dispatcher, String serviceName, Hashtable options, out String contentType)

 

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

Parameters:

  • context:
  • dispatcher:
  • serviceName:
  • options:
  • 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

 

method OpenChannel

 

void OpenChannel()

 

Sub OpenChannel()

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:

TriggerGetRodl  protected    (declared in ServerChannel)

 

method TriggerGetRodl(e: RodlEventArgs)

 

void TriggerGetRodl(RodlEventArgs e)

 

Sub TriggerGetRodl(e As RodlEventArgs)

Parameters:

  • e:

ValidateServiceGroup    (declared in ServerChannel)

 

method ValidateServiceGroup(serviceGroups: array of String): Boolean

 

Boolean ValidateServiceGroup(String[] serviceGroups)

 

Function ValidateServiceGroup(serviceGroups As String()) As Boolean

Parameters:

  • serviceGroups:

 

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>

GetRodl    (declared in ServerChannel)

 

event GetRodl: EventHandler<RodlEventArgs>;

 

delegate EventHandler<RodlEventArgs> GetRodl()

 

Event GetRodl As EventHandler<RodlEventArgs>