TROBaseSuperTCPServer

Overview

TROBaseSuperTCPServer implements the server side of the enhanced TCP based channel, which provides a sophisticated and flexible communication channel that uses persistent connections to enable true asynchronous calls and server callbacks.

TROSuperTCPServer and TROSynapseSuperTCPServer contain implementation of TROBaseSuperTCPServer via Indy and Synapse libraries accordingly.

Location

 

constructor Create  override

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

AckWaitTimeout

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

property AckWaitTimeout: Integer read write

Active    (declared in TROServer)

Toggles whether the server ready to receive requests from clients. Depending on the server type, changing this property might open/close a network socket or otherwise toggle whether the server will process incoming requests.

property Active: boolean read write

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

AutoRegisterSession

This property is used by the server to automatically sign new clients up to the event repository, to make it possible fo them to receive events without manual registration.

property AutoRegisterSession: Boolean read write

BaseSuperServerConnection  protected

Reference to TROBaseSuperServerConnection that was created with CreateBaseSuperServerConnection method

property BaseSuperServerConnection: TROBaseSuperTcpServerConnection read write

BlockingEvents

Affects processing events on the server. Setting BlockingEvents=true can makes delay in dispatching events, in this case dispatching event through clients will happen in the main thread of the server and suspends it. This value is useful however when you want to make sure events arrive in order. If you want possibility to process multiply events at once you should use default value BlockingEvents=false, event is put in the queue and will be dispatched in separate thread. In this case you'll possibly need to control thread pool queue from overflow using ThreadPool.MaxQueue, ThreadPool.MaxThreads properties.

property BlockingEvents: Boolean read write

CheckProperties  virtual    (declared in TROServer)

Validates the server properties.

procedure CheckProperties

CreateBaseSuperServerConnection  protected virtual abstract

Creates TROBaseSuperServerConnection implementation according to used library

function CreateBaseSuperServerConnection: TROBaseSuperTcpServerConnection

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:

DefaultResponse

Holds the message that will be sent back to the client if it improperly "welcomes" the server.

property DefaultResponse:

Dispatchers    (declared in TROServer)

Specifies how incoming requests will be processed and dispatched. Depending on the server type, one or multiple dispatchers can be configured to receive messages from the client. Each dispatcher consists of a Message and an optional Name. Also, each dispatcher can be individually enabled or disabled. Each server must have at least one dispatcher configured, in order to be able to process messages.

=Essential Sub-Properties=

