Skip to content

SERVICE

Starts or stops the ADOxx Web Service server.

Syntax

leo-grammar
CC "AdoScript" SERVICE	Start | Stop

Start :		start 	[ port:intValue ] [ backlog:intValue ]
					[ logformat:"short" | "long" ] 
          [ output: statusbar | textfield ] .

Stop :		stop .

# -->RESULT ecode:intValue .
CC "AdoScript" SERVICE	Start | Stop

Start :		start 	[ port:intValue ] [ backlog:intValue ]
					[ logformat:"short" | "long" ] 
          [ output: statusbar | textfield ] .

Stop :		stop .

# -->RESULT ecode:intValue .

Parameters

  • start (modifier) - starts the ADOxx Web Service server.
  • port (intValue, optional) - port at which the ADOxx Web Service server receives requests. Default is 80.
  • backlog (intValue, optional) - max queue size for requests. Default is 100.
  • logformat (enumValue, optional) - used values can either be "short" or "long"
  • output (statusbar | textfield) specifies where the status messages of the ADOxx Web Service server are put out. statusbar (default) means the messages are shown in the status bar and textfield means that messages are appended to a textfield. As this reduces the server performance (in relation to statusbar mode), this mode should just be used when really needed.
  • stop (modifier) - ends the ADOxx Web Service server.

Returns

  • ecode (intValue) - Contains the error code or 0 in case of success.

Details

If started, ADOxx opens a port where SOAP messages can be sent. Over this endpoint AdoScript can be sent, which is then executed in the current ADOxx instance.

Problem can occur if the webservice server executes AdoScript at the same time, the user interface is changed through user interaction. Therefore, it is recommend to block the user interaction, for example thorough the MSGWIN command.

For more information visit ADOxx Web Service

See Also

MSGWIN

Examples

asc
CC "AdoScript" SERVICE start port:8080 output:statusbar

CC "AdoScript" SLEEP ms:2000

CC "AdoScript" SERVICE stop
CC "AdoScript" SERVICE start port:8080 output:statusbar

CC "AdoScript" SLEEP ms:2000

CC "AdoScript" SERVICE stop

Starts the webservice server on port 8080 and puts the output in the statusbar (on the bottom of the GUI). Then it waits 2 seconds and stops the services.

Versions and Changes

Available since ADOxx 1.3