TROHTTPServer

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

property AccessControlMaxAge: 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

---

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

---

Validates the server properties.

procedure CheckProperties

---

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

---

Controls whether data packets are sent individually or if small packets are held back to send as part of fewer larger data packets. Normally, you will want this disabled as it can have a significant effect on performance. The only time when its worth keeping the property enabled is when there are many small packets to be sent and you need to keep network bandwidth to a minimum.

See more at Nagle's algorithm

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

---

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

---

Processes CORS requests.

function DoCORSSupport(const aRequest: IUnknown; const aResponse: IROHTTPResponse): Boolean

Parameters:

• aRequest: Request
• aResponse: Response

---

Performs GZIP decoding

procedure DoDecodeStream(const aSource: TStream; out aDest: TStream)

Parameters:

• aSource: Source
• aDest: Destination

---

Performs GZIP encoding

procedure DoEncodeStream(const aSource: TStream)

Parameters:

• aSource: Source

---

procedure DoGetCustomClientAccessPolicy(var aPolicyContent: string)

Parameters:

• aPolicyContent:

---

Generates documentation if correspondent request is detected

function DoProcessDocs(const aRequest: IUnknown; const aResponse: IROHTTPResponse; const aResponseStream: TStream; const aRoot: string; const aSub: string): Boolean

Parameters:

• aRequest: Request
• aResponse: Response
• aResponseStream: Response stream
• aRoot: Root (part before ?)
• aSub: Query string (part after ?)

---

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

---

List of extended dispatchers attached to the server channel instance.

Extended dispatchers are dispatchers that perform special tasks other than calling server services. A good example of an extended dispatcher is TROJavaScriptHttpDispatcher dispatcher.

property ExtendedDispatchers: TROExtendedHTTPDispatcherList read

---

Returns CA certificate

function GetCACertificate: string

---

Returns TROMessageDispatchers class

function GetDispatchersClass: TROMessageDispatchersClass

---

function GetRODLReader: TROCustomRODLReader

---

Returns SSL state

function GetSecure: Boolean

---

Returns rstHTTP. 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

---

Processes Extended Dispatcher requests.

function HandleExtendedDispatchers(const aRoot: string; const aTransport: IROHTTPTransport; const aRequest: IUnknown; const aResponse: IROHTTPResponse; const aRequestData: TStream; const aResponseData: TStream): Boolean

Parameters:

• aRoot: Path Info
• aTransport: Transport channel
• aRequest: Request
• aResponse: Response
• aRequestData: Request stream
• aResponseData: Response stream

---

Realm for http authentication.

property HTTPAuthenticationRealm: string read write

---

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

Parameters:

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

---

procedure IntRequest(Sender: TObject; aContext: IROAsyncContext)

Parameters:

• Sender:
• aContext:

---

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

---

Controls whether to use HTTP Keep-Alive to keep the connection alive between requests.
If enabled (true) , once a request is made and a connection is established, this connection is kept open and used for future requests.
If disabled, the connection is closed, and a new connection is created for future requests.
Since establishing a connection is - relatively speaking - a costly and resource intensive operation for the network, compared to sending small amounts of data, it is recommended to keep this option enabled for optimal performance, if requests to the server are done relatively frequently.
For Keep-Alive to work, the option must be supported and enabled on both client and server.

property KeepAlive: Boolean read write

---

Determines the maximum length of client's request data (checks the value of the request Content-Length header). By default, this property equals 10MB.

property MaxPostData: Integer read write

---

The minimal size when GZIP encoding will be used (default is 4096 bytes)

property MinSizeForGzipEncoding: 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

---

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)

---

Allows to handle unknown requests, i.e. that aren't recognised by ProcessRequest

property OnCustomResponseEvent: TROHTTPGetCustomResponseEvent read write
delegate:  procedure OnCustomResponseEvent(const aTransport: IROHTTPTransport; const aRequestStream: TStream; const aResponseStream: TStream; const aResponse: IROHTTPResponse; var aHandled: Boolean)

---

This event is fired when SendClientAccessPolicyXml is set to captCustom. Allows more precise management of client access policies.

The handler of this event generates a valid ClientAccessPolicy.xml and puts it to the aPolicyContent parameter.

property OnGetCustomClientAccessPolicy: TROCustomClientAccessPolicyMethod read write
delegate:  procedure OnGetCustomClientAccessPolicy(aSender: TObject; var aPolicyContent: ROUTF8String)

