diff options
| author | Adam Ierymenko <adam.ierymenko@gmail.com> | 2013-07-18 16:35:52 -0400 |
|---|---|---|
| committer | Adam Ierymenko <adam.ierymenko@gmail.com> | 2013-07-18 16:35:52 -0400 |
| commit | 5f4eb1ebc60abdd762bc77ef5b1120fe528ccc8f (patch) | |
| tree | 6c42c048c0671c1e697bf677066de3b4a53ad945 /node/Node.hpp | |
| parent | c345c699fd90cbad1ceda6226475d9a27ae47072 (diff) | |
| download | infinitytier-5f4eb1ebc60abdd762bc77ef5b1120fe528ccc8f.tar.gz infinitytier-5f4eb1ebc60abdd762bc77ef5b1120fe528ccc8f.zip | |
Command line interface.
Diffstat (limited to 'node/Node.hpp')
| -rw-r--r-- | node/Node.hpp | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/node/Node.hpp b/node/Node.hpp index bddced58..b716b556 100644 --- a/node/Node.hpp +++ b/node/Node.hpp @@ -49,11 +49,6 @@ public: /** * Create a new node config client * - * The result handler will be called from a different thread. Its - * arguments are the request ID generated by send() and each line - * of output. It may be called more than once per request result - * if the command generates more than one line of output. - * * @param authToken Authentication token * @param resultHandler Function to call when commands provide results */ @@ -65,8 +60,12 @@ public: /** * Send a command to the local node * + * Note that the returned conversation ID will never be 0. A return value + * of 0 indicates a fatal error such as failure to bind to any local UDP + * port. + * * @param command - * @return Request ID that will be provided to result handler when/if results are sent back + * @return Conversation ID that will be provided to result handler when/if results are sent back */ unsigned long send(const char *command) throw(); |
