TROSynapseSuperTCPChannel

Overview

This class is the Synapse based implementation of the client part of Super TCP Channel for Delphi. More info about SuperTCP client channel methods and properties is available on the base class TROBaseSuperTCPChannel description page.
Use this class if it is necessary to connect to any SuperTCP server and Synapse is the preferred low level communication library.

Location

 

constructor Create  override    (declared in TROBaseSuperTCPChannel)

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

AckWaitTimeout    (declared in TROBaseSuperTCPChannel)

Defines the time frame, in milliseconds, within which an "acknowledgement" message is expected to be received for a sent request (default is 10000, i.e. 10 seconds). If no acknowledgement has been received after the specified time, delivery will be considered to have failed.

property AckWaitTimeout: Integer read write

Active    (declared in TROBaseSuperChannel)

Allows to get channel's activity state, whether the channel active i.e. attempts to connect or already connected. Allows to activate and deactivate the channel.

property Active: Boolean read write

Assign  override    (declared in TROBaseSuperTCPChannel)

Copies the contents of another, similar object.

procedure Assign(aSource: TPersistent)

Parameters:

  • aSource: Instance whose properties will be copied

AssignEvents  protected override    (declared in TROBaseSuperChannel)

Copies the events of another, similar object.

procedure AssignEvents(aSource: TROTransportChannel)

Parameters:

  • aSource:

AssignSpecificProperties  protected override    (declared in TROBaseSuperTCPChannel)

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

AutoReconnect    (declared in TROBaseSuperTCPChannel)

Specifies whether to use auto reconnect feature if the specified server is not available.

property AutoReconnect:

AutoReconnectBehavior    (declared in TROBaseSuperTCPChannel)

Controls the auto-reconnect behavior, if enabled. For possible auto-reconnect modes see TROSCAutoReconnectBehavior enum.

property AutoReconnectBehavior:

BaseSuperConnection  protected    (declared in TROBaseSuperTCPChannel)

Returns TROBaseSuperConnection that was created with CreateBaseSuperConnection

property BaseSuperConnection: TROBaseSuperConnection read write

BeforeDispatch  protected override    (declared in TROBaseSuperChannel)

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 override    (declared in TROBaseSuperChannel)

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  virtual    (declared in TROTransportChannel)

Validates channel properties

procedure CheckProperties

CheckStatus  protected    (declared in TROBaseSuperChannel)

Indicates whether an answer is received after an InvokeRequest.

function CheckStatus(const iMessageID: string): Boolean

Parameters:

  • iMessageID: Value of the previously called InvokeRequest result

Client

Provides read-only access to underlying Synapse TCP client socket object.

property Client: TTCPBlockSocket read write

ClientId    (declared in TROBaseSuperTCPChannel)

Contains the Client ID. Client IDs are used by the Remoting SDK for Session Management and to uniquely identify individual client on the server, for example by the Per-Client Class Factory or in your own custom code. Generally, you will not need to assign or read this value; the framework will automatically create a new unique client ID whenever a message object is instantiated on the client. However, you do have the option to read and write the ClientID property manually, for example to persist a specific client ID between shutdown and restart of your application.

property ClientId: TGUID read write

Connected    (declared in TROBaseSuperChannel)

Returns true if the channel is connected to the server.

property Connected: Boolean read write

ConnectEvent    (declared in TROBaseSuperChannel)

property ConnectEvent: TROEvent read write

ConnectionWaitTimeout    (declared in TROBaseSuperTCPChannel)

The timeout to establish connection to the server. Expressed in milliseconds, the default value is 10000 (10 sec).

property ConnectionWaitTimeout:

ConnectTimeout    (declared in TROBaseSuperChannel)

The same as above.

property ConnectTimeout: Integer read write

CreateBaseSuperConnection  protected override

This method is overriden to create a Synapse based connection object when necessary.

function CreateBaseSuperConnection: TROBaseSuperConnection

CreateWorkerThread  protected override    (declared in TROBaseSuperTCPChannel)

function CreateWorkerThread: TThread

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:

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    (declared in TROBaseSuperChannel)

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 override    (declared in TROBaseSuperChannel)

Fires OnAfterProbingServer event

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

Parameters:

  • aServerLocator: Server locator
  • Failed:

DoAfterProbingServersEvent  protected override    (declared in TROBaseSuperChannel)

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 override    (declared in TROBaseSuperChannel)

