introduce-test-ping-app.patch
Signed-off-by: Andy Green <andy@warmcat.com>
diff --git a/README-test-server b/README-test-server
index f10520e..cb9e6b5 100644
--- a/README-test-server
+++ b/README-test-server
@@ -37,6 +37,11 @@
look for trust certificates to validate
the remote certificate against.
+--enable-noping Don't try to build the ping test app
+ It needs some unixy environment that
+ may choke in other build contexts, this
+ lets you cleanly stop it being built
+
Testing server with a browser
-----------------------------
@@ -107,6 +112,53 @@
certificate that it doesn't have a trusted CA cert for.
+Using the websocket ping utility
+--------------------------------
+
+libwebsockets-test-ping connects as a client to a remote
+websocket server using 04 protocol and pings it like the
+normal unix ping utility.
+
+$ libwebsockets-test-ping localhost
+handshake OK for protocol lws-mirror-protocol
+Websocket PING localhost.localdomain (127.0.0.1) 64 bytes of data.
+64 bytes from localhost: req=1 time=0.1ms
+64 bytes from localhost: req=2 time=0.1ms
+64 bytes from localhost: req=3 time=0.1ms
+64 bytes from localhost: req=4 time=0.2ms
+64 bytes from localhost: req=5 time=0.1ms
+64 bytes from localhost: req=6 time=0.2ms
+64 bytes from localhost: req=7 time=0.2ms
+64 bytes from localhost: req=8 time=0.1ms
+^C
+--- localhost.localdomain websocket ping statistics ---
+8 packets transmitted, 8 received, 0% packet loss, time 7458ms
+rtt min/avg/max = 0.110/0.185/0.218 ms
+$
+
+By default it sends 64 byte payload packets using the 04
+PING packet opcode type. You can change the payload size
+using the -s= flag, up to a maximum of 125 mandated by the
+04 standard.
+
+Using the lws-mirror protocol that is provided by the test
+server, libwebsockets-test-ping can also use larger payload
+sizes up to 4096 is BINARY packets; lws-mirror will copy
+them back to the client and they appear as a PONG. Use the
+-m flag to select this operation.
+
+The default interval between pings is 1s, you can use the -i=
+flag to set this, including fractions like -i=0.01 for 10ms
+interval.
+
+Before you can even use the PING opcode that is part of the
+standard, you must complete a handshake with a specified
+protocol. By default lws-mirror-protocol is used which is
+supported by the test server. But if you are using it on
+another server, you can specify the protcol to handshake with
+by --protocol=protocolname
+
+
Websocket version supported
---------------------------