IpSuperTcpServerChannel

Overview

Server side of the enhanced TCP based channel.

Location

 

constructor

 

constructor

 

IpSuperTcpServerChannel()

 

Sub New

constructor (IContainer)

 

constructor(container: IContainer)

 

IpSuperTcpServerChannel(IContainer container)

 

Sub New (container As IContainer)

Parameters:

  • container:

AckWaitTimeout    (declared in SuperTcpServerChannel)

Specifies the time frame, in milliseconds, in which an "acknowledgement" message is expected to be received for a sent event (default is 60000, 1 minute).

If no acknowledgement has been received after the specified time, delivery will be considered to have failed and the event will be stored in queue for future retries.

 

property AckWaitTimeout: Int32 read write;

 

Int32 AckWaitTimeout { get; set; }

 

Property AckWaitTimeout As Int32

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_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_OnConnected    (declared in SuperTcpServerChannel)

 

method add_OnConnected(value: OnConnectedHandler)

 

void add_OnConnected(OnConnectedHandler value)

 

Sub add_OnConnected(value As OnConnectedHandler)

Parameters:

  • value:

add_OnDisconnected    (declared in SuperTcpServerChannel)

 

method add_OnDisconnected(value: OnConnectedHandler)

 

void add_OnDisconnected(OnConnectedHandler value)

 

Sub add_OnDisconnected(value As OnConnectedHandler)

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>

BlockingEvents    (declared in SuperTcpServerChannel)

Affects the processing of events on the server.

Setting BlockingEvents to true delays the event's dispatching. In this case, client events will happen in the main thread of the server and will be suspended. This value is useful if you want to make sure that events arrive in order.

If you want to process multiple events at once, you should use the default value BlockingEvents = false. In this case, the event is put in queue and will be dispatched in a separate thread. You possibly will have to to control the thread pool queue from overflowing, using ThreadPool.MaxQueue and ThreadPool.MaxThreads properties.

 

property BlockingEvents: Boolean read write;

 

Boolean BlockingEvents { get; set; }

 

Property BlockingEvents As Boolean

ChannelType    (declared in SuperTcpServerChannel)

This property is needed to determine the type of server channel for internal purposes. It has a "supertcp" value.

 

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

 

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: Dictionary<String, String> read;

 

Dictionary<String, String> CustomParameters { get; }

 

Property ReadOnly CustomParameters As Dictionary<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; }

 

Property ReadOnly Dispatchers As MessageDispatchers

Dispose  protected    (declared in SuperTcpServerChannel)

 

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

IncomingData  protected    (declared in SuperTcpServerChannel)

 

method IncomingData(worker: SuperTcpServerChannelWorker; package: SuperTcpPackage)

 

void IncomingData(SuperTcpServerChannelWorker worker, SuperTcpPackage package)

 

Sub IncomingData(worker As SuperTcpServerChannelWorker, package As SuperTcpPackage)

Parameters:

  • worker:
  • package:

Initializing  protected    (declared in ServerChannel)

 

property Initializing: Boolean read;

 

Boolean Initializing { get; }

 

Property ReadOnly Initializing As Boolean

IsRegisteredWorker    (declared in SuperTcpServerChannel)

 

method IsRegisteredWorker(worker: SuperTcpServerChannelWorker): Boolean

 

Boolean IsRegisteredWorker(SuperTcpServerChannelWorker worker)

 

Function IsRegisteredWorker(worker As SuperTcpServerChannelWorker) As Boolean

Parameters:

  • worker:

IsSingleRegisteredWorker    (declared in SuperTcpServerChannel)

 

method IsSingleRegisteredWorker(clientId: Guid): Boolean

 

Boolean IsSingleRegisteredWorker(Guid clientId)

 

Function IsSingleRegisteredWorker(clientId As Guid) As Boolean

Parameters:

  • clientId:

IsTrialMode  protected    (declared in ServerChannel)

 

property IsTrialMode: Boolean read;

 

Boolean IsTrialMode { get; }

 

Property ReadOnly IsTrialMode As Boolean

MaxPackageSize    (declared in SuperTcpServerChannel)

Determines the maximum size of data that server is able to receive (default is 1048576, 1MB).

 