*Message specifies the message format to be used for this dispatcher. *Name specifies the name, or possibly the URL for the dispatcher. In HTTP based servers (such as the TROIndyHTTPServer, the Name will be appended as folder to the server URL allowing the server to make multiple dispatchers available at different URLs.

property Dispatchers: TROMessageDispatchers read write

DispatchMessage (IROTransport, TStream, TStream): boolean  protected overload    (declared in TROServer)

function DispatchMessage(const aTransport: IROTransport; aRequeststream: TStream; aResponsestream: TStream): boolean

Parameters:

  • aTransport:
  • aRequeststream:
  • aResponsestream:

DispatchMessage (IROTransport, TStream, TStream, TROResponseOptions): boolean  protected overload    (declared in TROServer)

function DispatchMessage(const aTransport: IROTransport; aRequeststream: TStream; aResponsestream: TStream; out oResponseOptions: TROResponseOptions): boolean

Parameters:

  • aTransport:
  • aRequeststream:
  • aResponsestream:
  • oResponseOptions:

DoBeforeDecryptEvent  protected virtual    (declared in TROBaseConnection) obsolete

procedure DoBeforeDecryptEvent(aEncryptedStream: TStream)

Parameters:

  • aEncryptedStream:

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:

DoMaxThreadLimitReached  protected

Calls OnMaxThreadLimitReached event

procedure DoMaxThreadLimitReached

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

EventRepository

Specifies the event repository.

property EventRepository: TROEventRepository read write

GetDispatchersClass  protected virtual    (declared in TROServer)

Returns TROMessageDispatchers class

function GetDispatchersClass: TROMessageDispatchersClass

GetRODLReader  protected    (declared in TROServer)

function GetRODLReader: TROCustomRODLReader

GetServerType  protected override

Returns rstSuperTCP. This property is used by the ZeroConf infrastructure.

function GetServerType: TROServerType

GetTransportObject  protected    (declared in TROServer)

Returns itself.

function GetTransportObject: TObject

HasData  protected

This method is called when incoming data is present.

procedure HasData(Id: Integer; aClient: TROSCServerWorker; aData: TStream)

Parameters:

  • Id:
  • aClient:
  • aData:

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

MaxPackageSize

Sets the maximum size of data package that the server will receive (default is 10485760, i.e. 10MB). This is to prevent a larger package than intended from being sent to the server.

property MaxPackageSize: Integer read write

OnAfterEncrypt    (declared in TROBaseConnection)

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

OnAfterServerActivate    (declared in TROServer)

Fires after the server has been activated.

property OnAfterServerActivate: TNotifyEvent read write

OnAfterServerDeactivate    (declared in TROServer)

Fires after the server has been deactivated. You can use this event handler to perform any cleanup you might need after the server has stopped processing new requests.

property OnAfterServerDeactivate: TNotifyEvent read write

OnBeforeChannelDestroy

This event is fired before channel is destroyed.

property OnBeforeChannelDestroy: TROSuperServerEvent read write
delegate: procedure OnBeforeChannelDestroy(aChannel: IROTransport)

OnBeforeDecrypt    (declared in TROBaseConnection)

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

OnBeforeServerActivate    (declared in TROServer)

Fires just before the server is activated. You can use this event handler to perform any initialization you might need before the server starts processing new requests.

property OnBeforeServerActivate: TNotifyEvent read write

OnBeforeServerDeactivate    (declared in TROServer)

Fires just before the server is deactivated. You can use this event handler to perform any cleanup you might need before the server stops processing new requests.

property OnBeforeServerDeactivate: TNotifyEvent read write

OnClientConnected

This event is fired when client connects to the server.

property OnClientConnected: TROConnectionEvent read write
delegate: procedure OnClientConnected(aChannel: IROTransport; const aGuid: TGUID)

OnClientDisconnected

This event is fired when client disconnects from the server.

property OnClientDisconnected: TROConnectionEvent read write
delegate: procedure OnClientDisconnected(aChannel: IROTransport; const aGuid: TGUID)

OnGetRODLReader    (declared in TROServer)

property OnGetRODLReader: TROGetRODLReader read write
delegate: procedure OnGetRODLReader(Sender: TROServer; var aRODLReader: TROCustomRODLReader)

OnMaxThreadLimitReached

Fires when an incoming connection is rejected due to exceed the MaxThreads.

property OnMaxThreadLimitReached: TNotifyEvent read write

OnReadFromStream    (declared in TROServer)

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

property OnReadFromStream: TStreamOperation read write
delegate: procedure OnReadFromStream(aStream: TStream)

OnWriteToStream    (declared in TROServer)

Fires just before a stream with a response message is sent back to the client. The event handler can inspect and possibly modify the stream, before it continues to be sent off to the client.

property OnWriteToStream: TStreamOperation read write
delegate: procedure OnWriteToStream(aStream: TStream)

Port

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

property Port:

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

ServeRodl    (declared in TROServer)

Specifies whether the server will make the contained RODL file available to clients (true, default) or not. Keep this property set to true if clients need to access the RODL (or WSDL), for example so that third parties (including Service Tester) can import services. Set it to false if you do not want to provide this information, for example for security reasons.

property ServeRodl: Boolean read write

SkipAck

Defines whether "acknowledgement" message are skipped.

property SkipAck: Boolean read write

ThreadPool

Allows to set a custom thread pool object to process incoming requests using a set of threads. When not assigned explicitly the thread pool is created and assigned automatically. Assigning this property by users is a rare need, this is required only when precise and/or custom control over processing threads is necessary.

property ThreadPool: TROThreadPool read write

TriggerReadFromStream  protected    (declared in TROServer)

Fires the OnReadFromStream event

procedure TriggerReadFromStream(iStream: TStream)

Parameters:

  • iStream: stream

TriggerWriteToStream  protected    (declared in TROServer)

Fires the OnWriteToStream event

procedure TriggerWriteToStream(iStream: TStream)

Parameters:

  • iStream: stream

 

AckWaitTimeout

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

property AckWaitTimeout: Integer read write

Active    (declared in TROServer)

Toggles whether the server ready to receive requests from clients. Depending on the server type, changing this property might open/close a network socket or otherwise toggle whether the server will process incoming requests.

property Active: boolean read write

AutoRegisterSession

This property is used by the server to automatically sign new clients up to the event repository, to make it possible fo them to receive events without manual registration.

property AutoRegisterSession: Boolean read write

BaseSuperServerConnection  protected

Reference to TROBaseSuperServerConnection that was created with CreateBaseSuperServerConnection method

property BaseSuperServerConnection: TROBaseSuperTcpServerConnection read write

BlockingEvents

Affects processing events on the server. Setting BlockingEvents=true can makes delay in dispatching events, in this case dispatching event through clients will happen in the main thread of the server and suspends it. This value is useful however when you want to make sure events arrive in order. If you want possibility to process multiply events at once you should use default value BlockingEvents=false, event is put in the queue and will be dispatched in separate thread. In this case you'll possibly need to control thread pool queue from overflow using ThreadPool.MaxQueue, ThreadPool.MaxThreads properties.

property BlockingEvents: Boolean read write

DefaultResponse

Holds the message that will be sent back to the client if it improperly "welcomes" the server.

property DefaultResponse:

Dispatchers    (declared in TROServer)

Specifies how incoming requests will be processed and dispatched. Depending on the server type, one or multiple dispatchers can be configured to receive messages from the client. Each dispatcher consists of a Message and an optional Name. Also, each dispatcher can be individually enabled or disabled. Each server must have at least one dispatcher configured, in order to be able to process messages.

=Essential Sub-Properties=

*Message specifies the message format to be used for this dispatcher. *Name specifies the name, or possibly the URL for the dispatcher. In HTTP based servers (such as the TROIndyHTTPServer, the Name will be appended as folder to the server URL allowing the server to make multiple dispatchers available at different URLs.

property Dispatchers: TROMessageDispatchers read write

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

EventRepository

Specifies the event repository.

property EventRepository: TROEventRepository read write

MaxPackageSize

Sets the maximum size of data package that the server will receive (default is 10485760, i.e. 10MB). This is to prevent a larger package than intended from being sent to the server.

property MaxPackageSize: Integer read write

Port

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

property Port:

ServeRodl    (declared in TROServer)

Specifies whether the server will make the contained RODL file available to clients (true, default) or not. Keep this property set to true if clients need to access the RODL (or WSDL), for example so that third parties (including Service Tester) can import services. Set it to false if you do not want to provide this information, for example for security reasons.

property ServeRodl: Boolean read write

SkipAck

Defines whether "acknowledgement" message are skipped.

property SkipAck: Boolean read write

ThreadPool

Allows to set a custom thread pool object to process incoming requests using a set of threads. When not assigned explicitly the thread pool is created and assigned automatically. Assigning this property by users is a rare need, this is required only when precise and/or custom control over processing threads is necessary.

property ThreadPool: TROThreadPool read write

 

constructor Create  override

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

CheckProperties  virtual    (declared in TROServer)

Validates the server properties.

procedure CheckProperties

CreateBaseSuperServerConnection  protected virtual abstract

Creates TROBaseSuperServerConnection implementation according to used library

function CreateBaseSuperServerConnection: TROBaseSuperTcpServerConnection

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:

DispatchMessage (IROTransport, TStream, TStream): boolean  protected overload    (declared in TROServer)

function DispatchMessage(const aTransport: IROTransport; aRequeststream: TStream; aResponsestream: TStream): boolean

Parameters:

  • aTransport:
  • aRequeststream:
  • aResponsestream:

DispatchMessage (IROTransport, TStream, TStream, TROResponseOptions): boolean  protected overload    (declared in TROServer)

function DispatchMessage(const aTransport: IROTransport; aRequeststream: TStream; aResponsestream: TStream; out oResponseOptions: TROResponseOptions): boolean

Parameters:

  • aTransport:
  • aRequeststream:
  • aResponsestream:
  • oResponseOptions:

DoBeforeDecryptEvent  protected virtual    (declared in TROBaseConnection) obsolete

procedure DoBeforeDecryptEvent(aEncryptedStream: TStream)

Parameters:

  • aEncryptedStream:

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:

DoMaxThreadLimitReached  protected

Calls OnMaxThreadLimitReached event

procedure DoMaxThreadLimitReached

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

GetDispatchersClass  protected virtual    (declared in TROServer)

Returns TROMessageDispatchers class

function GetDispatchersClass: TROMessageDispatchersClass

GetRODLReader  protected    (declared in TROServer)

function GetRODLReader: TROCustomRODLReader

GetServerType  protected override

Returns rstSuperTCP. This property is used by the ZeroConf infrastructure.

function GetServerType: TROServerType

GetTransportObject  protected    (declared in TROServer)

Returns itself.

function GetTransportObject: TObject

HasData  protected

This method is called when incoming data is present.

procedure HasData(Id: Integer; aClient: TROSCServerWorker; aData: TStream)

Parameters:

  • Id:
  • aClient:
  • aData:

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

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

TriggerReadFromStream  protected    (declared in TROServer)

Fires the OnReadFromStream event

procedure TriggerReadFromStream(iStream: TStream)

Parameters:

  • iStream: stream

TriggerWriteToStream  protected    (declared in TROServer)

Fires the OnWriteToStream event

procedure TriggerWriteToStream(iStream: TStream)

Parameters:

  • iStream: stream

 

OnAfterEncrypt    (declared in TROBaseConnection)

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

OnAfterServerActivate    (declared in TROServer)

Fires after the server has been activated.

property OnAfterServerActivate: TNotifyEvent read write

OnAfterServerDeactivate    (declared in TROServer)

Fires after the server has been deactivated. You can use this event handler to perform any cleanup you might need after the server has stopped processing new requests.

property OnAfterServerDeactivate: TNotifyEvent read write

OnBeforeChannelDestroy

This event is fired before channel is destroyed.

property OnBeforeChannelDestroy: TROSuperServerEvent read write
delegate: procedure OnBeforeChannelDestroy(aChannel: IROTransport)

OnBeforeDecrypt    (declared in TROBaseConnection)

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

OnBeforeServerActivate    (declared in TROServer)

Fires just before the server is activated. You can use this event handler to perform any initialization you might need before the server starts processing new requests.

property OnBeforeServerActivate: TNotifyEvent read write

OnBeforeServerDeactivate    (declared in TROServer)

Fires just before the server is deactivated. You can use this event handler to perform any cleanup you might need before the server stops processing new requests.

property OnBeforeServerDeactivate: TNotifyEvent read write

OnClientConnected

This event is fired when client connects to the server.

property OnClientConnected: TROConnectionEvent read write
delegate: procedure OnClientConnected(aChannel: IROTransport; const aGuid: TGUID)

OnClientDisconnected

This event is fired when client disconnects from the server.

property OnClientDisconnected: TROConnectionEvent read write
delegate: procedure OnClientDisconnected(aChannel: IROTransport; const aGuid: TGUID)

OnGetRODLReader    (declared in TROServer)

property OnGetRODLReader: TROGetRODLReader read write
delegate: procedure OnGetRODLReader(Sender: TROServer; var aRODLReader: TROCustomRODLReader)

OnMaxThreadLimitReached

Fires when an incoming connection is rejected due to exceed the MaxThreads.

property OnMaxThreadLimitReached: TNotifyEvent read write

OnReadFromStream    (declared in TROServer)

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

property OnReadFromStream: TStreamOperation read write
delegate: procedure OnReadFromStream(aStream: TStream)

OnWriteToStream    (declared in TROServer)

Fires just before a stream with a response message is sent back to the client. The event handler can inspect and possibly modify the stream, before it continues to be sent off to the client.

property OnWriteToStream: TStreamOperation read write
delegate: procedure OnWriteToStream(aStream: TStream)

Descendants

See Also