Midware TServerObject

From Overbyte
Revision as of 09:52, 9 May 2011 by Marie (talk | contribs)
Jump to navigation Jump to search

Main page -> Midware component reference -> TServerObject

Overview

unit

TServerObject is the ancestor (abstract class) for all objects responsible for doing the application server work. The ORB create instances of server object, pass client request to them and call their Execute method. When the server object work is done, it must call the Finish method to send the response back to the client. This can be done either from the Execute method or form any other point later in time.

Writing an application server is mostly writing TServerObject. Application server performance entirely depends on TServerObject performance.

Properties

FFunctionCode The FunctionCode is used by the ORB to know how to dispatch client requests to the various server objects he has in his table.
FLniFileName Initialized by ORB with INI filename. Used for persistant data.
FRequestBuffer FRequestBuffer is a TMWBuffer component holding all parameters from client request.
FResponseBuffer FResponseBuffer is a TMWBuffer component that TServerObject must fill with result set.
FResponseSize FResponseSize is the initial size for FResponseBuffer.
FResultStatus ResultStatus returned to client.
FUserData Reserved for the TServerObject descendent writer.
FORBDataPtr FORBDataPtr is a pointer to data allocated by the ORB.
FServerObjectClass FServerObjectClass is initialized in constructor with ClassType for the current TServerObject.
RequestBroker RequestBroker property tell TServerObject component which ORB it depends from.

Methods

BuilDFunctionCode BuildFunctionCode will initialize FFunctionCode with the function code handled by the ServerObject.
CopyFromReference CopyFromReference is called by the ORB when TServerObject has been instanciated and before the Execute method is called.
Execute The ORB (Object Request Broker, TRequestBroker component) call Execute method to make the server object do his work: execute the request and produce a response.
Finish The server object MUST call this method to signal the ORB (Object Request Broker, TRequestBroker component) that the server's object work is done and the response is ready to be sent to the client.
GiveRequest The ORB (Object Request Broker, TRequestBroker component) call this method to pass a request from the client to the server object.
Initialize The ORB (Object Request Broker, TRequestBroker component) call this method when the server object must be initialized.
TriggerDisplay Triggers the FOnDisplay event, if assigned.

Events

FOnRequestDone FOnRequestDone is an internal event used by ORB to do some work at the end of TServerObject processing.
FOnDisplay FOnDisplay is used for debugging purpose.