commandportsyntax
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
commandportsyntax [2008/03/06 21:37] – created sestst | commandportsyntax [2018/11/03 02:59] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | {{:: | ||
====== Command Port Syntax ====== | ====== Command Port Syntax ====== | ||
Several parts of the HomeServer accepts commands. The command syntax used on these places is described here. | Several parts of the HomeServer accepts commands. The command syntax used on these places is described here. | ||
Line 9: | Line 10: | ||
Each command response begins with the word //ok// followed by the result or the word //error// followed by an error code and an error string. | Each command response begins with the word //ok// followed by the result or the word //error// followed by an error code and an error string. | ||
- | === Commands === | + | ==== Commands |
The following commands are supported by the command port: | The following commands are supported by the command port: | ||
* **dir** - Returns a list of all instances in the HomeServer. | * **dir** - Returns a list of all instances in the HomeServer. | ||
+ | * **create**,// | ||
* **get**,// | * **get**,// | ||
- | * **set**,// | + | * **set**,// |
- | * **call**// | + | * **call**,//instance name,action name// - Calls the specified method in the specified instance. |
- | * **event**{,// | + | * **rename**,// |
+ | * **exec**,// | ||
+ | * **event**,// | ||
+ | * **subscribe** - Start receive events from the event hub. After this command all events will be distributed over the connection for the duration of the session. Only valid for session based connections. | ||
* **quit** - Closes the session. Only valid for session based command ports. | * **quit** - Closes the session. Only valid for session based command ports. | ||
- | == Examples | + | |
+ | ==== Example 1 Command Port session==== | ||
dir | dir | ||
ok,Event Broker, | ok,Event Broker, | ||
Line 29: | Line 35: | ||
error,2,No Instance specified | error,2,No Instance specified | ||
+ | ==== See also ==== | ||
+ | [[TCPCommandPort]], | ||
commandportsyntax.1204835822.txt.gz · Last modified: 2018/11/03 02:57 (external edit)