X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fafb-ws-client.h;h=f2aee7d07168f774e4e3cff1b73f39e03617d10d;hb=9ee05e42384b34d8626cd8cccfd50538136f369f;hp=2117bb8cd456b628a40f226baf88c47f1bbac628;hpb=146f95b776c7a424e672b27386fbb8392bc0ffb7;p=src%2Fapp-framework-binder.git

diff --git a/src/afb-ws-client.h b/src/afb-ws-client.h
index 2117bb8c..f2aee7d0 100644
--- a/src/afb-ws-client.h
+++ b/src/afb-ws-client.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 IoT.bzh
+ * Copyright (C) 2016 "IoT.bzh"
  * Author: José Bollo <jose.bollo@iot.bzh>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -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);