Fires OnBeforeProbingServer event

procedure DoBeforeProbingServerEvent(const aServerLocator: TROServerLocator)

Parameters:

  • aServerLocator: Server locator

DoBeforeProbingServersEvent  protected override    (declared in TROBaseSuperChannel)

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:

DoIdle  protected    (declared in TROBaseSuperTCPChannel)

This method is executed when the channel enters idle state: existing connection is disconnected and a new one is not established yet.

procedure DoIdle

DoReceiveStreamEvent  protected override    (declared in TROBaseSuperChannel)

Fires OnReceiveStream event

procedure DoReceiveStreamEvent(const aStream: TStream)

Parameters:

  • aStream: Stream

DoSendStreamEvent  protected override    (declared in TROBaseSuperChannel)

Fires OnSendStream event

procedure DoSendStreamEvent(const aStream: TStream)

Parameters:

  • aStream: Stream

DoServerLocatorAssignmentEvent  protected override    (declared in TROBaseSuperChannel)

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

EventThreadPool    (declared in TROBaseSuperChannel)

Refers to the TROThreadPool instance to provide a thread pool to execute event handling routines on. If the thread pool is not set explicitly it is created autromatically upon access.

property EventThreadPool: TROThreadPool read write

FaultToleranceLocatorIdx    (declared in TROTransportChannel)

property FaultToleranceLocatorIdx: integer read write

FindWaitingRequest  protected    (declared in TROBaseSuperChannel)

function FindWaitingRequest(aList: TList<TROWaitingRequest>; aId: Integer): TROWaitingRequest

Parameters:

  • aList:
  • aId:

GetStrippedTargetUrl  protected virtual    (declared in TROBaseSuperChannel)

function GetStrippedTargetUrl: string

GetTransportObject  protected override    (declared in TROBaseSuperChannel)

Returns itself.

function GetTransportObject: TObject

HasData  protected    (declared in TROBaseSuperChannel)

This method is called when incoming data is present.

procedure HasData(Id: Integer; aData: TStream)

Parameters:

  • Id:
  • aData:

Host    (declared in TROBaseSuperTCPChannel)

Specifies the address of the server to talk to. This can be a host name or an IP address.

property Host: string read write

IdleTimeoutMinutes    (declared in TROBaseSuperTCPChannel)

Specifies of time frame of inactivity when the connection to server will be closed

property IdleTimeoutMinutes: Integer read write

IgnoreSSL

property IgnoreSSL: Boolean read write

InDestroyingState  protected    (declared in TROBaseSuperChannel)

Returns current state

function InDestroyingState: Boolean

InitialConnect  protected    (declared in TROBaseSuperChannel)

function InitialConnect: Boolean

InitServerLocator  protected override    (declared in TROBaseSuperChannel)

Sets CurrentLocator

function InitServerLocator: Integer

InitWorkerThread  protected    (declared in TROBaseSuperChannel)

procedure InitWorkerThread

InvokeRequest  protected    (declared in TROBaseSuperChannel)

Invokes a request in async mode. The returned string is used in the CheckStatus invocation.

function InvokeRequest(aRequest: TStream; iGetResponse: boolean): string

Parameters:

  • aRequest: Request data
  • iGetResponse: Indicates whether a response to this request is expected

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

MaxPackageSize    (declared in TROBaseSuperChannel)

Sets the maximum size for data packages that the channel will transport (default is 10485760, 10 MB).

property MaxPackageSize: 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    (declared in TROBaseSuperChannel)

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    (declared in TROBaseSuperChannel)

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    (declared in TROBaseSuperChannel)

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    (declared in TROBaseSuperChannel)

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:

OnConnected    (declared in TROBaseSuperChannel)

Fires when channel is connected to server

property OnConnected: TNotifyEvent read write

OnConnected    (declared in TROBaseSuperTCPChannel)

Fires when channel is connected to server

property OnConnected:

OnDisconnected    (declared in TROBaseSuperChannel)

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

property OnDisconnected: TNotifyEvent read write

OnDisconnected    (declared in TROBaseSuperTCPChannel)

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

property OnDisconnected:

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    (declared in TROBaseSuperChannel)

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)

OnProgress    (declared in TROBaseSuperChannel)

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:

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    (declared in TROBaseSuperChannel)

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    (declared in TROBaseSuperChannel)

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    (declared in TROBaseSuperChannel)

Fires before changing of a server locator.

