S/Web Objects - Server

S/Web Objects

Links on this page:

Properties
Methods

Server

This object handles information relating to this specific running S/WEB server

Properties:

Property	Get/Set	Description
ANONYMOUSPROCS	Get/Set	Exposes CLIENT object ANONYMOUSPROCS property (q.v.)
AREV	Get	Returns a true or false indicating if the server is running Advanced Revelation
CLEANUPCLIENTPROC	Get/Set	This contains the name of a procedure that is called by the cleaning process once per each expired client about to be removed from the system. The procedure should be a subroutine that takes a single argument, which is the ID property of the client being removed.
CLEANUPINTERVAL	Get/Set	Modifies the server's cleanup interval value. This is a value in minutes indicating how much time should elapse between clean ups. The system cleanup task involves deleting clients who have reached the expiration time.
CLEANUPPERIOD	Get/Set	Modifies the server's cleanup period value. This is the maximum time in seconds that a cleanup should run for.
CLEANUPPROC	Get/Set	This is a program the developer can have called after the system cleaning process. This can be used for any regular occurring process required. Examples include generic system record unlocking calls, system LISTS record cleanup or index flush calls. Remember that while the server is processing your cleanup requests, it is not processing web requests.
DEBUGGER	Get/Set	Enables or disables the system debugger. If disabled the server will not drop to the debugger in the event of a fatal error but will restart itself.
ID	Get	Retrieves the current server's ID value. This value can be used as part of the ID for saved list records or any other process that requires a unique key value.
INITPROC	Get/Set	The name of the procedure used to initialise the server.
IPCHECK	Get/Set	Modifies the server's IP Check value. If true$ then the client will be logged off if the client IP address changes.
MODE	Get	Retrieves the current servers' mode - primary (True$) or secondary.
OE	Get	Returns a true or false indicating if the server is running OpenEngine
STATUS	Get	Whether the server is running - true or false.
UTCMODIFIER	Get/Set	Modifies the UTC modifier for this server. This is an integer identifying the difference between this time zone and GMT.
UTCTIME	Get	Retrieves the current time in UTC format as internal date : "." : internal time
XFILES	Get/Set	Determines whether to replace all content in the request and response files with XXX before deleting to make it more difficult to un-erase the files.
XVERSION	Get	Retrieves the current version of the server module.

Methods:

call www_Exec_Method( "SERVER", method, param1, param2, param3, param4, param5 )

Method	Description
CREATE	This method creates a new server object
DESTROY	This method destroys the current server object. You should use the STOP method to actually stop the server cleanly.
EXECUTE	Starts the server scanning.
GET	This method retrieves properties of the response object
LOGERROR	This method will be implemented in a future release of the software
SCAN	Executes a one time scan of the incoming requests - permitting external control of the process.
SET	This method sets properties of the server object
STOP	This method is used to tell the server to stop.

[top]

CREATE method

This method initiates the current server.

Argument	Description
param1	Not used.
param2	Not used.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

This method is called when S/Web is started. The CREATE method initialises all of the environmental settings and configures the server for use. This method should not be called by the end-user and is only documented for completeness.

[top]

DESTROY method

This method shuts down the current server.

Argument	Description
param1	Not used.
param2	Not used.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

This method should not be called by the end-user and is only documented for completeness. Using this method to shut down the server could result in system instability

[top]

EXECUTE method

Used to start the server off. If Param1 is set then the server merely initialises and expects an external process to deal with the incoming files.

Argument	Description
param1	If True$ do not go into scanning loop.
param2	Not used.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

[top]

GET method

This method retrieves properties of the server object

Argument	Description
param1	Property to retrieve - can be @Rm delimited to retrieve multiple properties.
param2	Property values returned.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

Example:

   declare function www_Exec_Method, www_Get_Status, www_Set_Status
   $insert www_Status_Equates
   $insert logical
   Properties =   "OE"
   if www_Exec_Method( "SERVER", "GET", Properties, RetVals, "", "", "", "", errorText ) then
      OpenEngine    = Field( RetVals, @RM, 1 )
      * Finish processing
   end else
      abort = TRUE$
   end

[top]

LOGERROR method

Not yet implemented.

Argument	Description
param1	Not used.
param2	Not used.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

[top]

SCAN method

This method executes a one time scan of the request directory..

Argument	Description
param1	Not used
param2	Not used
param3	Not used
param4	Not used.
param5	Not used.
param6	Not used.

Example:

   declare function www_Exec_Method, www_Get_Status, www_Set_Status
   $insert www_Status_Equates
   $insert logical

   if www_Exec_Method( "SERVER", "SCAN", "", "", "", "", "", "", errorText ) then
      * Finish processing
   end else
      abort = TRUE$
   end

[top]

SET method

This method sets properties of the SERVER object.

Argument	Description
param1	Properties to set, @Rm delimited
param2	Values to set, @Rm delimited
param3	Previous values returned, @Rm delimited
param4	Not used.
param5	Not used.
param6	Not used.

Example:

   declare function www_Exec_Method, www_Get_Status, www_Set_Status
   $insert www_Status_Equates
   $insert logical
   Properties =   "IPCHECK"
   Values =   True$
   if www_Exec_Method( "SERVER", "SET", Properties, Values, RetVals, "", "", "", errorText ) then
      * Finish processing
   end else
      abort = TRUE$
   end

[top]

STOP method

This method sets the cancelled flag to allow a clean server closedown.

Argument	Description
param1	Not used.
param2	Not used.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

[top]