---

property OnGetRODLReader: TROGetRODLReader read write

---

Fires if RequireHTTPAuthentication is set and correspondent fields are present in client request.

property OnHTTPAuthentication: TROHTTPAuthentication read write
delegate:  procedure OnHTTPAuthentication(const aRequest: IROHTTPRequest; const aUserName: string; const aPassword: string; var aHandled: Boolean)

---

Fires after request was processed

property OnHTTPRequestDone: TROHTTPRequestDone read write
delegate:  procedure OnHTTPRequestDone(const aResponse: IROHTTPResponse; const aResponseStream: TStream)

---

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

---

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)

---

This event is fired when server channel receives OPTIONS request. This event allows more precise management of cross-origin client access policies.

property OnSendCrossOriginHeader: TROHTTPSendCrossOriginHeader read write
delegate:  procedure OnSendCrossOriginHeader(var AllowedOrigin: string)

---

property OnSendCrossOriginHeaderEx: TROHTTPSendCrossOriginHeaderEx read write
delegate:  function OnSendCrossOriginHeaderEx(var Cors: TROCorsStruct): Boolean

---

Allows to handle unknown requests, i.e. that aren't recognised by ProcessRequest

property OnUnknownHTTPRequest: TROHTTPGetCustomResponseEvent read write
delegate:  procedure OnUnknownHTTPRequest(const aTransport: IROHTTPTransport; const aRequestStream: TStream; const aResponseStream: TStream; const aResponse: IROHTTPResponse; var aHandled: Boolean)

---

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

---

Parses PathInfo and splits it to root and query

procedure ParsePathInfo(const aPathInfo: string; var aRoot: string; var aSub: string)

Parameters:

• aPathInfo: PathInfo
• aRoot: Root (part after ?)
• aSub: Query string (part after ?)

---

Specifies the TCP port that the server is listening on. By default, the Remoting SDK HTTP Servers use port 8099 to avoid conflicts with existing web servers running on port 80, but you can change this to any other value that is available on your system.

property Port: Integer read write

---

This is basically the core of the entire server channel. This method processes incoming HTTP requests and performs requested actions (service method call, RODL request etc).

procedure ProcessRequest(const aTransport: IROHTTPTransportEx; const aRequestStream: TStream; out aResponseStream: TStream; const aResponse: IROHTTPResponse)

Parameters:

• aTransport: Transport instance
• aRequestStream: Request stream
• aResponseStream: Response stream
• aResponse: Response

---

Register Extended HTTP Dispatcher

procedure Register(aDispatcher: IROHTTPDispatcher)

Parameters:

• aDispatcher: Extended HTTP Dispatcher

---

Allows to use HTTP Authentication.

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

---

Gets or sets the intended server behavior when the ClientAccessPolicy.xml file (security policy file) is requested.

Possible values are:

• captAllowNone - All requests are denied.
• captAllowAll - All requests are allowed.
• captCustom - Custom request policy is applied. Custom security policy file is generated via the OnGetCustomClientAccessPolicy event handler.

property SendClientAccessPolicyXml: TROClientAccessPolicyType read write

---

Gets or sets a flag indicating whether the server should handle the incoming CORS requests or ignore them.

property SendCrossOriginHeader: Boolean read write

---

If set to true, messages about exceptions occurred on the server will be sent with a HTTP Error 500 header set (standard HTTP header for internal server errors), or a standard "200" message code (false).

Some proxy servers might perform special handling on 500 error messages that will prevent exception messages sent back as 500 to be recognized properly. If you are seeing this problem, try setting this property to false. If not, it is recommended to keep the default value.

property SendExceptionsAs500: Boolean read write

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Specifies whether the HTTP server will serve up a page with human-readable information about the server when being accessed from a web browser. This information page will contain details about the registered dispatchers and the documentation for the services.

property ServeInfoPage: Boolean read write

---

property Server: TROAsyncHTTPServer read

---

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

---

Allows to get/set Service Groups

property ServiceGroup: string 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

---

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

---

Fires the OnReadFromStream event

procedure TriggerReadFromStream(aSource: TStream)

Parameters:

• aSource: stream

---

Fires the OnReadFromStream event

procedure TriggerWriteToStream(aDest: TStream)

Parameters:

• aDest: stream

---

Unregister Extended HTTP Dispatcher

procedure Unregister(aDispatcher: IROHTTPDispatcher)

