2 * Copyright (C) 2016 "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.
26 * Interface for callback functions.
27 * The received closure is the closure passed when creating the afb_wsj1
28 * socket using afb_wsj1_create.
32 * This function is called on hangup.
33 * Receives the 'closure' and the handle 'wsj1'
35 void (*on_hangup)(void *closure, struct afb_wsj1 *wsj1);
38 * This function is called on incoming call.
39 * Receives the 'closure'
41 void (*on_call)(void *closure, const char *api, const char *verb, struct afb_wsj1_msg *msg);
44 * This function is called on incoming event
46 void (*on_event)(void *closure, const char *event, struct afb_wsj1_msg *msg);
50 * Creates the afb_wsj1 socket connected to the file descriptor 'fd'
51 * and having the callback interface defined by 'itf' for the 'closure'.
52 * Returns the created wsj1 websocket or NULL in case of error.
54 extern struct afb_wsj1 *afb_wsj1_create(int fd, struct afb_wsj1_itf *itf, void *closure);
57 * Increases by one the count of reference to 'wsj1'
59 extern void afb_wsj1_addref(struct afb_wsj1 *wsj1);
62 * Decreases by one the count of reference to 'wsj1'
63 * and if it falls to zero releases the used resources
66 extern void afb_wsj1_unref(struct afb_wsj1 *wsj1);
69 * Sends a close message to the websocket of 'wsj1'.
70 * The close message is sent with the 'code' and 'text'.
72 * Return 0 in case of success. Otherwise, returns -1 and set errno.
74 extern int afb_wsj1_close(struct afb_wsj1 *wsj1, uint16_t code, const char *text);
77 * Sends on 'wsj1' the event of name 'event' with the
78 * data 'object'. If not NULL, 'object' should be a valid
80 * Return 0 in case of success. Otherwise, returns -1 and set errno.
82 extern int afb_wsj1_send_event_s(struct afb_wsj1 *wsj1, const char *event, const char *object);
85 * Sends on 'wsj1' the event of name 'event' with the
86 * data 'object'. 'object' can be NULL.
87 * 'object' is dereferenced using 'json_object_put'. Use 'json_object_get' to keep it.
88 * Return 0 in case of success. Otherwise, returns -1 and set errno.
90 extern int afb_wsj1_send_event_j(struct afb_wsj1 *wsj1, const char *event, struct json_object *object);
93 * Sends on 'wsj1' a call to the method of 'api'/'verb' with arguments
94 * given by 'object'. If not NULL, 'object' should be a valid JSON string.
95 * On receiving the reply, the function 'on_reply' is called with 'closure'
96 * as its first argument and the message of the reply.
97 * Return 0 in case of success. Otherwise, returns -1 and set errno.
99 extern int afb_wsj1_call_s(struct afb_wsj1 *wsj1, const char *api, const char *verb, const char *object, void (*on_reply)(void *closure, struct afb_wsj1_msg *msg), void *closure);
102 * Sends on 'wsj1' a call to the method of 'api'/'verb' with arguments
103 * given by 'object'. 'object' can be NULL.
104 * 'object' is dereferenced using 'json_object_put'. Use 'json_object_get' to keep it.
105 * On receiving the reply, the function 'on_reply' is called with 'closure'
106 * as its first argument and the message of the reply.
107 * Return 0 in case of success. Otherwise, returns -1 and set errno.
109 extern int afb_wsj1_call_j(struct afb_wsj1 *wsj1, const char *api, const char *verb, struct json_object *object, void (*on_reply)(void *closure, struct afb_wsj1_msg *msg), void *closure);
112 * Sends for message 'msg' the reply with the 'object' and, if not NULL, the token.
113 * When 'iserror' is zero a OK reply is send, otherwise an ERROR reply is sent.
114 * If not NULL, 'object' should be a valid JSON string.
115 * Return 0 in case of success. Otherwise, returns -1 and set errno.
117 extern int afb_wsj1_reply_s(struct afb_wsj1_msg *msg, const char *object, const char *token, int iserror);
120 * Sends for message 'msg' the reply with the 'object' and, if not NULL, the token.
121 * When 'iserror' is zero a OK reply is send, otherwise an ERROR reply is sent.
122 * 'object' can be NULL.
123 * 'object' is dereferenced using 'json_object_put'. Use 'json_object_get' to keep it.
124 * Return 0 in case of success. Otherwise, returns -1 and set errno.
126 extern int afb_wsj1_reply_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token, int iserror);
129 * Sends for message 'msg' the OK reply with the 'object' and, if not NULL, the token.
130 * If not NULL, 'object' should be a valid JSON string.
131 * Return 0 in case of success. Otherwise, returns -1 and set errno.
133 static inline int afb_wsj1_reply_ok_s(struct afb_wsj1_msg *msg, const char *object, const char *token)
135 return afb_wsj1_reply_s(msg, object, token, 0);
139 * Sends for message 'msg' the OK reply with the 'object' and, if not NULL, the token.
140 * 'object' can be NULL.
141 * 'object' is dereferenced using 'json_object_put'. Use 'json_object_get' to keep it.
142 * Return 0 in case of success. Otherwise, returns -1 and set errno.
144 static inline int afb_wsj1_reply_ok_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token)
146 return afb_wsj1_reply_j(msg, object, token, 0);
150 * Sends for message 'msg' the ERROR reply with the 'object' and, if not NULL, the token.
151 * If not NULL, 'object' should be a valid JSON string.
152 * Return 0 in case of success. Otherwise, returns -1 and set errno.
154 static inline int afb_wsj1_reply_error_s(struct afb_wsj1_msg *msg, const char *object, const char *token)
156 return afb_wsj1_reply_s(msg, object, token, 1);
160 * Sends for message 'msg' the ERROR reply with the 'object' and, if not NULL, the token.
161 * 'object' can be NULL.
162 * 'object' is dereferenced using 'json_object_put'. Use 'json_object_get' to keep it.
163 * Return 0 in case of success. Otherwise, returns -1 and set errno.
165 static inline int afb_wsj1_reply_error_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token)
167 return afb_wsj1_reply_j(msg, object, token, 1);
171 * Increases by one the count of reference to 'msg'.
172 * Should be called if callbacks stores the message.
174 extern void afb_wsj1_msg_addref(struct afb_wsj1_msg *msg);
177 * Decreases by one the count of reference to 'msg'.
178 * and if it falls to zero releases the used resources
179 * and free the memory.
180 * Should be called if 'afb_wsj1_msg_addref' was called.
182 extern void afb_wsj1_msg_unref(struct afb_wsj1_msg *msg);
185 * Returns 1 if 'msg' is for a CALL
186 * Otherwise returns 0.
188 extern int afb_wsj1_msg_is_call(struct afb_wsj1_msg *msg);
191 * Returns 1 if 'msg' is for a REPLY of any kind
192 * Otherwise returns 0.
194 extern int afb_wsj1_msg_is_reply(struct afb_wsj1_msg *msg);
197 * Returns 1 if 'msg' is for a REPLY OK
198 * Otherwise returns 0.
200 extern int afb_wsj1_msg_is_reply_ok(struct afb_wsj1_msg *msg);
203 * Returns 1 if 'msg' is for a REPLY ERROR
204 * Otherwise returns 0.
206 extern int afb_wsj1_msg_is_reply_error(struct afb_wsj1_msg *msg);
209 * Returns 1 if 'msg' is for an EVENT
210 * Otherwise returns 0.
212 extern int afb_wsj1_msg_is_event(struct afb_wsj1_msg *msg);
215 * Returns the api of the call for 'msg'
216 * Returns NULL if 'msg' is not for a CALL
218 extern const char *afb_wsj1_msg_api(struct afb_wsj1_msg *msg);
221 * Returns the verb call for 'msg'
222 * Returns NULL if 'msg' is not for a CALL
224 extern const char *afb_wsj1_msg_verb(struct afb_wsj1_msg *msg);
227 * Returns the event name for 'msg'
228 * Returns NULL if 'msg' is not for an EVENT
230 extern const char *afb_wsj1_msg_event(struct afb_wsj1_msg *msg);
233 * Returns the token sent with 'msg' or NULL when no token was sent.
235 extern const char *afb_wsj1_msg_token(struct afb_wsj1_msg *msg);
238 * Returns the wsj1 of 'msg'
240 extern struct afb_wsj1 *afb_wsj1_msg_wsj1(struct afb_wsj1_msg *msg);
243 * Returns the string representation of the object received with 'msg'
245 extern const char *afb_wsj1_msg_object_s(struct afb_wsj1_msg *msg);
248 * Returns the object received with 'msg'
250 extern struct json_object *afb_wsj1_msg_object_j(struct afb_wsj1_msg *msg);