2 * Copyright (C) 2016, 2017, 2018 "IoT.bzh"
3 * Author: José Bollo <jose.bollo@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * Defined since version 3, the value AFB_PROTO_WS_VERSION can be used to
23 * track versions of afb-proto-ws.
25 #define AFB_PROTO_WS_VERSION 3
29 struct afb_proto_ws_call;
30 struct afb_proto_ws_describe;
32 struct afb_proto_ws_client_itf
35 void (*on_reply)(void *closure, void *request, struct json_object *obj, const char *error, const char *info);
38 void (*on_event_create)(void *closure, const char *event_name, int event_id);
39 void (*on_event_remove)(void *closure, const char *event_name, int event_id);
40 void (*on_event_subscribe)(void *closure, void *request, const char *event_name, int event_id);
41 void (*on_event_unsubscribe)(void *closure, void *request, const char *event_name, int event_id);
42 void (*on_event_push)(void *closure, const char *event_name, int event_id, struct json_object *data);
43 void (*on_event_broadcast)(void *closure, const char *event_name, struct json_object *data);
46 struct afb_proto_ws_server_itf
48 void (*on_call)(void *closure, struct afb_proto_ws_call *call, const char *verb, struct json_object *args, const char *sessionid, const char *user_creds);
49 void (*on_describe)(void *closure, struct afb_proto_ws_describe *describe);
52 extern struct afb_proto_ws *afb_proto_ws_create_client(struct fdev *fdev, const struct afb_proto_ws_client_itf *itf, void *closure);
53 extern struct afb_proto_ws *afb_proto_ws_create_server(struct fdev *fdev, const struct afb_proto_ws_server_itf *itf, void *closure);
55 extern void afb_proto_ws_unref(struct afb_proto_ws *protows);
56 extern void afb_proto_ws_addref(struct afb_proto_ws *protows);
58 extern int afb_proto_ws_is_client(struct afb_proto_ws *protows);
59 extern int afb_proto_ws_is_server(struct afb_proto_ws *protows);
61 extern void afb_proto_ws_hangup(struct afb_proto_ws *protows);
62 extern void afb_proto_ws_on_hangup(struct afb_proto_ws *protows, void (*on_hangup)(void *closure));
66 extern int afb_proto_ws_client_call(struct afb_proto_ws *protows, const char *verb, struct json_object *args, const char *sessionid, void *request, const char *user_creds);
67 extern int afb_proto_ws_client_describe(struct afb_proto_ws *protows, void (*callback)(void*, struct json_object*), void *closure);
69 extern int afb_proto_ws_server_event_create(struct afb_proto_ws *protows, const char *event_name, int event_id);
70 extern int afb_proto_ws_server_event_remove(struct afb_proto_ws *protows, const char *event_name, int event_id);
71 extern int afb_proto_ws_server_event_push(struct afb_proto_ws *protows, const char *event_name, int event_id, struct json_object *data);
72 extern int afb_proto_ws_server_event_broadcast(struct afb_proto_ws *protows, const char *event_name, struct json_object *data);
74 extern void afb_proto_ws_call_addref(struct afb_proto_ws_call *call);
75 extern void afb_proto_ws_call_unref(struct afb_proto_ws_call *call);
77 extern int afb_proto_ws_call_reply(struct afb_proto_ws_call *call, struct json_object *obj, const char *error, const char *info);
79 extern int afb_proto_ws_call_subscribe(struct afb_proto_ws_call *call, const char *event_name, int event_id);
80 extern int afb_proto_ws_call_unsubscribe(struct afb_proto_ws_call *call, const char *event_name, int event_id);
82 extern int afb_proto_ws_describe_put(struct afb_proto_ws_describe *describe, struct json_object *description);