TROWinMessageChannel

Overview

TROWinMessageChannel implements a channel that uses Windows Messages to communicate between a client and a server on the same local machine.

Location

 

constructor Create  override

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

ActiveEvents

Allows to support IROActiveEventChannel

property ActiveEvents: Boolean read write

ActiveGuid

property ActiveGuid: TGUID read write

Assign  override    (declared in TROTransportChannel)

Copies the contents of another, similar object.

procedure Assign(aSource: TPersistent)

Parameters:

  • aSource: Instance whose properties will be copied

AssignEvents  protected virtual    (declared in TROTransportChannel)

Copies the events of another, similar object.

procedure AssignEvents(aSource: TROTransportChannel)

Parameters:

  • aSource:

AssignSpecificProperties  protected override

Copies the specific properties of another, similar object.

procedure AssignSpecificProperties(aSource: TROTransportChannel)

Parameters:

  • aSource:

AsyncException  protected virtual    (declared in TROTransportChannel)

Notifies about an exception in an asynchronous mode.

procedure AsyncException(aAsyncInterface: IROAsyncInterface; AsyncException: Exception)

Parameters:

  • aAsyncInterface: Exception source
  • AsyncException: Exception data

BeforeDispatch  protected override

Allows an implimentation to do necessary preparatory actions (checking the readiness of the channel, restore session data, etc.).

procedure BeforeDispatch(aMessage: IROMessage)

Parameters:


Busy    (declared in TROTransportChannel)

Informs whether the channel is currently busy executing a remote request (true) or not (false). Most channels (except most notably the TROSuperTCPChannel) are only capable of performing one request at a time; if a second request is attempted while the channel is Busy, an EROChannelBusy exception will be raised.

property Busy: boolean read write

CallbackEvents  protected    (declared in TROBaseActiveEventChannel)

Sends event to each registered IROEventReceiver

procedure CallbackEvents(aData: TStream; aThread: TThread)

Parameters:

  • aData: Data stream
  • aThread: Working thread to process the event

ChangeServerLocator  protected virtual    (declared in TROTransportChannel)

procedure ChangeServerLocator(var faultstartlocatoridx: integer; var aRetry: Boolean; const aException: Exception)

Parameters:

  • faultstartlocatoridx:
  • aRetry:
  • aException:

ChannelMatchingTargetUri    (declared in TROTransportChannel)

Creates a client channel instance with type, target host and target port matching the provided target Uri. F.e. for provided uri supertcp://192.168.1.100:7020/bin this method will return an instance of the Super Tcp channel with target host set to 192.168.1.100 and port set to 7020.

class function ChannelMatchingTargetUri(const aUri: TROUri): TROTransportChannel

Parameters:

  • aUri: Server Uri

ChannelMatchingTargetUrl    (declared in TROTransportChannel)

class function ChannelMatchingTargetUrl(const aUrl: string): TROTransportChannel

Parameters:

  • aUrl:

CheckProperties  override

Validates channel properties

procedure CheckProperties

CurrentLocator    (declared in TROTransportChannel)

Returns which of the fail-over/load balancing servers configured in the ServerLocators is currently active. Depending on the DispatchOptions defined, this value might change with each request, or only if the current server fails.

property CurrentLocator: TROServerLocator read write

DecryptStream (TStream)  protected overload    (declared in TROBaseConnection)

procedure DecryptStream(const iStream: TStream)

Parameters:

  • iStream:

DecryptStream (TStream, TStream)  protected overload    (declared in TROBaseConnection)

procedure DecryptStream(const aSource: TStream; const aDest: TStream)

Parameters:

  • aSource:
  • aDest:

DefaultDirectory

Sets the default directory to use when launching the server if the StartServer property is set to true.

property DefaultDirectory: string read write

Delay

Channel should wait this time, in milliseconds, after launching if the StartServer property is set to true. Default is 0. Using this delay, you can give the server process time to load and initialize, if necessary.

property Delay: word read write

Dispatch (IROMessage)  protected reintroduce overload    (declared in TROTransportChannel)

