summaryrefslogtreecommitdiff
path: root/examples/webchannel/qwclient/README
diff options
context:
space:
mode:
authorSumedha Widyadharma <sumedha.widyadharma@basyskom.com>2014-08-08 11:07:46 +0200
committerMilian Wolff <milian.wolff@kdab.com>2014-09-19 16:38:45 +0200
commit46fc950424f9dedf014176153249d2f29bee8659 (patch)
tree0b2ff0076d640e68fdfb82b13a19ea57918d0b93 /examples/webchannel/qwclient/README
parentbcbaa596815caf53c80f4a5220fb008000b3d897 (diff)
downloadqtwebchannel-46fc950424f9dedf014176153249d2f29bee8659.tar.gz
Added a generic node.js debug client as an example
qwclient can connect to any qwebchannel server using a websocket transport. The service can then be used through a REPL. It can, for instance, be used with the standalone example server. Change-Id: Ie73d19b0376caf2fcf6ae02ec19a56e27bddfd33 Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
Diffstat (limited to 'examples/webchannel/qwclient/README')
-rw-r--r--examples/webchannel/qwclient/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/examples/webchannel/qwclient/README b/examples/webchannel/qwclient/README
new file mode 100644
index 0000000..2b90427
--- /dev/null
+++ b/examples/webchannel/qwclient/README
@@ -0,0 +1,18 @@
+A REPL client for any qwebchannel service using a websocket transport.
+
+A nice tool for testing qwebchannel endpoints.
+
+Install:
+ - qmake && make from the qwebchannel sources or examples.
+ - npm install
+
+Usage:
+ - qwclient.js <autoconnect server>
+ - openChannel(url) in the REPL to open a new connection, multiple channels are OK
+ - channel object lists are aliased to c<channelnumber> i.e. c0, c1, ...
+
+ Example using the standalone example server:
+ - Launch standalone example server
+ - qwclient localhost:12345
+ - c0.receiveText('test')
+ - 'test' should be displayed in the standalone server UI