property MaxPackageSize: Int32 read write;

 

Int32 MaxPackageSize { get; set; }

 

Property MaxPackageSize As Int32

Messages    (declared in ServerChannel)

 

property Messages: List<String> read;

 

List<String> Messages { get; }

 

Property ReadOnly Messages As List<String>

OnConnected    (declared in SuperTcpServerChannel)

Fires when an active TCP connection to the server has been (re-)established.

 

event OnConnected: OnConnectedHandler;
delegate: method OnConnected(sender: Object; info: IServerChannelInfo; clientId: Guid)

 

delegate OnConnectedHandler OnConnected()
delegate: void OnConnected(Object sender, IServerChannelInfo info, Guid clientId)

 

Event OnConnected As OnConnectedHandler
delegate: Sub OnConnected(sender As Object, info As IServerChannelInfo, clientId As Guid)

OnDisconnected    (declared in SuperTcpServerChannel)

Fires when the active TCP connection to the server has been dropped or lost.

 

event OnDisconnected: OnConnectedHandler;
delegate: method OnDisconnected(sender: Object; info: IServerChannelInfo; clientId: Guid)

 

delegate OnConnectedHandler OnDisconnected()
delegate: void OnDisconnected(Object sender, IServerChannelInfo info, Guid clientId)

 

Event OnDisconnected As OnConnectedHandler
delegate: Sub OnDisconnected(sender As Object, info As IServerChannelInfo, clientId As Guid)

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

 

method OpenChannel

 

void OpenChannel()

 

Sub OpenChannel

Port    (declared in SuperTcpServerChannel)

The network socket the server will be listening to (default for the Remoting SDK Super TCP servers is 8095).

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

Property Port As Int32

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

RegisterWorker    (declared in SuperTcpServerChannel)

 

method RegisterWorker(worker: SuperTcpServerChannelWorker)

 

void RegisterWorker(SuperTcpServerChannelWorker worker)

 

Sub RegisterWorker(worker As SuperTcpServerChannelWorker)

Parameters:

  • worker:

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_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_OnConnected    (declared in SuperTcpServerChannel)

 

method remove_OnConnected(value: OnConnectedHandler)

 

void remove_OnConnected(OnConnectedHandler value)

 

Sub remove_OnConnected(value As OnConnectedHandler)

Parameters:

  • value:

remove_OnDisconnected    (declared in SuperTcpServerChannel)

 

method remove_OnDisconnected(value: OnConnectedHandler)

 

void remove_OnDisconnected(OnConnectedHandler value)

 

Sub remove_OnDisconnected(value As OnConnectedHandler)

Parameters:

  • value:

Server    (declared in SuperTcpServerChannel)

 

property Server: AsyncTcpServer read;

 

AsyncTcpServer Server { get; }

 

Property ReadOnly Server As AsyncTcpServer

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

SkipAck    (declared in SuperTcpServerChannel)

 

property SkipAck: Boolean read write;

 

Boolean SkipAck { get; set; }

 

Property SkipAck As Boolean

SslOptions    (declared in SuperTcpServerChannel)

 

property SslOptions: SslConnectionFactory read;

 

SslConnectionFactory SslOptions { get; }

 

Property ReadOnly SslOptions As SslConnectionFactory

ThreadPool    (declared in SuperTcpServerChannel)

 

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:

TriggerOnConnected  protected    (declared in SuperTcpServerChannel)

 

method TriggerOnConnected(channel: IServerChannelInfo; clientId: Guid)

 

void TriggerOnConnected(IServerChannelInfo channel, Guid clientId)

 

Sub TriggerOnConnected(channel As IServerChannelInfo, clientId As Guid)

Parameters:

  • channel:
  • clientId:

TriggerOnDisconnected  protected    (declared in SuperTcpServerChannel)

 

method TriggerOnDisconnected(channel: IServerChannelInfo; clientId: Guid)

 

void TriggerOnDisconnected(IServerChannelInfo channel, Guid clientId)

 

Sub TriggerOnDisconnected(channel As IServerChannelInfo, clientId As Guid)

Parameters:

  • channel:
  • clientId:

UnregisterWorker    (declared in SuperTcpServerChannel)

 

method UnregisterWorker(worker: SuperTcpServerChannelWorker)

 