property OnServerLocatorAssignment:

PingSecs    (declared in TROBaseSuperTCPChannel)

Specifies ping interval. Should be in interval from 10 up to 60.

property PingSecs: Integer read write

Port    (declared in TROBaseSuperTCPChannel)

Specifies the port number where the server is listening (default for the Remoting SDK TCP servers is 8095).

property Port: Integer 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    (declared in TROBaseSuperChannel)

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    (declared in TROBaseSuperChannel)

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:

ProcessEvent  protected    (declared in TROBaseSuperChannel)

procedure ProcessEvent(aData: TStream)

Parameters:

  • aData:

ReconnectDelay    (declared in TROBaseSuperTCPChannel)

The time interval to pass between reconnect attempts, in millisecnds. The default is 500 (0.5 second).

property ReconnectDelay:

ReconnectEvent    (declared in TROBaseSuperChannel)

property ReconnectEvent: TROEvent read write

RegisterEventReceiver  protected virtual    (declared in TROBaseActiveEventChannel)

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.

RequestTimeout    (declared in TROBaseSuperChannel)

The timeout to complete the remote request on the server. Expressed in milliseconds, the default value is 60000 (60 sec). All requests that last longer than the timeout specified are considered failed.

property RequestTimeout: Integer read write

ResetProbingClone  protected override    (declared in TROBaseSuperChannel)

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

RetrieveResponse  protected    (declared in TROBaseSuperChannel)

Retrieves a response.

procedure RetrieveResponse(const iMessageID: string; aResponse: TStream)

Parameters:

  • iMessageID: Id of a waiting response
  • aResponse: Response data

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

ROActiveAsyncTransportChannel_InvokeRequest  protected override    (declared in TROBaseSuperTCPChannel)

function ROActiveAsyncTransportChannel_InvokeRequest(aRequest: TStream; aGetResponse: Boolean; aEvent: TROEvent): string

Parameters:

  • aRequest:
  • aGetResponse:
  • aEvent:

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

ServerLocators    (declared in TROBaseSuperChannel)

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:

SessionId  protected    (declared in TROBaseSuperChannel)

The unique identifier of the current session on the server. The same as ClientId.

property SessionId: TGUID read write

SetAsyncBusy  protected override    (declared in TROBaseSuperChannel)

procedure SetAsyncBusy(const Value: Boolean)

Parameters:

  • Value:

SetConnectedState  protected    (declared in TROBaseSuperChannel)

procedure SetConnectedState

SetInactive  protected virtual    (declared in TROBaseSuperChannel)

procedure SetInactive

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

SkipAck    (declared in TROBaseSuperTCPChannel)

Defines whether "acknowledgement" messages are skipped.

property SkipAck: Boolean read write

StoreActive    (declared in TROBaseSuperChannel)

Controls whether the Active property value is stored in the dfm file.

property StoreActive: Boolean read write

SuperChannel_RaiseError  protected override    (declared in TROBaseSuperTCPChannel)

procedure SuperChannel_RaiseError(ACode: Integer)

Parameters:

  • ACode:

SynchronizedProbing    (declared in TROBaseSuperChannel)

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:

SynchronizeEvents    (declared in TROBaseSuperChannel)

According to the superchannel nature every remote request is processed using it's own background thread. This property controls on which thread to execute the event handlers for events connected with each remote request. If the property is set to true than all event handlers are executed on the main application thread, otherwise they are executed on the request's background thread.
WARNING: This property has no effect on OnSendSream and OnReceiveStream events, they are alway executed on background threads.

property SynchronizeEvents: Boolean read write

TargetUri    (declared in TROTransportChannel)

Target URI

property TargetUri: TROUri read write

TargetUrl    (declared in TROBaseSuperChannel)

The address of the server.

property TargetUrl:

TerminateWorkerThread  protected    (declared in TROBaseSuperChannel)

procedure TerminateWorkerThread

ThreadSafe  protected    (declared in TROTransportChannel)

property ThreadSafe: Boolean read write

TriggerProgress  protected override    (declared in TROBaseSuperChannel)

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 virtual    (declared in TROBaseActiveEventChannel)

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

WaitForActive    (declared in TROBaseSuperChannel)

procedure WaitForActive(const Timeout: Integer)

Parameters:

  • Timeout:

WaitingRequests  protected    (declared in TROBaseSuperChannel)

