Midware TAppServer

From Overbyte
Jump to navigation Jump to search

Main page -> Midware component reference -> TAppserver

Overview

unit ApServer.pas

TAppServer is the communication kernel for all MidWare application servers. This component handle all the communication work for the application server, keeping track of user connections and sessions. A complete application server is made of a TAppserver component, a TRequestBroker (Object Request Broker) component and a set of TServerObject descendent components.

Properties

Banner The banner property is the text that is sent to the client when the connection has been established. Default value is 'Welcome to MidWare server'.
ClientCount Gives the actual number of connected clients.
ClientCountLabel If assigned, this property will be used by TAppServer component to display the number of client connected.
ClientTimeout ClientTimeout gives the time in seconds before the server disconnect a client without activity.
ClientWSocket ClientWSocket is a run-time read-only indexed property whose value is the reference to each connected client TClientWSocket component.
ConnectCount ConnectCount gives the total number of connection received since server startup.
DisplayMemo If assigned, this property will be used by TAppServer component to display messages during work.
Handle The Handle property is the windows handle for the hidden window the component uses for internal messages
Handle The Handle property is the windows handle for the hidden window the component uses for internal messages.
Port The port property gives the port number or service name used by the server to listen for client connection.
RequesrBroker The server component receive client requests, data parameters and send replies to client.
RequestCount RequestCount gives the total number of requests received since server startup.
SrvWSocket SrvWSocket is the underlaying TWSocket component used to listen for for client connections.
Timeoutlnterval The server periodically check for client timeout.

Methods

DisconnectAll Disconnect every connected client. Do not confuse with the Stop method.
Start The start procedure will start the server. The server will accept new client connections. See also Stop.
Stop The Stop procedure will stop the server which will no more accept new clients, but will not disconnect already connected clients. See also Start.

Events

OnAfterProcessRequest The OnAfterProcessRequest is called when a request has been processed by a TServerObject.
OnAfterSendReply The OnAfterSendReply event is called once the reply header and body has ben written to the internal buffer for sending in the background.
OnBeforeProcessRequest The OnBeforeProcessRequest event is triggered just before anything is done with a request received from the client.
OnBeforeSendReply The OnBeforeSendReply event is called when a reply is ready to be transmitted to the client.
OnClientConnected This event is triggered when a client connect to the server.
OnClientClosed Occurs when a client disconnect from the server.
OnClientCommand Clients connects to the server to send commands (also called requests) and wait for server responses.
OnClientTimeout When a client had no more activity during some time specified by the ClientTimeout property, it is automatically disconnected. If this occurs, the OnClientTimeout event is triggred.
OnClientBgException Client communication is handled by a TWSocket descendent component which works in the background.
OnDisplay Sometimes, the server can display some infos about his internal working.
OnServerBgException The OnBgException event is triggered when an exception occurs in the background (occuring in an event handler called from the message pump).

How to


Midware Components Reference