adds documentation for websocket C clients

[src/app-framework-binder.git] / src / afb-ws-client.h

diff --git a/src/afb-ws-client.h b/src/afb-ws-client.h
index 125bd6f..f2aee7d 100644 (file)
--- a/src/afb-ws-client.h
+++ b/src/afb-ws-client.h
@@ -20,4 +20,10 @@
 struct afb_wsj1;
 struct afb_wsj1_itf;
 
+/*
+ * Makes the WebSocket handshake at the 'uri' and if successful
+ * instanciate a wsj1 websocket for this connection using 'itf' and 'closure'.
+ * (see afb_wsj1_create).
+ * Returns NULL in case of failure with errno set appriately.
+ */
 extern struct afb_wsj1 *afb_ws_client_connect_wsj1(const char *uri, struct afb_wsj1_itf *itf, void *closure);