Internal storage of remote requests awaiting for response.

property WaitingRequests: TThreadList<TROWaitingRequest> read write

WorkerThread  protected    (declared in TROBaseSuperChannel)

Internal background threads management property.

property WorkerThread: TThread read write

 

AckWaitTimeout    (declared in TROBaseSuperTCPChannel)

Defines the time frame, in milliseconds, within which an "acknowledgement" message is expected to be received for a sent request (default is 10000, i.e. 10 seconds). If no acknowledgement has been received after the specified time, delivery will be considered to have failed.

property AckWaitTimeout: Integer read write

Active    (declared in TROBaseSuperChannel)

Allows to get channel's activity state, whether the channel active i.e. attempts to connect or already connected. Allows to activate and deactivate the channel.

property Active: Boolean read write

AutoReconnect    (declared in TROBaseSuperTCPChannel)

Specifies whether to use auto reconnect feature if the specified server is not available.

property AutoReconnect:

AutoReconnectBehavior    (declared in TROBaseSuperTCPChannel)

Controls the auto-reconnect behavior, if enabled. For possible auto-reconnect modes see TROSCAutoReconnectBehavior enum.

property AutoReconnectBehavior:

BaseSuperConnection  protected    (declared in TROBaseSuperTCPChannel)

Returns TROBaseSuperConnection that was created with CreateBaseSuperConnection

property BaseSuperConnection: TROBaseSuperConnection 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

Client

Provides read-only access to underlying Synapse TCP client socket object.

property Client: TTCPBlockSocket read write

ClientId    (declared in TROBaseSuperTCPChannel)

Contains the Client ID. Client IDs are used by the Remoting SDK for Session Management and to uniquely identify individual client on the server, for example by the Per-Client Class Factory or in your own custom code. Generally, you will not need to assign or read this value; the framework will automatically create a new unique client ID whenever a message object is instantiated on the client. However, you do have the option to read and write the ClientID property manually, for example to persist a specific client ID between shutdown and restart of your application.

property ClientId: TGUID read write

Connected    (declared in TROBaseSuperChannel)

Returns true if the channel is connected to the server.

property Connected: Boolean read write

ConnectionWaitTimeout    (declared in TROBaseSuperTCPChannel)

The timeout to establish connection to the server. Expressed in milliseconds, the default value is 10000 (10 sec).

property ConnectionWaitTimeout:

ConnectTimeout    (declared in TROBaseSuperChannel)

The same as above.

property ConnectTimeout: Integer 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

DispatchOptions    (declared in TROBaseSuperChannel)

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

EventThreadPool    (declared in TROBaseSuperChannel)

Refers to the TROThreadPool instance to provide a thread pool to execute event handling routines on. If the thread pool is not set explicitly it is created autromatically upon access.

property EventThreadPool: TROThreadPool read write

FaultToleranceLocatorIdx    (declared in TROTransportChannel)

property FaultToleranceLocatorIdx: integer read write

Host    (declared in TROBaseSuperTCPChannel)

Specifies the address of the server to talk to. This can be a host name or an IP address.

property Host: string read write

IdleTimeoutMinutes    (declared in TROBaseSuperTCPChannel)

Specifies of time frame of inactivity when the connection to server will be closed

property IdleTimeoutMinutes: Integer read write

IgnoreSSL

property IgnoreSSL: Boolean 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

MaxPackageSize    (declared in TROBaseSuperChannel)

Sets the maximum size for data packages that the channel will transport (default is 10485760, 10 MB).

property MaxPackageSize: Integer read write

OnAfterProbingServer    (declared in TROBaseSuperChannel)

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

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    (declared in TROBaseSuperChannel)

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

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:

OnConnected    (declared in TROBaseSuperTCPChannel)

Fires when channel is connected to server

property OnConnected:

OnDisconnected    (declared in TROBaseSuperTCPChannel)

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

property OnDisconnected:

OnLoginNeeded    (declared in TROBaseSuperChannel)

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

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:

OnReceiveStream    (declared in TROBaseSuperChannel)

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

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

Fires before changing of a server locator.

property OnServerLocatorAssignment:

PingSecs    (declared in TROBaseSuperTCPChannel)

Specifies ping interval. Should be in interval from 10 up to 60.

property PingSecs: Integer read write

Port    (declared in TROBaseSuperTCPChannel)

Specifies the port number where the server is listening (default for the Remoting SDK TCP servers is 8095).