void UnregisterWorker(SuperTcpServerChannelWorker worker)

 

Sub UnregisterWorker(worker As SuperTcpServerChannelWorker)

Parameters:

  • worker:

 

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

 

AckWaitTimeout    (declared in SuperTcpServerChannel)

Specifies the time frame, in milliseconds, in which an "acknowledgement" message is expected to be received for a sent event (default is 60000, 1 minute).

If no acknowledgement has been received after the specified time, delivery will be considered to have failed and the event will be stored in queue for future retries.

 

property AckWaitTimeout: Int32 read write;

 

Int32 AckWaitTimeout { get; set; }

 

Property AckWaitTimeout As Int32

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

BlockingEvents    (declared in SuperTcpServerChannel)

Affects the processing of events on the server.

Setting BlockingEvents to true delays the event's dispatching. In this case, client events will happen in the main thread of the server and will be suspended. This value is useful if you want to make sure that events arrive in order.

If you want to process multiple events at once, you should use the default value BlockingEvents = false. In this case, the event is put in queue and will be dispatched in a separate thread. You possibly will have to to control the thread pool queue from overflowing, using ThreadPool.MaxQueue and ThreadPool.MaxThreads properties.

 

property BlockingEvents: Boolean read write;

 

Boolean BlockingEvents { get; set; }

 

Property BlockingEvents As Boolean

ChannelType    (declared in SuperTcpServerChannel)

This property is needed to determine the type of server channel for internal purposes. It has a "supertcp" value.

 

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

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

MaxPackageSize    (declared in SuperTcpServerChannel)

Determines the maximum size of data that server is able to receive (default is 1048576, 1MB).

 

property MaxPackageSize: Int32 read write;

 

Int32 MaxPackageSize { get; set; }

 

Property MaxPackageSize As Int32

Messages    (declared in ServerChannel)

 

property Messages: List<String> read;

 

List<String> Messages { get; }

 

Property ReadOnly Messages As List<String>

Port    (declared in SuperTcpServerChannel)

The network socket the server will be listening to (default for the Remoting SDK Super TCP servers is 8095).

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

Property Port As Int32

Server    (declared in SuperTcpServerChannel)

 

property Server: AsyncTcpServer read;

 

AsyncTcpServer Server { get; }

 

Property ReadOnly Server As AsyncTcpServer

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

SkipAck    (declared in SuperTcpServerChannel)

 

property SkipAck: Boolean read write;

 

Boolean SkipAck { get; set; }

 

Property SkipAck As Boolean

SslOptions    (declared in SuperTcpServerChannel)

 

property SslOptions: SslConnectionFactory read;

 

SslConnectionFactory SslOptions { get; }

 

Property ReadOnly SslOptions As SslConnectionFactory

ThreadPool    (declared in SuperTcpServerChannel)

 

property ThreadPool: IThreadPool read write;

 

IThreadPool ThreadPool { get; set; }

 

Property ThreadPool As IThreadPool

 

constructor

 

constructor

 

IpSuperTcpServerChannel()

 

Sub New

constructor (IContainer)

 

constructor(container: IContainer)

 

