62 lines
3.8 KiB
Plaintext
62 lines
3.8 KiB
Plaintext
compile insert rti_utl_oeserver_equates
|
||
/* ----------------------------------------------------------------------------
|
||
Author : David Goddard, WinWin Solutions Australia Pty Ltd
|
||
Created : 18 November 2009
|
||
Version : 13.2.7.0
|
||
Date : 7 February 2013
|
||
Purpose : Equates for the talking to oEngineServer service via the socket_function
|
||
|
||
Modification Info:
|
||
----------------------------------------------------------------------------
|
||
Date Who Notes
|
||
130207 DGG Added other commands section which require version 1.0.1.35 or higher
|
||
110705 DGG Added -4, -5 & -6 options which require socket server version 1.0.1.35 or higher.
|
||
--------------------------------------------------------------------------*/
|
||
|
||
Equ wwa_oes_delim$ To \01\
|
||
Equ wwa_oes_cLOGIN$ To "1" ;* Send the oengine login details. This will start a new engine. See below for details
|
||
Equ wwa_oes_cLOGOFF$ To "2" ;* Logout of an oengine. Engine will remain alive as per eserver.cfg settings
|
||
Equ wwa_oes_cCALL$ To "3" ;* Send a request to process. The procedure specified in the Login call will receive the request in the first parameter
|
||
|
||
Equ wwa_oes_cQuery$ To "-1" ;* returns a HTML table containing details of running engines
|
||
Equ wwa_oes_cResetGentle$ To "-2" ;* shut down one or more ‘idle’ engines
|
||
Equ wwa_oes_cResetForce$ To "-3" ;* shut down one or more engines (whether ‘idle’ or ‘in use’);
|
||
Equ wwa_oes_cPhantom$ To "-4" ;* starts up a phantom thread
|
||
Equ wwa_oes_cGetStartTime$ To "-5" ;* returns the startup time for the engine server and the current time (according to the engine server)
|
||
Equ wwa_oes_cVersion$ To "-6" ;* returns the version number of the oesocketserver
|
||
|
||
Equ wwa_oes_valid_codes$ To "1 2 3 -1 -2 -3 -4 -5 -6"
|
||
|
||
/* cLogin format as below delimited by wwa_oes_delim$
|
||
server.request = wwa_oes_cLOGIN$
|
||
server.request := wwa_oes_delim$ : server.username ;* the username to login with. Must be uppercase
|
||
server.request := wwa_oes_delim$ : server.password ;* the users password.
|
||
server.request := wwa_oes_delim$ : server.database ;* OpenInsight application name. Must be uppercase
|
||
server.request := wwa_oes_delim$ : wwa_oes_modeStateless$ ;* Connection Mode - See connection mode section below
|
||
server.request := wwa_oes_delim$ : server.engineName ;* A specific engine name to send the request to. Must set startup flags to 0
|
||
server.request := wwa_oes_delim$ : server.funcName ;* Procedure that will receive data from the cCall$ request
|
||
server.request := wwa_oes_delim$ : wwa_oes_startupNew$ ;* StartUp Flags. 1 will show on the desktop. 65 will hide from the desktop
|
||
server.request := wwa_oes_delim$ : wwa_oes_shutdownYes$ ;* Shut Down Flags
|
||
server.request := wwa_oes_delim$ : server.OIlocation ;* OI Location, tells the EngineServer to "cd" to some other folder
|
||
server.request := wwa_oes_delim$ / *
|
||
|
||
/* Connection Mode */
|
||
equ wwa_oes_modeJD3$ to -1 ;* or null, JD3 mode
|
||
equ wwa_oes_modeBlock$ to 0 ;* "block" mode
|
||
equ wwa_oes_modeCharacter$ to 1 ;* character mode (CTI/AREv32)
|
||
equ wwa_oes_modeStateless$ to 2 ;* stateless mode (OECGI3)
|
||
|
||
/* Startup Flags */
|
||
equ wwa_oes_startupExisting$ to 0 ;* Connect to an existing engine as specified in server.engineName setting, show on desktop.
|
||
equ wwa_oes_startupNew$ to 1 ;* start a new engine, show on desktop
|
||
equ wwa_oes_startupExistingNew$ to 2 ;* connect to existing if available, otherwise create a new engine, show on desktop
|
||
equ wwa_oes_startupNewHide$ to 65 ;* start a new engine, hide from desktop
|
||
|
||
/*Shutdown Flags */
|
||
equ wwa_oes_shutdownNo$ to 0 ;* do not shutdown the engine after the connection is completed
|
||
equ wwa_oes_shutdownYes$ to 1 ;* shutdown the engine after the connection is completed.
|
||
|
||
/* other commands used when calling revcmd_input function */
|
||
equ wwa_oes_getEngineName$ to \06\
|
||
equ wwa_oes_closeEngineOnExit$ to \08\
|