property Port: Integer read write

ProbeFrequency    (declared in TROBaseSuperChannel)

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    (declared in TROBaseSuperChannel)

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:

ReconnectDelay    (declared in TROBaseSuperTCPChannel)

The time interval to pass between reconnect attempts, in millisecnds. The default is 500 (0.5 second).

property ReconnectDelay:

RequestTimeout    (declared in TROBaseSuperChannel)

The timeout to complete the remote request on the server. Expressed in milliseconds, the default value is 60000 (60 sec). All requests that last longer than the timeout specified are considered failed.

property RequestTimeout: Integer read write

ServerLocators    (declared in TROBaseSuperChannel)

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:

SessionId  protected    (declared in TROBaseSuperChannel)

The unique identifier of the current session on the server. The same as ClientId.

property SessionId: TGUID read write

SkipAck    (declared in TROBaseSuperTCPChannel)

Defines whether "acknowledgement" messages are skipped.

property SkipAck: Boolean read write

StoreActive    (declared in TROBaseSuperChannel)

Controls whether the Active property value is stored in the dfm file.

property StoreActive: Boolean read write

SynchronizedProbing    (declared in TROBaseSuperChannel)

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:

SynchronizeEvents    (declared in TROBaseSuperChannel)

According to the superchannel nature every remote request is processed using it's own background thread. This property controls on which thread to execute the event handlers for events connected with each remote request. If the property is set to true than all event handlers are executed on the main application thread, otherwise they are executed on the request's background thread.
WARNING: This property has no effect on OnSendSream and OnReceiveStream events, they are alway executed on background threads.

property SynchronizeEvents: Boolean read write

TargetUri    (declared in TROTransportChannel)

Target URI

property TargetUri: TROUri read write

TargetUrl    (declared in TROBaseSuperChannel)

The address of the server.

property TargetUrl:

ThreadSafe  protected    (declared in TROTransportChannel)

property ThreadSafe: Boolean read write

WaitingRequests  protected    (declared in TROBaseSuperChannel)

Internal storage of remote requests awaiting for response.

property WaitingRequests: TThreadList<TROWaitingRequest> read write

WorkerThread  protected    (declared in TROBaseSuperChannel)

Internal background threads management property.

property WorkerThread: TThread 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    (declared in TROBaseSuperTCPChannel)

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

Assign  override    (declared in TROBaseSuperTCPChannel)

Copies the contents of another, similar object.

procedure Assign(aSource: TPersistent)

Parameters:

  • aSource: Instance whose properties will be copied

AssignEvents  protected override    (declared in TROBaseSuperChannel)

Copies the events of another, similar object.

procedure AssignEvents(aSource: TROTransportChannel)

Parameters:

  • aSource:

AssignSpecificProperties  protected override    (declared in TROBaseSuperTCPChannel)

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    (declared in TROBaseSuperChannel)

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 override    (declared in TROBaseSuperChannel)

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

Parameters:

  • faultstartlocatoridx:
  • aRetry:
  • aException:

CheckProperties  virtual    (declared in TROTransportChannel)

Validates channel properties

procedure CheckProperties

CheckStatus  protected    (declared in TROBaseSuperChannel)

Indicates whether an answer is received after an InvokeRequest.

function CheckStatus(const iMessageID: string): Boolean

Parameters:

  • iMessageID: Value of the previously called InvokeRequest result

CreateBaseSuperConnection  protected override

This method is overriden to create a Synapse based connection object when necessary.

function CreateBaseSuperConnection: TROBaseSuperConnection

CreateWorkerThread  protected override    (declared in TROBaseSuperTCPChannel)

function CreateWorkerThread: TThread

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 override    (declared in TROBaseSuperChannel)

Fires OnAfterProbingServer event

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

Parameters:

  • aServerLocator: Server locator
  • Failed:

DoAfterProbingServersEvent  protected override    (declared in TROBaseSuperChannel)

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 override    (declared in TROBaseSuperChannel)

Fires OnBeforeProbingServer event

procedure DoBeforeProbingServerEvent(const aServerLocator: TROServerLocator)

Parameters:

  • aServerLocator: Server locator

DoBeforeProbingServersEvent  protected override    (declared in TROBaseSuperChannel)

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:

DoIdle  protected    (declared in TROBaseSuperTCPChannel)

This method is executed when the channel enters idle state: existing connection is disconnected and a new one is not established yet.