Sends a request message through the Self channel for processing and gets back an aMessage. CodeGen uses this method when generating a [proxy](http://docs.rosdk.com/Understanding_the_Client_Side_(.NET_and_Delphi)#How does it work?) from RODL Files.

procedure Dispatch(aMessage: IROMessage)

Parameters:

  • aMessage: (In/out) message data

DispatchOptions

Configures the available fail-over and load balancing options provided by the Remoting SDK. By default, channels are set up to talk to one specific server only. Two independent options are available to provide fail-over and load balancing: * Enables fail-over support. If the connection to any given server fails, the channel will automatically keep trying the next server specified in ServerLocators, until a working server is found or all servers have been tried. * Enables load-balancing support. Each request dispatched through the channel will go to a different server configured in ServerLocators, resulting in calls being more or less equally distributed over the available servers. Enabling any of these options obviously requires the server to be implemented in a stateless way, so that it does not depend on all requests from a client going to the same server. This implies using a class factory different from Per-Client and, if sessions are used, a session manager that allows sharing of session state between servers.

property DispatchOptions:

DoAfterProbingServerEvent  protected virtual    (declared in TROTransportChannel)

Fires OnAfterProbingServer event

procedure DoAfterProbingServerEvent(const aServerLocator: TROServerLocator; const Failed: Boolean)

Parameters:

  • aServerLocator: Server locator
  • Failed:

DoAfterProbingServersEvent  protected virtual    (declared in TROTransportChannel)

Fires OnAfterProbingServers event

procedure DoAfterProbingServersEvent(const ProbedCount: integer; const EnabledCount: integer; const DisabledCount: integer)

Parameters:

  • ProbedCount:
  • EnabledCount:
  • DisabledCount:

DoBeforeDecryptEvent  protected virtual    (declared in TROBaseConnection) obsolete

procedure DoBeforeDecryptEvent(aEncryptedStream: TStream)

Parameters:

  • aEncryptedStream:

DoBeforeProbingServerEvent  protected virtual    (declared in TROTransportChannel)

Fires OnBeforeProbingServer event

procedure DoBeforeProbingServerEvent(const aServerLocator: TROServerLocator)

Parameters:

  • aServerLocator: Server locator

DoBeforeProbingServersEvent  protected virtual    (declared in TROTransportChannel)

Fires OnBeforeProbingServers event

procedure DoBeforeProbingServersEvent

DoDecryption  virtual    (declared in TROBaseConnection) obsolete

procedure DoDecryption(iCipherText: TStream; iPlainText: TStream)

Parameters:

  • iCipherText:
  • iPlainText:

DoEncryption  virtual    (declared in TROBaseConnection) obsolete

procedure DoEncryption(iPlainText: TStream; iCipherText: TStream)

Parameters:

  • iPlainText:
  • iCipherText:

DoException  protected virtual    (declared in TROTransportChannel)

Fires OnException event

procedure DoException(anException: Exception; var aRetry: Boolean)

Parameters:

  • anException:
  • aRetry:

DoReceiveStreamEvent  protected virtual    (declared in TROTransportChannel)

Fires OnReceiveStream event

procedure DoReceiveStreamEvent(const aStream: TStream)

Parameters:

  • aStream: Stream

DoSendStreamEvent  protected virtual    (declared in TROTransportChannel)

Fires OnSendStream event

procedure DoSendStreamEvent(const aStream: TStream)

Parameters:

  • aStream: Stream

DoServerLocatorAssignmentEvent  protected virtual    (declared in TROTransportChannel)

Fires OnServerLocatorAssignment event

procedure DoServerLocatorAssignmentEvent(const aLocator: TROServerLocator; const aException: Exception)

Parameters:

  • aLocator:
  • aException:

Encryption    (declared in TROBaseConnection) obsolete

This is DES based enscryption, it is obsolete because works only for Delphi. Use message envelope AES Encryption Envelope instead.

property Encryption: TROEncryption read write

EncryptStream (TStream)  protected overload    (declared in TROBaseConnection)

Encrypts given stream

procedure EncryptStream(const iStream: TStream)

Parameters:

  • iStream: Source and Destination

EncryptStream (TStream, TStream)  protected overload    (declared in TROBaseConnection)

Encrypts given stream

procedure EncryptStream(const aSource: TStream; const aDest: TStream)

Parameters:

  • aSource: Source
  • aDest: Destination

EventReceiverList  protected    (declared in TROBaseActiveEventChannel)

Provides a list of registered IROEventReceiver

property EventReceiverList: TInterfaceList read write

FaultToleranceLocatorIdx    (declared in TROTransportChannel)

property FaultToleranceLocatorIdx: integer read write

FileName

This is the executable that will be launched if the StartServer property is set to true.

property FileName: string read write

GetTransportObject  protected override

Returns itself.

function GetTransportObject: TObject

InitServerLocator  protected virtual    (declared in TROTransportChannel)

Sets CurrentLocator

function InitServerLocator: Integer

IsEncryptionUsed  protected    (declared in TROBaseConnection)

function IsEncryptionUsed: Boolean

isProbeMode  protected    (declared in TROTransportChannel)

Returns True if channel is used for probing purposes

property isProbeMode: Boolean read write

isStreamEncrypted  protected    (declared in TROBaseConnection)

Checks state of stream

function isStreamEncrypted(aStream: TStream): Boolean

Parameters:

  • aStream: Stream

LaunchAsyncTask  protected    (declared in TROTransportChannel)

procedure LaunchAsyncTask(aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

LoadBalancerLocatorIdx    (declared in TROTransportChannel)

property LoadBalancerLocatorIdx: Integer read write

OnAfterEncrypt    (declared in TROBaseConnection)

property OnAfterEncrypt: TROBaseConnectionOperation read write
delegate: procedure OnAfterEncrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

OnAfterProbingServer    (declared in TROTransportChannel)

Fires after the channel is done probing a specific server for availability. You can use this event to check the result of the probing, possibly to update internal data structures or to display server status in the user interface.

property OnAfterProbingServer: TROEndProbeServerEvent read write
delegate: procedure OnAfterProbingServer(Sender: TROTransportChannel; aServerLocator: TROServerLocator; Failed: boolean)

OnAfterProbingServer

Fires after the channel is done probing a specific server for availability. You can use this event to check the result of the probing, possibly to update internal data structures or to display server status in the user interface.

property OnAfterProbingServer:

OnAfterProbingServers    (declared in TROTransportChannel)

Fires after the channel is done probing all servers for availability. You can use this event to check the result of the probing, possibly to update internal data structures or to display server status in the user interface.

property OnAfterProbingServers: TROEndProbeServersEvent read write
delegate: procedure OnAfterProbingServers(Sender: TROTransportChannel; ProbedCount: integer; EnabledCount: integer; DisabledCount: integer)

OnAfterProbingServers

Fires after the channel is done probing all servers for availability. You can use this event to check the result of the probing, possibly to update internal data structures or to display server status in the user interface.

property OnAfterProbingServers:

OnAsyncException    (declared in TROTransportChannel)

Fires when exception is raised in asynchronous mode

property OnAsyncException: TROAsyncExceptionEvent read write
delegate: procedure OnAsyncException(Sender: TROTransportChannel; Async: IROAsyncInterface; anException: Exception)

OnBeforeDecrypt    (declared in TROBaseConnection)

property OnBeforeDecrypt: TROBaseConnectionOperation read write
delegate: procedure OnBeforeDecrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

OnBeforeProbingServer    (declared in TROTransportChannel)

Fires before the channel starts probing a specific server for availability. You can use this event to: * check or adjust the server configuration * to include/exclude the server from being probed by changing the TROServerLocator property.

property OnBeforeProbingServer: TROBeginProbeServerEvent read write
delegate: procedure OnBeforeProbingServer(Sender: TROTransportChannel; aServerLocator: TROServerLocator)

OnBeforeProbingServer

Fires before the channel starts probing a specific server for availability. You can use this event to: * check or adjust the server configuration * to include/exclude the server from being probed by changing the TROServerLocator property.

property OnBeforeProbingServer:

OnBeforeProbingServers    (declared in TROTransportChannel)

Fires before the channel starts probing all servers for availability. You can use this event: * to check or adjust the server configurations * to include/exclude individual server from being probed by changing their TROServerLocator properties.

property OnBeforeProbingServers: TROBeginProbeServersEvent read write
delegate: procedure OnBeforeProbingServers(Sender: TROTransportChannel)

OnBeforeProbingServers

Fires before the channel starts probing all servers for availability. You can use this event: * to check or adjust the server configurations * to include/exclude individual server from being probed by changing their TROServerLocator properties.

property OnBeforeProbingServers:

OnException    (declared in TROTransportChannel)

Fires if an exception is raised during the execution of a remote request. This could be an exception returned from the server, a communication problem or an error within the client. Depending on the type of error, your event handler can try to rectify the problem, and set aRetry to true to have the channel try and perform the request again. For example, an application could show a dialog asking the user to confirm if his internet connection is available, with Cancel and Retry buttons.
If aRetry is set to true and the call succeeds at the second attempt, the call will return to the original code that initiated the request, as if the exception never happened.

property OnException: TROExceptionEvent read write
delegate: procedure OnException(Sender: TROTransportChannel; anException: Exception; var aRetry: Boolean)

OnLoginNeeded    (declared in TROTransportChannel)

Fires if an EROSessionNotFound (or the descendant SessionNotFoundException) exception is raised during the execution of a remote request. This usually indicates that the server cannot authenticate the client or that the session has expired. The most common use for this event is to perform a call to a special Login service provided by the server (possibly after prompting the user to enter username and password), and to set the aRetry parameter to true if login was successful.

property OnLoginNeeded: TROExceptionEvent read write
delegate: procedure OnLoginNeeded(Sender: TROTransportChannel; anException: Exception; var aRetry: Boolean)

OnLoginNeeded

Fires if an EROSessionNotFound (or the descendant SessionNotFoundException) exception is raised during the execution of a remote request. This usually indicates that the server cannot authenticate the client or that the session has expired. The most common use for this event is to perform a call to a special Login service provided by the server (possibly after prompting the user to enter username and password), and to set the aRetry parameter to true if login was successful.

property OnLoginNeeded:

OnProgress    (declared in TROTransportChannel)

This event fires as the channel is transferring data for a request or response to or from the server, informing of the current progress. It can be used to keep the user interface updated during lengthy transfers,e.g. by showing a progress bar or the remaining transfer volume. Note: the accuracy and frequency of calls to OnProgress depends on the channel type; since channels transport data packets in different sized chunks (or even all-at-once), OnProgress might show a very fine progress for some channels, while jumping from 0 to 100% in one step with others.

property OnProgress: TProgressEvent read write
delegate: procedure OnProgress(iSender: TObject; iType: TProgressType; iDirection: TProgressDirection; iTransferred: integer; iTotal: integer)

OnReceiveStream    (declared in TROTransportChannel)

Fires after a stream with a response message has been received from the server. Use this event handler to inspect and possibly modify the stream, before it continues to be processed by the higher levels of the Remoting SDK framework.

property OnReceiveStream: TStreamDispatch read write
delegate: procedure OnReceiveStream(aStream: TStream)

OnReceiveStream

Fires after a stream with a response message has been received from the server. Use this event handler to inspect and possibly modify the stream, before it continues to be processed by the higher levels of the Remoting SDK framework.

property OnReceiveStream:

OnSendStream    (declared in TROTransportChannel)

Fires just as a stream with a request message will be sent to the server. The event handler can inspect and possibly modify the stream, before it continues to be sent off to the server.

property OnSendStream: TStreamDispatch read write
delegate: procedure OnSendStream(aStream: TStream)

OnSendStream

Fires just as a stream with a request message will be sent to the server. The event handler can inspect and possibly modify the stream, before it continues to be sent off to the server.

property OnSendStream:

OnServerLocatorAssignment    (declared in TROTransportChannel)

Fires before changing of a server locator.

property OnServerLocatorAssignment: TServerLocatorAssignment read write
delegate: procedure OnServerLocatorAssignment(Sender: TROTransportChannel; aLocator: TROServerLocator; aException: Exception)

OnServerLocatorAssignment

Fires before changing of a server locator.

property OnServerLocatorAssignment:

OpenServer  protected

procedure OpenServer

Parameters

Holds the parameters to pass when launching the server if the StartServer property is set to true.

property Parameters: string read write

Probe  protected    (declared in TROTransportChannel)

Checks the accessibility of servers from the ServerLocators. This method is intended to provide fail-over and load balancing support in the Remoting SDK Architecture.

function Probe(aServerLocator: TROServerLocator): boolean

Parameters:

  • aServerLocator: Server locator

ProbeAll  protected    (declared in TROTransportChannel)

Checks the availability of all known servers.

procedure ProbeAll

ProbeFrequency

Sets at what intervals, in milliseconds, the channel will probe the servers configured in ServerLocators for availability. The default value is 60,000 (60 seconds). See the ProbeServers property for a more detailed description. Although somewhat misnamed, this property defines the Interval between probes, not the actual probing Frequency. The property name is persisted for backward compatibility.

property ProbeFrequency:

ProbeServers

Toggles whether the channel will continuously probe the servers configured in ServerLocators for availability. If enabled (true), the channel will ping all servers at a regular interval to determine if they are reachable. If a server fails to respond, it will be disabled for future calls until a later probe can reach it again. The interval between probes can be configured using the ProbeFrequency property. By default, server probing is turned off.

property ProbeServers:

RegisterEventReceiver  protected override

Registers a new event receiver object aReceiver in the specified channel. This procedure is needed to further use the aReceiver as receiver for callback events.

procedure RegisterEventReceiver(aReceiver: IROEventReceiver)

Parameters:

  • aReceiver: the event receiver that should be registered.

ResetProbingClone  protected virtual    (declared in TROTransportChannel)

Resets channel that is used for probing

procedure ResetProbingClone(aProbe: TROTransportChannel)

Parameters:

  • aProbe: Probing clone

RetrieveMetadata  protected virtual    (declared in TROTransportChannel)

Retrieves metadata from server

procedure RetrieveMetadata(out Metadata: TStream)

Parameters:

  • Metadata: Destination stream

RetrieveRODL  protected    (declared in TROTransportChannel)

This method is used for to obtaining the RODL library from the server without havin to rely on a channel-specific mechanism (such as a HTTP request to http://servername:port/rodl).

procedure RetrieveRODL(out RODLLibrary: TRODLLibrary)

Parameters:

  • RODLLibrary: Result

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

ServerID

Defines the unique ID of the server to call. This must match the ServerID specified on the TRONamedPipeServer in the server application.

property ServerID: string read write

ServerLocators

Optionally, this collection property can be filled to contain a list of possible servers to be used for fail-over or load balancing purposes. Depending on the settings configured in DispatchOptions, the channel will automatically spread calls over the available servers, or fall back to another server if one fails.

property ServerLocators:

SetAsyncBusy  protected virtual    (declared in TROTransportChannel)

procedure SetAsyncBusy(const Value: Boolean)

Parameters:

  • Value:

SetServerLocator  protected    (declared in TROTransportChannel)

Retrieves the location details of a server from aServerLocator.

procedure SetServerLocator(aServerLocator: TROServerLocator; anException: Exception)

Parameters:

  • aServerLocator: Configuration data of the server
  • anException: Exception

StartServer

Toggles whether the server should automatically be started by launching the executable specified in FileName, if it's not already running.

property StartServer: boolean read write

SynchronizedProbing

Determines whether server probing happens in the context of the main VCL thread (true, default) or in a background worker thread. See the ProbeServers property for a more detailed description.

property SynchronizedProbing:

TargetUri    (declared in TROTransportChannel)

Target URI

property TargetUri: TROUri read write

TargetUrl  protected    (declared in TROTransportChannel)

The address of the server.

property TargetUrl: string read write

ThreadSafe  protected    (declared in TROTransportChannel)

property ThreadSafe: Boolean read write

TriggerProgress  protected virtual    (declared in TROTransportChannel)

Fires OnProgress event

procedure TriggerProgress(iType: TProgressType; iDirection: TProgressDirection; iTransfered: integer; iTotal: integer)

Parameters:

  • iType: progress type
  • iDirection: direction
  • iTransfered: transfered bytes
  • iTotal: total bytes

UnregisterEventReceiver  protected override

Unregisters the specified IROEventReceiver aReceiver in the specified channel.

procedure UnregisterEventReceiver(aReceiver: IROEventReceiver)

Parameters:

  • aReceiver: The event receiver that should be unregistered.

UnregisterEventReceivers  protected    (declared in TROBaseActiveEventChannel)

Unregisters the all event receivers in the specified channel.

procedure UnregisterEventReceivers

 

ActiveEvents

Allows to support IROActiveEventChannel

property ActiveEvents: Boolean read write

ActiveGuid

property ActiveGuid: TGUID read write

Busy    (declared in TROTransportChannel)

Informs whether the channel is currently busy executing a remote request (true) or not (false). Most channels (except most notably the TROSuperTCPChannel) are only capable of performing one request at a time; if a second request is attempted while the channel is Busy, an EROChannelBusy exception will be raised.

property Busy: boolean read write

CurrentLocator    (declared in TROTransportChannel)

Returns which of the fail-over/load balancing servers configured in the ServerLocators is currently active. Depending on the DispatchOptions defined, this value might change with each request, or only if the current server fails.

property CurrentLocator: TROServerLocator read write

DefaultDirectory

Sets the default directory to use when launching the server if the StartServer property is set to true.

property DefaultDirectory: string read write

Delay

Channel should wait this time, in milliseconds, after launching if the StartServer property is set to true. Default is 0. Using this delay, you can give the server process time to load and initialize, if necessary.

property Delay: word read write

DispatchOptions

Configures the available fail-over and load balancing options provided by the Remoting SDK. By default, channels are set up to talk to one specific server only. Two independent options are available to provide fail-over and load balancing: * Enables fail-over support. If the connection to any given server fails, the channel will automatically keep trying the next server specified in ServerLocators, until a working server is found or all servers have been tried. * Enables load-balancing support. Each request dispatched through the channel will go to a different server configured in ServerLocators, resulting in calls being more or less equally distributed over the available servers. Enabling any of these options obviously requires the server to be implemented in a stateless way, so that it does not depend on all requests from a client going to the same server. This implies using a class factory different from Per-Client and, if sessions are used, a session manager that allows sharing of session state between servers.

property DispatchOptions:

Encryption    (declared in TROBaseConnection) obsolete

This is DES based enscryption, it is obsolete because works only for Delphi. Use message envelope AES Encryption Envelope instead.

property Encryption: TROEncryption read write

EventReceiverList  protected    (declared in TROBaseActiveEventChannel)

Provides a list of registered IROEventReceiver

property EventReceiverList: TInterfaceList read write

FaultToleranceLocatorIdx    (declared in TROTransportChannel)

property FaultToleranceLocatorIdx: integer read write

FileName

This is the executable that will be launched if the StartServer property is set to true.

property FileName: string read write

isProbeMode  protected    (declared in TROTransportChannel)

Returns True if channel is used for probing purposes

property isProbeMode: Boolean read write

LoadBalancerLocatorIdx    (declared in TROTransportChannel)

property LoadBalancerLocatorIdx: Integer read write

OnAfterProbingServer

Fires after the channel is done probing a specific server for availability. You can use this event to check the result of the probing, possibly to update internal data structures or to display server status in the user interface.

property OnAfterProbingServer:

OnAfterProbingServers

Fires after the channel is done probing all servers for availability. You can use this event to check the result of the probing, possibly to update internal data structures or to display server status in the user interface.

property OnAfterProbingServers:

OnBeforeProbingServer

Fires before the channel starts probing a specific server for availability. You can use this event to: * check or adjust the server configuration * to include/exclude the server from being probed by changing the TROServerLocator property.

property OnBeforeProbingServer:

OnBeforeProbingServers

Fires before the channel starts probing all servers for availability. You can use this event: * to check or adjust the server configurations * to include/exclude individual server from being probed by changing their TROServerLocator properties.

property OnBeforeProbingServers:

OnLoginNeeded

Fires if an EROSessionNotFound (or the descendant SessionNotFoundException) exception is raised during the execution of a remote request. This usually indicates that the server cannot authenticate the client or that the session has expired. The most common use for this event is to perform a call to a special Login service provided by the server (possibly after prompting the user to enter username and password), and to set the aRetry parameter to true if login was successful.

property OnLoginNeeded:

OnReceiveStream

Fires after a stream with a response message has been received from the server. Use this event handler to inspect and possibly modify the stream, before it continues to be processed by the higher levels of the Remoting SDK framework.

property OnReceiveStream:

OnSendStream

Fires just as a stream with a request message will be sent to the server. The event handler can inspect and possibly modify the stream, before it continues to be sent off to the server.

property OnSendStream:

OnServerLocatorAssignment

Fires before changing of a server locator.

property OnServerLocatorAssignment:

Parameters

Holds the parameters to pass when launching the server if the StartServer property is set to true.

property Parameters: string read write

ProbeFrequency

Sets at what intervals, in milliseconds, the channel will probe the servers configured in ServerLocators for availability. The default value is 60,000 (60 seconds). See the ProbeServers property for a more detailed description. Although somewhat misnamed, this property defines the Interval between probes, not the actual probing Frequency. The property name is persisted for backward compatibility.

property ProbeFrequency:

ProbeServers

Toggles whether the channel will continuously probe the servers configured in ServerLocators for availability. If enabled (true), the channel will ping all servers at a regular interval to determine if they are reachable. If a server fails to respond, it will be disabled for future calls until a later probe can reach it again. The interval between probes can be configured using the ProbeFrequency property. By default, server probing is turned off.

property ProbeServers:

ServerID

Defines the unique ID of the server to call. This must match the ServerID specified on the TRONamedPipeServer in the server application.

property ServerID: string read write

ServerLocators

Optionally, this collection property can be filled to contain a list of possible servers to be used for fail-over or load balancing purposes. Depending on the settings configured in DispatchOptions, the channel will automatically spread calls over the available servers, or fall back to another server if one fails.

property ServerLocators:

StartServer

Toggles whether the server should automatically be started by launching the executable specified in FileName, if it's not already running.

property StartServer: boolean read write

SynchronizedProbing

Determines whether server probing happens in the context of the main VCL thread (true, default) or in a background worker thread. See the ProbeServers property for a more detailed description.

property SynchronizedProbing:

TargetUri    (declared in TROTransportChannel)

Target URI

property TargetUri: TROUri read write

TargetUrl  protected    (declared in TROTransportChannel)

The address of the server.

property TargetUrl: string read write

ThreadSafe  protected    (declared in TROTransportChannel)

property ThreadSafe: Boolean read write

 

ChannelMatchingTargetUri    (declared in TROTransportChannel)

Creates a client channel instance with type, target host and target port matching the provided target Uri. F.e. for provided uri supertcp://192.168.1.100:7020/bin this method will return an instance of the Super Tcp channel with target host set to 192.168.1.100 and port set to 7020.

class function ChannelMatchingTargetUri(const aUri: TROUri): TROTransportChannel

Parameters:

  • aUri: Server Uri

ChannelMatchingTargetUrl    (declared in TROTransportChannel)

class function ChannelMatchingTargetUrl(const aUrl: string): TROTransportChannel

Parameters:

  • aUrl:

 

constructor Create  override

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

Assign  override    (declared in TROTransportChannel)

Copies the contents of another, similar object.

procedure Assign(aSource: TPersistent)

Parameters:

  • aSource: Instance whose properties will be copied

AssignEvents  protected virtual    (declared in TROTransportChannel)

Copies the events of another, similar object.

procedure AssignEvents(aSource: TROTransportChannel)

Parameters:

  • aSource:

AssignSpecificProperties  protected override

Copies the specific properties of another, similar object.

procedure AssignSpecificProperties(aSource: TROTransportChannel)

Parameters:

  • aSource:

AsyncException  protected virtual    (declared in TROTransportChannel)

Notifies about an exception in an asynchronous mode.

procedure AsyncException(aAsyncInterface: IROAsyncInterface; AsyncException: Exception)

Parameters:

  • aAsyncInterface: Exception source
  • AsyncException: Exception data

BeforeDispatch  protected override

Allows an implimentation to do necessary preparatory actions (checking the readiness of the channel, restore session data, etc.).

procedure BeforeDispatch(aMessage: IROMessage)

Parameters:


CallbackEvents  protected    (declared in TROBaseActiveEventChannel)

Sends event to each registered IROEventReceiver

procedure CallbackEvents(aData: TStream; aThread: TThread)

Parameters:

  • aData: Data stream
  • aThread: Working thread to process the event

ChangeServerLocator  protected virtual    (declared in TROTransportChannel)

procedure ChangeServerLocator(var faultstartlocatoridx: integer; var aRetry: Boolean; const aException: Exception)

Parameters:

  • faultstartlocatoridx:
  • aRetry:
  • aException:

CheckProperties  override

Validates channel properties

procedure CheckProperties

DecryptStream (TStream)  protected overload    (declared in TROBaseConnection)

procedure DecryptStream(const iStream: TStream)

Parameters:

  • iStream:

DecryptStream (TStream, TStream)  protected overload    (declared in TROBaseConnection)

procedure DecryptStream(const aSource: TStream; const aDest: TStream)

Parameters:

  • aSource:
  • aDest:

Dispatch (IROMessage)  protected reintroduce overload    (declared in TROTransportChannel)

Sends a request message through the Self channel for processing and gets back an aMessage. CodeGen uses this method when generating a [proxy](http://docs.rosdk.com/Understanding_the_Client_Side_(.NET_and_Delphi)#How does it work?) from RODL Files.

procedure Dispatch(aMessage: IROMessage)

Parameters:

  • aMessage: (In/out) message data

DoAfterProbingServerEvent  protected virtual    (declared in TROTransportChannel)

Fires OnAfterProbingServer event

procedure DoAfterProbingServerEvent(const aServerLocator: TROServerLocator; const Failed: Boolean)

Parameters:

  • aServerLocator: Server locator
  • Failed:

DoAfterProbingServersEvent  protected virtual    (declared in TROTransportChannel)

Fires OnAfterProbingServers event

procedure DoAfterProbingServersEvent(const ProbedCount: integer; const EnabledCount: integer; const DisabledCount: integer)

Parameters:

  • ProbedCount:
  • EnabledCount:
  • DisabledCount:

DoBeforeDecryptEvent  protected virtual    (declared in TROBaseConnection) obsolete

procedure DoBeforeDecryptEvent(aEncryptedStream: TStream)

Parameters:

  • aEncryptedStream:

DoBeforeProbingServerEvent  protected virtual    (declared in TROTransportChannel)

Fires OnBeforeProbingServer event

procedure DoBeforeProbingServerEvent(const aServerLocator: TROServerLocator)

Parameters:

  • aServerLocator: Server locator

DoBeforeProbingServersEvent  protected virtual    (declared in TROTransportChannel)

Fires OnBeforeProbingServers event

procedure DoBeforeProbingServersEvent

DoDecryption  virtual    (declared in TROBaseConnection) obsolete

procedure DoDecryption(iCipherText: TStream; iPlainText: TStream)

Parameters:

  • iCipherText:
  • iPlainText:

DoEncryption  virtual    (declared in TROBaseConnection) obsolete

procedure DoEncryption(iPlainText: TStream; iCipherText: TStream)

Parameters:

  • iPlainText:
  • iCipherText:

DoException  protected virtual    (declared in TROTransportChannel)

Fires OnException event

procedure DoException(anException: Exception; var aRetry: Boolean)

Parameters:

  • anException:
  • aRetry:

DoReceiveStreamEvent  protected virtual    (declared in TROTransportChannel)

Fires OnReceiveStream event

procedure DoReceiveStreamEvent(const aStream: TStream)

Parameters:

  • aStream: Stream

DoSendStreamEvent  protected virtual    (declared in TROTransportChannel)

Fires OnSendStream event

procedure DoSendStreamEvent(const aStream: TStream)

Parameters:

  • aStream: Stream

DoServerLocatorAssignmentEvent  protected virtual    (declared in TROTransportChannel)

Fires OnServerLocatorAssignment event

procedure DoServerLocatorAssignmentEvent(const aLocator: TROServerLocator; const aException: Exception)

Parameters:

  • aLocator:
  • aException:

EncryptStream (TStream)  protected overload    (declared in TROBaseConnection)

Encrypts given stream

procedure EncryptStream(const iStream: TStream)

Parameters:

  • iStream: Source and Destination

EncryptStream (TStream, TStream)  protected overload    (declared in TROBaseConnection)

Encrypts given stream

procedure EncryptStream(const aSource: TStream; const aDest: TStream)

Parameters:

  • aSource: Source
  • aDest: Destination

GetTransportObject  protected override

Returns itself.

function GetTransportObject: TObject

InitServerLocator  protected virtual    (declared in TROTransportChannel)

Sets CurrentLocator

function InitServerLocator: Integer

IsEncryptionUsed  protected    (declared in TROBaseConnection)

function IsEncryptionUsed: Boolean

isStreamEncrypted  protected    (declared in TROBaseConnection)

Checks state of stream

function isStreamEncrypted(aStream: TStream): Boolean

Parameters:

  • aStream: Stream

LaunchAsyncTask  protected    (declared in TROTransportChannel)

procedure LaunchAsyncTask(aRequest: IROAsyncRequest)

Parameters:

  • aRequest:

OpenServer  protected

procedure OpenServer

Probe  protected    (declared in TROTransportChannel)

Checks the accessibility of servers from the ServerLocators. This method is intended to provide fail-over and load balancing support in the Remoting SDK Architecture.

function Probe(aServerLocator: TROServerLocator): boolean

Parameters:

  • aServerLocator: Server locator

ProbeAll  protected    (declared in TROTransportChannel)

Checks the availability of all known servers.

procedure ProbeAll

RegisterEventReceiver  protected override

Registers a new event receiver object aReceiver in the specified channel. This procedure is needed to further use the aReceiver as receiver for callback events.

procedure RegisterEventReceiver(aReceiver: IROEventReceiver)

Parameters:

  • aReceiver: the event receiver that should be registered.

ResetProbingClone  protected virtual    (declared in TROTransportChannel)

Resets channel that is used for probing

procedure ResetProbingClone(aProbe: TROTransportChannel)

Parameters:

  • aProbe: Probing clone

RetrieveMetadata  protected virtual    (declared in TROTransportChannel)

Retrieves metadata from server

procedure RetrieveMetadata(out Metadata: TStream)

Parameters:

  • Metadata: Destination stream

RetrieveRODL  protected    (declared in TROTransportChannel)

This method is used for to obtaining the RODL library from the server without havin to rely on a channel-specific mechanism (such as a HTTP request to http://servername:port/rodl).

procedure RetrieveRODL(out RODLLibrary: TRODLLibrary)

Parameters:

  • RODLLibrary: Result

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

SetAsyncBusy  protected virtual    (declared in TROTransportChannel)

procedure SetAsyncBusy(const Value: Boolean)

Parameters:

  • Value:

SetServerLocator  protected    (declared in TROTransportChannel)

Retrieves the location details of a server from aServerLocator.

procedure SetServerLocator(aServerLocator: TROServerLocator; anException: Exception)

Parameters:

  • aServerLocator: Configuration data of the server
  • anException: Exception

TriggerProgress  protected virtual    (declared in TROTransportChannel)

Fires OnProgress event

procedure TriggerProgress(iType: TProgressType; iDirection: TProgressDirection; iTransfered: integer; iTotal: integer)

Parameters:

  • iType: progress type
  • iDirection: direction
  • iTransfered: transfered bytes
  • iTotal: total bytes

UnregisterEventReceiver  protected override

Unregisters the specified IROEventReceiver aReceiver in the specified channel.

procedure UnregisterEventReceiver(aReceiver: IROEventReceiver)

Parameters:

  • aReceiver: The event receiver that should be unregistered.

UnregisterEventReceivers  protected    (declared in TROBaseActiveEventChannel)

Unregisters the all event receivers in the specified channel.

procedure UnregisterEventReceivers

 

OnAfterEncrypt    (declared in TROBaseConnection)

property OnAfterEncrypt: TROBaseConnectionOperation read write
delegate: procedure OnAfterEncrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

OnAfterProbingServer    (declared in TROTransportChannel)

Fires after the channel is done probing a specific server for availability. You can use this event to check the result of the probing, possibly to update internal data structures or to display server status in the user interface.

property OnAfterProbingServer: TROEndProbeServerEvent read write
delegate: procedure OnAfterProbingServer(Sender: TROTransportChannel; aServerLocator: TROServerLocator; Failed: boolean)

OnAfterProbingServers    (declared in TROTransportChannel)

Fires after the channel is done probing all servers for availability. You can use this event to check the result of the probing, possibly to update internal data structures or to display server status in the user interface.

property OnAfterProbingServers: TROEndProbeServersEvent read write
delegate: procedure OnAfterProbingServers(Sender: TROTransportChannel; ProbedCount: integer; EnabledCount: integer; DisabledCount: integer)

OnAsyncException    (declared in TROTransportChannel)

Fires when exception is raised in asynchronous mode

property OnAsyncException: TROAsyncExceptionEvent read write
delegate: procedure OnAsyncException(Sender: TROTransportChannel; Async: IROAsyncInterface; anException: Exception)

OnBeforeDecrypt    (declared in TROBaseConnection)

property OnBeforeDecrypt: TROBaseConnectionOperation read write
delegate: procedure OnBeforeDecrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

OnBeforeProbingServer    (declared in TROTransportChannel)

Fires before the channel starts probing a specific server for availability. You can use this event to: * check or adjust the server configuration * to include/exclude the server from being probed by changing the TROServerLocator property.

property OnBeforeProbingServer: TROBeginProbeServerEvent read write
delegate: procedure OnBeforeProbingServer(Sender: TROTransportChannel; aServerLocator: TROServerLocator)

OnBeforeProbingServers    (declared in TROTransportChannel)

Fires before the channel starts probing all servers for availability. You can use this event: * to check or adjust the server configurations * to include/exclude individual server from being probed by changing their TROServerLocator properties.

property OnBeforeProbingServers: TROBeginProbeServersEvent read write
delegate: procedure OnBeforeProbingServers(Sender: TROTransportChannel)

OnException    (declared in TROTransportChannel)

Fires if an exception is raised during the execution of a remote request. This could be an exception returned from the server, a communication problem or an error within the client. Depending on the type of error, your event handler can try to rectify the problem, and set aRetry to true to have the channel try and perform the request again. For example, an application could show a dialog asking the user to confirm if his internet connection is available, with Cancel and Retry buttons.
If aRetry is set to true and the call succeeds at the second attempt, the call will return to the original code that initiated the request, as if the exception never happened.

property OnException: TROExceptionEvent read write
delegate: procedure OnException(Sender: TROTransportChannel; anException: Exception; var aRetry: Boolean)

OnLoginNeeded    (declared in TROTransportChannel)

Fires if an EROSessionNotFound (or the descendant SessionNotFoundException) exception is raised during the execution of a remote request. This usually indicates that the server cannot authenticate the client or that the session has expired. The most common use for this event is to perform a call to a special Login service provided by the server (possibly after prompting the user to enter username and password), and to set the aRetry parameter to true if login was successful.

property OnLoginNeeded: TROExceptionEvent read write
delegate: procedure OnLoginNeeded(Sender: TROTransportChannel; anException: Exception; var aRetry: Boolean)

OnProgress    (declared in TROTransportChannel)

This event fires as the channel is transferring data for a request or response to or from the server, informing of the current progress. It can be used to keep the user interface updated during lengthy transfers,e.g. by showing a progress bar or the remaining transfer volume. Note: the accuracy and frequency of calls to OnProgress depends on the channel type; since channels transport data packets in different sized chunks (or even all-at-once), OnProgress might show a very fine progress for some channels, while jumping from 0 to 100% in one step with others.

property OnProgress: TProgressEvent read write
delegate: procedure OnProgress(iSender: TObject; iType: TProgressType; iDirection: TProgressDirection; iTransferred: integer; iTotal: integer)

OnReceiveStream    (declared in TROTransportChannel)

Fires after a stream with a response message has been received from the server. Use this event handler to inspect and possibly modify the stream, before it continues to be processed by the higher levels of the Remoting SDK framework.

property OnReceiveStream: TStreamDispatch read write
delegate: procedure OnReceiveStream(aStream: TStream)

OnSendStream    (declared in TROTransportChannel)

Fires just as a stream with a request message will be sent to the server. The event handler can inspect and possibly modify the stream, before it continues to be sent off to the server.

property OnSendStream: TStreamDispatch read write
delegate: procedure OnSendStream(aStream: TStream)

OnServerLocatorAssignment    (declared in TROTransportChannel)

Fires before changing of a server locator.

property OnServerLocatorAssignment: TServerLocatorAssignment read write
delegate: procedure OnServerLocatorAssignment(Sender: TROTransportChannel; aLocator: TROServerLocator; aException: Exception)

See Also