Engine.command
(→Examples) |
|||
| Line 37: | Line 37: | ||
"sip^Iss7" | "sip^Iss7" | ||
| + | |||
| + | |||
| + | '''See also''' | ||
| + | |||
| + | * [[engine.status]] | ||
| + | * [[engine.timer]] | ||
| + | * [[engine.cipher]] | ||
| + | * [[module.update]] | ||
Latest revision as of 17:56, 18 January 2013
This message is used to send commands from the Remote Manager or from the command line. An alternative form of this message is used to perform command line completion.
This message is always dispatched synchronously.
[edit] Mandatory parameters
line
- the text of the command line supplied from Remote Manager. If this parameter is missing the message requests a line completion
partial
- the partial line that should be completed
partline
- the partial line without the last, incomplete, word
partword
- the partial word that is currently completed
[edit] Return value
A module that handles the command should acknowledge the message. This is not required for command completion.
The textual return value is displayed either to the requesting remote client or to the logging output (for commands placed on the command line). The lines must be terminated by CR LF (DOS style). For completion requests a list of tab-separated suitable matches should be returned.
[edit] Examples
"line"="debug sip level 8"
returns:
"Module sip debug on level 8^M^J"
"partial"="debug s"
"partline"="debug"
"partword"="s"
returns:
"sip^Iss7"
See also
