diff options
| author |   José Bollo <jose.bollo@iot.bzh> | 2016-05-29 00:12:00 +0200 |
|---|---|---|
| committer | José Bollo <jose.bollo@iot.bzh> | 2016-05-29 00:17:14 +0200 |
| commit | 6914f7781b42972263a417484bbeb179efe66e78 (patch) | |
| tree | 044bf7bacfaaec9f3db879bf00329f03827e8324 /src/afb-ws-client.h | |
| parent | 1abfd4728490bc20b752313692bdccaa74f13c93 (diff) | |
adds documentation for websocket C clients
Change-Id: I5507aeaf7669123eee16007af3d2fd3faeba8141
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'src/afb-ws-client.h')
| -rw-r--r-- | src/afb-ws-client.h | 6 |
1 files changed, 6 insertions, 0 deletions
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); |