X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fafb-ws-client.h;fp=src%2Fafb-ws-client.h;h=f2aee7d07168f774e4e3cff1b73f39e03617d10d;hb=6914f7781b42972263a417484bbeb179efe66e78;hp=125bd6f3d87e54f8f402becaa99e4f79489661a1;hpb=1abfd4728490bc20b752313692bdccaa74f13c93;p=src%2Fapp-framework-binder.git

diff --git a/src/afb-ws-client.h b/src/afb-ws-client.h
index 125bd6f3..f2aee7d0 100644
--- 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);