IpSuperTcpServerChannel(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_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_OnConnected    (declared in SuperTcpServerChannel)

 

method add_OnConnected(value: OnConnectedHandler)

 

void add_OnConnected(OnConnectedHandler value)

 

Sub add_OnConnected(value As OnConnectedHandler)

Parameters:

  • value:

add_OnDisconnected    (declared in SuperTcpServerChannel)

 

method add_OnDisconnected(value: OnConnectedHandler)

 

void add_OnDisconnected(OnConnectedHandler value)

 

Sub add_OnDisconnected(value As OnConnectedHandler)

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

 

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

 

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

IncomingData  protected    (declared in SuperTcpServerChannel)

 

method IncomingData(worker: SuperTcpServerChannelWorker; package: SuperTcpPackage)

 

void IncomingData(SuperTcpServerChannelWorker worker, SuperTcpPackage package)

 

Sub IncomingData(worker As SuperTcpServerChannelWorker, package As SuperTcpPackage)

Parameters:

  • worker:
  • package:

IsRegisteredWorker    (declared in SuperTcpServerChannel)

 

method IsRegisteredWorker(worker: SuperTcpServerChannelWorker): Boolean

 

Boolean IsRegisteredWorker(SuperTcpServerChannelWorker worker)

 

Function IsRegisteredWorker(worker As SuperTcpServerChannelWorker) As Boolean

Parameters:

  • worker:

IsSingleRegisteredWorker    (declared in SuperTcpServerChannel)

 

method IsSingleRegisteredWorker(clientId: Guid): Boolean

 

Boolean IsSingleRegisteredWorker(Guid clientId)

 

Function IsSingleRegisteredWorker(clientId As Guid) As Boolean

Parameters:

  • clientId:

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

 

method OpenChannel

 

void OpenChannel()

 

Sub OpenChannel

RegisterWorker    (declared in SuperTcpServerChannel)

 

method RegisterWorker(worker: SuperTcpServerChannelWorker)

 

void RegisterWorker(SuperTcpServerChannelWorker worker)

 

Sub RegisterWorker(worker As SuperTcpServerChannelWorker)

Parameters:

  • worker:

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_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_OnConnected    (declared in SuperTcpServerChannel)

 

method remove_OnConnected(value: OnConnectedHandler)

 

void remove_OnConnected(OnConnectedHandler value)

 

Sub remove_OnConnected(value As OnConnectedHandler)

Parameters:

  • value:

remove_OnDisconnected    (declared in SuperTcpServerChannel)

 

method remove_OnDisconnected(value: OnConnectedHandler)

 

void remove_OnDisconnected(OnConnectedHandler value)

 

Sub remove_OnDisconnected(value As OnConnectedHandler)

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:

TriggerGetRodl  protected    (declared in ServerChannel)

 

method TriggerGetRodl(e: RodlEventArgs)

 

void TriggerGetRodl(RodlEventArgs e)

 

Sub TriggerGetRodl(e As RodlEventArgs)

Parameters:

  • e:

TriggerOnConnected  protected    (declared in SuperTcpServerChannel)

 

method TriggerOnConnected(channel: IServerChannelInfo; clientId: Guid)

 

void TriggerOnConnected(IServerChannelInfo channel, Guid clientId)

 

Sub TriggerOnConnected(channel As IServerChannelInfo, clientId As Guid)

Parameters:

  • channel:
  • clientId:

TriggerOnDisconnected  protected    (declared in SuperTcpServerChannel)

 

method TriggerOnDisconnected(channel: IServerChannelInfo; clientId: Guid)

 

void TriggerOnDisconnected(IServerChannelInfo channel, Guid clientId)

 

Sub TriggerOnDisconnected(channel As IServerChannelInfo, clientId As Guid)

Parameters:

  • channel:
  • clientId:

UnregisterWorker    (declared in SuperTcpServerChannel)

 

method UnregisterWorker(worker: SuperTcpServerChannelWorker)

 

void UnregisterWorker(SuperTcpServerChannelWorker worker)

 

Sub UnregisterWorker(worker As SuperTcpServerChannelWorker)

Parameters:

  • worker:

 

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>

OnConnected    (declared in SuperTcpServerChannel)

Fires when an active TCP connection to the server has been (re-)established.

 

event OnConnected: OnConnectedHandler;
delegate: method OnConnected(sender: Object; info: IServerChannelInfo; clientId: Guid)

 

delegate OnConnectedHandler OnConnected()
delegate: void OnConnected(Object sender, IServerChannelInfo info, Guid clientId)

 

Event OnConnected As OnConnectedHandler
delegate: Sub OnConnected(sender As Object, info As IServerChannelInfo, clientId As Guid)

OnDisconnected    (declared in SuperTcpServerChannel)

Fires when the active TCP connection to the server has been dropped or lost.

 

event OnDisconnected: OnConnectedHandler;
delegate: method OnDisconnected(sender: Object; info: IServerChannelInfo; clientId: Guid)

 

delegate OnConnectedHandler OnDisconnected()
delegate: void OnDisconnected(Object sender, IServerChannelInfo info, Guid clientId)

 

Event OnDisconnected As OnConnectedHandler
delegate: Sub OnDisconnected(sender As Object, info As IServerChannelInfo, clientId As Guid)