Parameters:

• aDispatcher: Extended HTTP Dispatcher

 

property AccessControlMaxAge: 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

---

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

---

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

property DefaultResponse: string read write

---

Controls whether data packets are sent individually or if small packets are held back to send as part of fewer larger data packets. Normally, you will want this disabled as it can have a significant effect on performance. The only time when its worth keeping the property enabled is when there are many small packets to be sent and you need to keep network bandwidth to a minimum.

See more at Nagle's algorithm

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

---

List of extended dispatchers attached to the server channel instance.

Extended dispatchers are dispatchers that perform special tasks other than calling server services. A good example of an extended dispatcher is TROJavaScriptHttpDispatcher dispatcher.

property ExtendedDispatchers: TROExtendedHTTPDispatcherList read

---

Realm for http authentication.

property HTTPAuthenticationRealm: string read write

---

Controls whether to use HTTP Keep-Alive to keep the connection alive between requests.
If enabled (true) , once a request is made and a connection is established, this connection is kept open and used for future requests.
If disabled, the connection is closed, and a new connection is created for future requests.
Since establishing a connection is - relatively speaking - a costly and resource intensive operation for the network, compared to sending small amounts of data, it is recommended to keep this option enabled for optimal performance, if requests to the server are done relatively frequently.
For Keep-Alive to work, the option must be supported and enabled on both client and server.

property KeepAlive: Boolean read write

---

Determines the maximum length of client's request data (checks the value of the request Content-Length header). By default, this property equals 10MB.

property MaxPostData: Integer read write

---

The minimal size when GZIP encoding will be used (default is 4096 bytes)

property MinSizeForGzipEncoding: Integer read write

---

property OnGetRODLReader: TROGetRODLReader read write

---

Specifies SSL properties

property OpenSSL: TROOpenSSL read write

---

Specifies the TCP port that the server is listening on. By default, the Remoting SDK HTTP Servers use port 8099 to avoid conflicts with existing web servers running on port 80, but you can change this to any other value that is available on your system.

property Port: Integer read write

---

Allows to use HTTP Authentication.

property RequireHTTPAuthentication: Boolean read write

---

Gets or sets the intended server behavior when the ClientAccessPolicy.xml file (security policy file) is requested.

Possible values are:

• captAllowNone - All requests are denied.
• captAllowAll - All requests are allowed.
• captCustom - Custom request policy is applied. Custom security policy file is generated via the OnGetCustomClientAccessPolicy event handler.

property SendClientAccessPolicyXml: TROClientAccessPolicyType read write

---

Gets or sets a flag indicating whether the server should handle the incoming CORS requests or ignore them.

property SendCrossOriginHeader: Boolean read write

---

If set to true, messages about exceptions occurred on the server will be sent with a HTTP Error 500 header set (standard HTTP header for internal server errors), or a standard "200" message code (false).

Some proxy servers might perform special handling on 500 error messages that will prevent exception messages sent back as 500 to be recognized properly. If you are seeing this problem, try setting this property to false. If not, it is recommended to keep the default value.

property SendExceptionsAs500: Boolean read write

---

Specifies whether the HTTP server will serve up a page with human-readable information about the server when being accessed from a web browser. This information page will contain details about the registered dispatchers and the documentation for the services.

property ServeInfoPage: Boolean read write

---

property Server: TROAsyncHTTPServer read

---

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

---

Allows to get/set Service Groups

property ServiceGroup: string 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

---

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

 

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

---

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

---

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

---

Processes CORS requests.

function DoCORSSupport(const aRequest: IUnknown; const aResponse: IROHTTPResponse): Boolean

Parameters:

• aRequest: Request
• aResponse: Response

---

Performs GZIP decoding

procedure DoDecodeStream(const aSource: TStream; out aDest: TStream)

Parameters:

• aSource: Source
• aDest: Destination

---

Performs GZIP encoding

procedure DoEncodeStream(const aSource: TStream)

Parameters:

• aSource: Source

---

procedure DoGetCustomClientAccessPolicy(var aPolicyContent: string)

Parameters:

• aPolicyContent:

---

Generates documentation if correspondent request is detected

function DoProcessDocs(const aRequest: IUnknown; const aResponse: IROHTTPResponse; const aResponseStream: TStream; const aRoot: string; const aSub: string): Boolean

Parameters:

• aRequest: Request
• aResponse: Response
• aResponseStream: Response stream
• aRoot: Root (part before ?)
• aSub: Query string (part after ?)