procedure DoIdle

DoReceiveStreamEvent  protected override    (declared in TROBaseSuperChannel)

Fires OnReceiveStream event

procedure DoReceiveStreamEvent(const aStream: TStream)

Parameters:

  • aStream: Stream

DoSendStreamEvent  protected override    (declared in TROBaseSuperChannel)

Fires OnSendStream event

procedure DoSendStreamEvent(const aStream: TStream)

Parameters:

  • aStream: Stream

DoServerLocatorAssignmentEvent  protected override    (declared in TROBaseSuperChannel)

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

FindWaitingRequest  protected    (declared in TROBaseSuperChannel)

function FindWaitingRequest(aList: TList<TROWaitingRequest>; aId: Integer): TROWaitingRequest

Parameters:

  • aList:
  • aId:

GetStrippedTargetUrl  protected virtual    (declared in TROBaseSuperChannel)

function GetStrippedTargetUrl: string

GetTransportObject  protected override    (declared in TROBaseSuperChannel)

Returns itself.

function GetTransportObject: TObject

HasData  protected    (declared in TROBaseSuperChannel)

This method is called when incoming data is present.

procedure HasData(Id: Integer; aData: TStream)

Parameters:

  • Id:
  • aData:

InDestroyingState  protected    (declared in TROBaseSuperChannel)

Returns current state

function InDestroyingState: Boolean

InitialConnect  protected    (declared in TROBaseSuperChannel)

function InitialConnect: Boolean

InitServerLocator  protected override    (declared in TROBaseSuperChannel)

Sets CurrentLocator

function InitServerLocator: Integer

InitWorkerThread  protected    (declared in TROBaseSuperChannel)

procedure InitWorkerThread

InvokeRequest  protected    (declared in TROBaseSuperChannel)

Invokes a request in async mode. The returned string is used in the CheckStatus invocation.

function InvokeRequest(aRequest: TStream; iGetResponse: boolean): string

Parameters:

  • aRequest: Request data
  • iGetResponse: Indicates whether a response to this request is expected

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:

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

ProcessEvent  protected    (declared in TROBaseSuperChannel)

procedure ProcessEvent(aData: TStream)

Parameters:

  • aData:

RegisterEventReceiver  protected virtual    (declared in TROBaseActiveEventChannel)

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 override    (declared in TROBaseSuperChannel)

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

RetrieveResponse  protected    (declared in TROBaseSuperChannel)

Retrieves a response.

procedure RetrieveResponse(const iMessageID: string; aResponse: TStream)

Parameters:

  • iMessageID: Id of a waiting response
  • aResponse: Response data

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

ROActiveAsyncTransportChannel_InvokeRequest  protected override    (declared in TROBaseSuperTCPChannel)

function ROActiveAsyncTransportChannel_InvokeRequest(aRequest: TStream; aGetResponse: Boolean; aEvent: TROEvent): string

Parameters:

  • aRequest:
  • aGetResponse:
  • aEvent:

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 override    (declared in TROBaseSuperChannel)

procedure SetAsyncBusy(const Value: Boolean)

Parameters:

  • Value:

SetConnectedState  protected    (declared in TROBaseSuperChannel)

procedure SetConnectedState

SetInactive  protected virtual    (declared in TROBaseSuperChannel)

procedure SetInactive

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

SuperChannel_RaiseError  protected override    (declared in TROBaseSuperTCPChannel)

procedure SuperChannel_RaiseError(ACode: Integer)

Parameters:

  • ACode:

TerminateWorkerThread  protected    (declared in TROBaseSuperChannel)

procedure TerminateWorkerThread

TriggerProgress  protected override    (declared in TROBaseSuperChannel)

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 virtual    (declared in TROBaseActiveEventChannel)

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

WaitForActive    (declared in TROBaseSuperChannel)

procedure WaitForActive(const Timeout: Integer)

Parameters:

  • Timeout:

 

ConnectEvent    (declared in TROBaseSuperChannel)

property ConnectEvent: TROEvent 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)

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)

OnConnected    (declared in TROBaseSuperChannel)

Fires when channel is connected to server

property OnConnected: TNotifyEvent read write

OnDisconnected    (declared in TROBaseSuperChannel)

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

property OnDisconnected: TNotifyEvent read write

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)

ReconnectEvent    (declared in TROBaseSuperChannel)

property ReconnectEvent: TROEvent read write