TROTcpServer
Overview
TROTCPServer implements a TCP based server that uses the socket implementation.
Location
- Unit: uROTcpServer.pas
- Ancestry: TComponent | TROComponent | TROBaseConnection | TROServer | TROTcpServer
constructor Create override
Standard component constructor
constructor Create(aOwner: TComponent)
Parameters:
- aOwner: Owner
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
BindV4
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
BindV6
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
CheckProperties virtual (declared in TROServer)
Validates the server properties.
procedure CheckProperties
DecryptStream (TStream, TStream) protected overload (declared in TROBaseConnection)
Decrypt stream
procedure DecryptStream(const Source: TStream; const Dest: TStream)
Parameters:
- Source: Source
- Dest: Destination
DecryptStream (TStream) protected overload (declared in TROBaseConnection)
Decrypt stream
procedure DecryptStream(const Stream: TStream)
Parameters:
- Stream: Stream
DefaultResponse protected (declared in TROServer)
Holds the message that will be sent back to the client if it improperly "welcomes" the server.
property DefaultResponse: string read write
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: Stream
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, TStream) protected overload (declared in TROBaseConnection)
Encrypt stream
procedure EncryptStream(const Source: TStream; const Dest: TStream)
Parameters:
- Source: Source
- Dest: Destination
EncryptStream (TStream) protected overload (declared in TROBaseConnection)
Encrypt stream
procedure EncryptStream(const Stream: TStream)
Parameters:
- Stream: Stream
GetDispatchersClass protected virtual (declared in TROServer)
Returns TROMessageDispatchers class
function GetDispatchersClass: TROMessageDispatchersClass
GetRODLReader protected (declared in TROServer)
function GetRODLReader: TROCustomRODLReader
GetSecure protected override
Returns SSL state
function GetSecure: Boolean
GetServerType protected override
Returns current server type
function GetServerType: TROServerType
GetServiceMetaData protected (declared in TROServer)
function GetServiceMetaData(aServiceName: string; aOptions: string; out aContentType: string): TStream
Parameters:
- aServiceName:
- aOptions:
- aContentType:
GetTransportObject protected (declared in TROServer)
Returns itself.
function GetTransportObject: TObject
IntDispatchMessage protected (declared in TROServer)
function IntDispatchMessage(Dispatcher: TROMessageDispatcher; const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean
Parameters:
- Dispatcher:
- aTransport:
- aRequestStream:
- aResponseStream:
- oResponseOptions:
IsEncryptionUsed protected (declared in TROBaseConnection)
Checks if encryption was used
function IsEncryptionUsed: Boolean
IsServiceAllowed protected (declared in TROServer)
function IsServiceAllowed(Value: string): Boolean
Parameters:
- Value:
IsStreamEncrypted protected (declared in TROBaseConnection)
Checks state of stream
function IsStreamEncrypted(Source: TStream): Boolean
Parameters:
- Source: Stream
ListenQueue
Size of listen queue, by default = 15.
property ListenQueue: Cardinal read write
MaxRequestSize
Specifies the maximum size in bytes of incoming request that is allowed to be processed by the server. The default maximum size is 5 Megabytes.
property MaxRequestSize: Integer read write
Notification protected override (declared in TROServer)
Forwards notification messages to all owned components.
procedure Notification(AComponent: TComponent; Operation: TOperation)
Parameters:
- AComponent: component
- Operation: operation
OnAfterEncrypt (declared in TROBaseConnection)
Fired after stream was encrypted
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
OnBeforeDecrypt (declared in TROBaseConnection)
Fired before stream will be decrypted
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
OnCertificateGenerating
property OnCertificateGenerating: TROOpenSSLCertificateGenerating read write
delegate: procedure OnCertificateGenerating(var Subject: string; var Issuer: string; var HashAlgorithm: string; var BitNumber: Word)
OnGetRODLReader
property OnGetRODLReader: TROGetRODLReader read write
OnManualBindSocket
Allows to customize the binding of the server to the host's IP addresses. By default the server is bound to all addresses available. When this event is handled by the user code no automatic binding is performed, the binding becomes user's responsibility.
property OnManualBindSocket: TNotifyEvent read write
OnPassword
Asks SSL certificate's password
property OnPassword: TROOpenSSLPassword read write
delegate: procedure OnPassword(Sender: TROOpenSSL; var aPassword: string; const IsWrite: Boolean)
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)
OnVerifyCeft
Verificates certificate
property OnVerifyCeft: TROOpenSSLVerifyCeft read write
delegate: procedure OnVerifyCeft(anIssuer: string; aSubject: string; aSerial: Cardinal; ErrorCode: Cardinal; Depth: Cardinal; var Ok: Boolean)
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)
OpenSSL
Specifies SSL properties
property OpenSSL: TROOpenSSL read write
Port
This property specifies the TCP port that the server is listening on. By default, the Remoting SDK TCP Servers use port 8090, but you can change this to any other value that is available on your system.
property Port: Integer read write
ROFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure ROFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
RORemoveFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure RORemoveFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
SendRemoveNotification protected (declared in TROComponent)
Forwards notification messages to all owned components.
procedure SendRemoveNotification(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
ServiceGroup (declared in TROServer)
Allows to get/set Service Groups
property ServiceGroup: string read write
SocketV4
Provides read-only access to the underlying IPv4 server socket object.
property SocketV4: TROAsyncSocket read
SocketV6
Provides read-only access to the underlying IPv6 server socket object.
property SocketV6: TROAsyncSocket read
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
Timeout
Gets ir set the connection idle timeout value in seconds. If no data was transmitted through the socket during this time the connection terminates. The default value is 120 seconds. When setting this value make sure the service will have enough time to execute any method before the timeout expires.
property Timeout: Integer read write
TriggerReadFromStream protected (declared in TROServer)
Fires the OnReadFromStream event
procedure TriggerReadFromStream(aSource: TStream)
Parameters:
- aSource: stream
TriggerWriteToStream protected (declared in TROServer)
Fires the OnReadFromStream event
procedure TriggerWriteToStream(aDest: TStream)
Parameters:
- aDest: stream
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
BindV4
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
BindV6
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
DefaultResponse protected (declared in TROServer)
Holds the message that will be sent back to the client if it improperly "welcomes" the server.
property DefaultResponse: string read write
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
ListenQueue
Size of listen queue, by default = 15.
property ListenQueue: Cardinal read write
MaxRequestSize
Specifies the maximum size in bytes of incoming request that is allowed to be processed by the server. The default maximum size is 5 Megabytes.
property MaxRequestSize: Integer read write
OnGetRODLReader
property OnGetRODLReader: TROGetRODLReader read write
OpenSSL
Specifies SSL properties
property OpenSSL: TROOpenSSL read write
Port
This property specifies the TCP port that the server is listening on. By default, the Remoting SDK TCP Servers use port 8090, but you can change this to any other value that is available on your system.
property Port: Integer read write
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
ServiceGroup (declared in TROServer)
Allows to get/set Service Groups
property ServiceGroup: string read write
SocketV4
Provides read-only access to the underlying IPv4 server socket object.
property SocketV4: TROAsyncSocket read
SocketV6
Provides read-only access to the underlying IPv6 server socket object.
property SocketV6: TROAsyncSocket read
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
Timeout
Gets ir set the connection idle timeout value in seconds. If no data was transmitted through the socket during this time the connection terminates. The default value is 120 seconds. When setting this value make sure the service will have enough time to execute any method before the timeout expires.
property Timeout: Integer read write
constructor Create override
Standard component constructor
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
DecryptStream (TStream, TStream) protected overload (declared in TROBaseConnection)
Decrypt stream
procedure DecryptStream(const Source: TStream; const Dest: TStream)
Parameters:
- Source: Source
- Dest: Destination
DecryptStream (TStream) protected overload (declared in TROBaseConnection)
Decrypt stream
procedure DecryptStream(const Stream: TStream)
Parameters:
- Stream: Stream
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: Stream
EncryptStream (TStream, TStream) protected overload (declared in TROBaseConnection)
Encrypt stream
procedure EncryptStream(const Source: TStream; const Dest: TStream)
Parameters:
- Source: Source
- Dest: Destination
EncryptStream (TStream) protected overload (declared in TROBaseConnection)
Encrypt stream
procedure EncryptStream(const Stream: TStream)
Parameters:
- Stream: Stream
GetDispatchersClass protected virtual (declared in TROServer)
Returns TROMessageDispatchers class
function GetDispatchersClass: TROMessageDispatchersClass
GetRODLReader protected (declared in TROServer)
function GetRODLReader: TROCustomRODLReader
GetSecure protected override
Returns SSL state
function GetSecure: Boolean
GetServerType protected override
Returns current server type
function GetServerType: TROServerType
GetServiceMetaData protected (declared in TROServer)
function GetServiceMetaData(aServiceName: string; aOptions: string; out aContentType: string): TStream
Parameters:
- aServiceName:
- aOptions:
- aContentType:
GetTransportObject protected (declared in TROServer)
Returns itself.
function GetTransportObject: TObject
IntDispatchMessage protected (declared in TROServer)
function IntDispatchMessage(Dispatcher: TROMessageDispatcher; const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean
Parameters:
- Dispatcher:
- aTransport:
- aRequestStream:
- aResponseStream:
- oResponseOptions:
IsEncryptionUsed protected (declared in TROBaseConnection)
Checks if encryption was used
function IsEncryptionUsed: Boolean
IsServiceAllowed protected (declared in TROServer)
function IsServiceAllowed(Value: string): Boolean
Parameters:
- Value:
IsStreamEncrypted protected (declared in TROBaseConnection)
Checks state of stream
function IsStreamEncrypted(Source: TStream): Boolean
Parameters:
- Source: Stream
Notification protected override (declared in TROServer)
Forwards notification messages to all owned components.
procedure Notification(AComponent: TComponent; Operation: TOperation)
Parameters:
- AComponent: component
- Operation: operation
ROFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure ROFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
RORemoveFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure RORemoveFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
SendRemoveNotification protected (declared in TROComponent)
Forwards notification messages to all owned components.
procedure SendRemoveNotification(aComponent: TComponent)
Parameters:
- aComponent: component
TriggerReadFromStream protected (declared in TROServer)
Fires the OnReadFromStream event
procedure TriggerReadFromStream(aSource: TStream)
Parameters:
- aSource: stream
TriggerWriteToStream protected (declared in TROServer)
Fires the OnReadFromStream event
procedure TriggerWriteToStream(aDest: TStream)
Parameters:
- aDest: stream
OnAfterEncrypt (declared in TROBaseConnection)
Fired after stream was encrypted
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
OnBeforeDecrypt (declared in TROBaseConnection)
Fired before stream will be decrypted
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
OnCertificateGenerating
property OnCertificateGenerating: TROOpenSSLCertificateGenerating read write
delegate: procedure OnCertificateGenerating(var Subject: string; var Issuer: string; var HashAlgorithm: string; var BitNumber: Word)
OnManualBindSocket
Allows to customize the binding of the server to the host's IP addresses. By default the server is bound to all addresses available. When this event is handled by the user code no automatic binding is performed, the binding becomes user's responsibility.
property OnManualBindSocket: TNotifyEvent read write
OnPassword
Asks SSL certificate's password
property OnPassword: TROOpenSSLPassword read write
delegate: procedure OnPassword(Sender: TROOpenSSL; var aPassword: string; const IsWrite: Boolean)
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)
OnVerifyCeft
Verificates certificate
property OnVerifyCeft: TROOpenSSLVerifyCeft read write
delegate: procedure OnVerifyCeft(anIssuer: string; aSubject: string; aSerial: Cardinal; ErrorCode: Cardinal; Depth: Cardinal; var Ok: Boolean)
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)