TROSuperTcpServer

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

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

---

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

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

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

---

Reference to TROBaseSuperServerConnection that was created with CreateBaseSuperServerConnection method

property BaseSuperServerConnection: TROBaseSuperTcpServerConnection read

---

Gets or sets the flag indicating whether the server should listen for IPv4 connections.

Setting this flag doesn't have any immediate effect. Its value is used only when the server is opened (either by setting the Active property to true).

property BindV4: Boolean read write

---

Gets or sets the flag indicating whether the server should listen for IPv6 connections.

Setting this flag doesn't have any immediate effect. Its value is used only when the server is opened (either by setting the Active property to true).

property BindV6: Boolean read write

---

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

---

Validates the server properties.

procedure CheckProperties

---

Creates TROBaseSuperServerConnection implementation according to used library

function CreateBaseSuperServerConnection: TROBaseSuperTcpServerConnection

---

Decrypt stream

procedure DecryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Decrypt stream

procedure DecryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

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

property DefaultResponse: string read write

---

Disconnects all clients

procedure DisconnectAllClients

---

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

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

procedure DoBeforeDecryptEvent(aEncryptedStream: TStream)

Parameters:

• aEncryptedStream: Stream

---

Calls OnMaxThreadLimitReached event

procedure DoMaxThreadLimitReached

---

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

---

Encrypt stream

procedure EncryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Encrypt stream

procedure EncryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

Specifies the event repository.

property EventRepository: TROEventRepository read write

---

Returns TROMessageDispatchers class

function GetDispatchersClass: TROMessageDispatchersClass

---

function GetRODLReader: TROCustomRODLReader

---

Returns SSL state

function GetSecure: Boolean

---

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

function GetServerType: TROServerType

---

function GetServiceMetaData(aServiceName: string; aOptions: string; out aContentType: string): TStream

Parameters:

• aServiceName:
• aOptions:
• aContentType:

---

Returns itself.

function GetTransportObject: TObject

---

This method is called when incoming data is present.

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

Parameters:

• Id:
• aClient:
• aData:

---

function IntDispatchMessage(Dispatcher: TROMessageDispatcher; const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• Dispatcher:
• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

Checks if encryption was used

function IsEncryptionUsed: Boolean

---

function IsServiceAllowed(Value: string): Boolean

Parameters:

• Value:

---

Checks state of stream

function IsStreamEncrypted(Source: TStream): Boolean

Parameters:

• Source: Stream

---

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

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

Fired after stream was encrypted

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

---

Fires after the server has been activated.

property OnAfterServerActivate: TNotifyEvent read write

---

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

---

This event is fired before channel is destroyed.

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

---

Fired before stream will be decrypted

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

---

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

---

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

---

property OnCertificateGenerating: TROOpenSSLCertificateGenerating read write
delegate:  procedure OnCertificateGenerating(var Subject: string; var Issuer: string; var HashAlgorithm: string; var BitNumber: Word)

---

This event is fired when client connects to the server.

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

---

This event is fired when client disconnects from the server.

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

---

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

---

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

property OnMaxThreadLimitReached: TNotifyEvent read write

---

Asks SSL certificate's password

property OnPassword: TROOpenSSLPassword read write
delegate:  procedure OnPassword(Sender: TROOpenSSL; var aPassword: string; const IsWrite: Boolean)

---

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)

---

Verificates certificate

property OnVerifyCeft: TROOpenSSLVerifyCeft read write
delegate:  procedure OnVerifyCeft(anIssuer: string; aSubject: string; aSerial: Cardinal; ErrorCode: Cardinal; Depth: Cardinal; var Ok: Boolean)

---

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)

---

Specifies SSL properties

property OpenSSL: TROOpenSSL read write

---

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

property Port: Integer read write

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

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

---

Provides read-only access to the underlying server object that wraps the server socket.

property ServerV4: TROServerSocket read

---

Provides read-only access to the underlying server object that wraps the server socket.

property ServerV6: TROServerSocket read

---

Allows to get/set Service Groups

property ServiceGroup: string read write

---

Defines whether "acknowledgement" message are skipped.

property SkipAck: Boolean read write

---

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

---

Fires the OnReadFromStream event

procedure TriggerReadFromStream(aSource: TStream)

Parameters:

• aSource: stream

---

Fires the OnReadFromStream event

procedure TriggerWriteToStream(aDest: TStream)

Parameters:

• aDest: stream

 

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

---

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

---

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

---

Reference to TROBaseSuperServerConnection that was created with CreateBaseSuperServerConnection method

property BaseSuperServerConnection: TROBaseSuperTcpServerConnection read

---

Gets or sets the flag indicating whether the server should listen for IPv4 connections.

Setting this flag doesn't have any immediate effect. Its value is used only when the server is opened (either by setting the Active property to true).

property BindV4: Boolean read write

---

Gets or sets the flag indicating whether the server should listen for IPv6 connections.

Setting this flag doesn't have any immediate effect. Its value is used only when the server is opened (either by setting the Active property to true).

property BindV6: Boolean read write

---

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

---

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

property DefaultResponse: string read write

---

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

---

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

---

Specifies the event repository.

property EventRepository: TROEventRepository read write

---

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

---

Specifies SSL properties

property OpenSSL: TROOpenSSL read write

---

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

property Port: Integer read write

---

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

---

Provides read-only access to the underlying server object that wraps the server socket.

property ServerV4: TROServerSocket read

---

Provides read-only access to the underlying server object that wraps the server socket.

property ServerV6: TROServerSocket read

---

Allows to get/set Service Groups

property ServiceGroup: string read write

---

Defines whether "acknowledgement" message are skipped.

property SkipAck: Boolean read write

---

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

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Validates the server properties.

procedure CheckProperties

---

Creates TROBaseSuperServerConnection implementation according to used library

function CreateBaseSuperServerConnection: TROBaseSuperTcpServerConnection

---

Decrypt stream

procedure DecryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Decrypt stream

procedure DecryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

Disconnects all clients

procedure DisconnectAllClients

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

procedure DoBeforeDecryptEvent(aEncryptedStream: TStream)

Parameters:

• aEncryptedStream: Stream

---

Calls OnMaxThreadLimitReached event

procedure DoMaxThreadLimitReached

---

Encrypt stream

procedure EncryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Encrypt stream

procedure EncryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

Returns TROMessageDispatchers class

function GetDispatchersClass: TROMessageDispatchersClass

---

function GetRODLReader: TROCustomRODLReader

---

Returns SSL state

function GetSecure: Boolean

---

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

function GetServerType: TROServerType

---

function GetServiceMetaData(aServiceName: string; aOptions: string; out aContentType: string): TStream

Parameters:

• aServiceName:
• aOptions:
• aContentType:

---

Returns itself.

function GetTransportObject: TObject

---

This method is called when incoming data is present.

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

Parameters:

• Id:
• aClient:
• aData:

---

function IntDispatchMessage(Dispatcher: TROMessageDispatcher; const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• Dispatcher:
• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

Checks if encryption was used

function IsEncryptionUsed: Boolean

---

function IsServiceAllowed(Value: string): Boolean

Parameters:

• Value:

---

Checks state of stream

function IsStreamEncrypted(Source: TStream): Boolean

Parameters:

• Source: Stream

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Fires the OnReadFromStream event

procedure TriggerReadFromStream(aSource: TStream)

Parameters:

• aSource: stream

---

Fires the OnReadFromStream event

procedure TriggerWriteToStream(aDest: TStream)

Parameters:

• aDest: stream

 

Fired after stream was encrypted

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

---

Fires after the server has been activated.

property OnAfterServerActivate: TNotifyEvent read write

---

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

---

This event is fired before channel is destroyed.

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

---

Fired before stream will be decrypted

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

---

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

---

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

---

property OnCertificateGenerating: TROOpenSSLCertificateGenerating read write
delegate:  procedure OnCertificateGenerating(var Subject: string; var Issuer: string; var HashAlgorithm: string; var BitNumber: Word)

---

This event is fired when client connects to the server.

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

---

This event is fired when client disconnects from the server.

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

---

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

---

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

property OnMaxThreadLimitReached: TNotifyEvent read write

---

Asks SSL certificate's password

property OnPassword: TROOpenSSLPassword read write
delegate:  procedure OnPassword(Sender: TROOpenSSL; var aPassword: string; const IsWrite: Boolean)

---

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)

---

Verificates certificate

property OnVerifyCeft: TROOpenSSLVerifyCeft read write
delegate:  procedure OnVerifyCeft(anIssuer: string; aSubject: string; aSerial: Cardinal; ErrorCode: Cardinal; Depth: Cardinal; var Ok: Boolean)

---

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)