---

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 CA certificate

function GetCACertificate: string

---

Returns TROMessageDispatchers class

function GetDispatchersClass: TROMessageDispatchersClass

---

function GetRODLReader: TROCustomRODLReader

---

Returns SSL state

function GetSecure: Boolean

---

Returns rstHTTP. 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

---

Processes Extended Dispatcher requests.

function HandleExtendedDispatchers(const aRoot: string; const aTransport: IROHTTPTransport; const aRequest: IUnknown; const aResponse: IROHTTPResponse; const aRequestData: TStream; const aResponseData: TStream): Boolean

Parameters:

• aRoot: Path Info
• aTransport: Transport channel
• aRequest: Request
• aResponse: Response
• aRequestData: Request stream
• aResponseData: Response stream

---

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

Parameters:

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

---

procedure IntRequest(Sender: TObject; aContext: IROAsyncContext)

Parameters:

• Sender:
• aContext:

---

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

---

Parses PathInfo and splits it to root and query

procedure ParsePathInfo(const aPathInfo: string; var aRoot: string; var aSub: string)

Parameters:

• aPathInfo: PathInfo
• aRoot: Root (part after ?)
• aSub: Query string (part after ?)

---

This is basically the core of the entire server channel. This method processes incoming HTTP requests and performs requested actions (service method call, RODL request etc).

procedure ProcessRequest(const aTransport: IROHTTPTransportEx; const aRequestStream: TStream; out aResponseStream: TStream; const aResponse: IROHTTPResponse)

Parameters:

• aTransport: Transport instance
• aRequestStream: Request stream
• aResponseStream: Response stream
• aResponse: Response

---

Register Extended HTTP Dispatcher

procedure Register(aDispatcher: IROHTTPDispatcher)

Parameters:

• aDispatcher: Extended HTTP Dispatcher

---

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

---

Unregister Extended HTTP Dispatcher

procedure Unregister(aDispatcher: IROHTTPDispatcher)

Parameters:

• aDispatcher: Extended HTTP Dispatcher

 

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

---

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)

---

Allows to handle unknown requests, i.e. that aren't recognised by ProcessRequest

property OnCustomResponseEvent: TROHTTPGetCustomResponseEvent read write
delegate:  procedure OnCustomResponseEvent(const aTransport: IROHTTPTransport; const aRequestStream: TStream; const aResponseStream: TStream; const aResponse: IROHTTPResponse; var aHandled: Boolean)

---

This event is fired when SendClientAccessPolicyXml is set to captCustom. Allows more precise management of client access policies.

The handler of this event generates a valid ClientAccessPolicy.xml and puts it to the aPolicyContent parameter.

property OnGetCustomClientAccessPolicy: TROCustomClientAccessPolicyMethod read write
delegate:  procedure OnGetCustomClientAccessPolicy(aSender: TObject; var aPolicyContent: ROUTF8String)

---

Fires if RequireHTTPAuthentication is set and correspondent fields are present in client request.

property OnHTTPAuthentication: TROHTTPAuthentication read write
delegate:  procedure OnHTTPAuthentication(const aRequest: IROHTTPRequest; const aUserName: string; const aPassword: string; var aHandled: Boolean)

---

Fires after request was processed

property OnHTTPRequestDone: TROHTTPRequestDone read write
delegate:  procedure OnHTTPRequestDone(const aResponse: IROHTTPResponse; const aResponseStream: TStream)

---

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

---

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)

---

This event is fired when server channel receives OPTIONS request. This event allows more precise management of cross-origin client access policies.

property OnSendCrossOriginHeader: TROHTTPSendCrossOriginHeader read write
delegate:  procedure OnSendCrossOriginHeader(var AllowedOrigin: string)

---

property OnSendCrossOriginHeaderEx: TROHTTPSendCrossOriginHeaderEx read write
delegate:  function OnSendCrossOriginHeaderEx(var Cors: TROCorsStruct): Boolean

---

Allows to handle unknown requests, i.e. that aren't recognised by ProcessRequest

property OnUnknownHTTPRequest: TROHTTPGetCustomResponseEvent read write
delegate:  procedure OnUnknownHTTPRequest(const aTransport: IROHTTPTransport; const aRequestStream: TStream; const aResponseStream: TStream; const aResponse: IROHTTPResponse; var aHandled: Boolean)

---

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)