f88c5d05f2266d1e360b1a56bb6e64ed2d4d1d9b
[src/app-framework-binder.git] / src / afb-ws-client.h
1 /*
2  * Copyright (C) 2016-2019 "IoT.bzh"
3  * Author: José Bollo <jose.bollo@iot.bzh>
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *   http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #pragma once
19
20 struct afb_wsj1;
21 struct afb_wsj1_itf;
22 struct afb_proto_ws;
23 struct afb_proto_ws_client_itf;
24 struct sd_event;
25
26 /*
27  * Makes the WebSocket handshake at the 'uri' and if successful
28  * instantiate a wsj1 websocket for this connection using 'itf' and 'closure'.
29  * (see afb_wsj1_create).
30  * The systemd event loop 'eloop' is used to handle the websocket.
31  * Returns NULL in case of failure with errno set appropriately.
32  */
33 extern struct afb_wsj1 *afb_ws_client_connect_wsj1(struct sd_event *eloop, const char *uri, struct afb_wsj1_itf *itf, void *closure);
34
35 /*
36  * Establish a websocket-like client connection to the API of 'uri' and if successful
37  * instantiate a client afb_proto_ws websocket for this API using 'itf' and 'closure'.
38  * (see afb_proto_ws_create_client).
39  * The systemd event loop 'eloop' is used to handle the websocket.
40  * Returns NULL in case of failure with errno set appropriately.
41  */
42 extern struct afb_proto_ws *afb_ws_client_connect_api(struct sd_event *eloop, const char *uri, struct afb_proto_ws_client_itf *itf, void *closure);
43