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 on 'wsj1' the event of name 'event' with the
70 * data 'object'. If not NULL, 'object' should be a valid
72 * Return 0 in case of success. Otherwise, returns -1 and set errno.
74 extern int afb_wsj1_send_event_s(struct afb_wsj1 *wsj1, const char *event, const char *object);
77 * Sends on 'wsj1' the event of name 'event' with the
78 * data 'object'. 'object' can be NULL.
79 * Return 0 in case of success. Otherwise, returns -1 and set errno.
81 extern int afb_wsj1_send_event_j(struct afb_wsj1 *wsj1, const char *event, struct json_object *object);
84 * Sends on 'wsj1' a call to the method of 'api'/'verb' with arguments
85 * given by 'object'. If not NULL, 'object' should be a valid JSON string.
86 * On receiving the reply, the function 'on_reply' is called with 'closure'
87 * as its first argument and the message of the reply.
88 * Return 0 in case of success. Otherwise, returns -1 and set errno.
90 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);
93 * Sends on 'wsj1' a call to the method of 'api'/'verb' with arguments
94 * given by 'object'. 'object' can be NULL.
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_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);
102 * Sends for message 'msg' the OK reply with the 'object' and, if not NULL, the token.
103 * If not NULL, 'object' should be a valid JSON string.
104 * Return 0 in case of success. Otherwise, returns -1 and set errno.
106 extern int afb_wsj1_reply_ok_s(struct afb_wsj1_msg *msg, const char *object, const char *token);
109 * Sends for message 'msg' the OK reply with the 'object' and, if not NULL, the token.
110 * 'object' can be NULL.
111 * Return 0 in case of success. Otherwise, returns -1 and set errno.
113 extern int afb_wsj1_reply_ok_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token);
116 * Sends for message 'msg' the ERROR reply with the 'object' and, if not NULL, the token.
117 * If not NULL, 'object' should be a valid JSON string.
118 * Return 0 in case of success. Otherwise, returns -1 and set errno.
120 extern int afb_wsj1_reply_error_s(struct afb_wsj1_msg *msg, const char *object, const char *token);
123 * Sends for message 'msg' the ERROR reply with the 'object' and, if not NULL, the token.
124 * 'object' can be NULL.
125 * Return 0 in case of success. Otherwise, returns -1 and set errno.
127 extern int afb_wsj1_reply_error_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token);
130 * Increases by one the count of reference to 'msg'.
131 * Should be called if callbacks stores the message.
133 extern void afb_wsj1_msg_addref(struct afb_wsj1_msg *msg);
136 * Decreases by one the count of reference to 'msg'.
137 * and if it falls to zero releases the used resources
138 * and free the memory.
139 * Should be called if 'afb_wsj1_msg_addref' was called.
141 extern void afb_wsj1_msg_unref(struct afb_wsj1_msg *msg);
144 * Returns 1 if 'msg' is for a CALL
145 * Otherwise returns 0.
147 extern int afb_wsj1_msg_is_call(struct afb_wsj1_msg *msg);
150 * Returns 1 if 'msg' is for a REPLY of any kind
151 * Otherwise returns 0.
153 extern int afb_wsj1_msg_is_reply(struct afb_wsj1_msg *msg);
156 * Returns 1 if 'msg' is for a REPLY OK
157 * Otherwise returns 0.
159 extern int afb_wsj1_msg_is_reply_ok(struct afb_wsj1_msg *msg);
162 * Returns 1 if 'msg' is for a REPLY ERROR
163 * Otherwise returns 0.
165 extern int afb_wsj1_msg_is_reply_error(struct afb_wsj1_msg *msg);
168 * Returns 1 if 'msg' is for an EVENT
169 * Otherwise returns 0.
171 extern int afb_wsj1_msg_is_event(struct afb_wsj1_msg *msg);
174 * Returns the api of the call for 'msg'
175 * Returns NULL if 'msg' is not for a CALL
177 extern const char *afb_wsj1_msg_api(struct afb_wsj1_msg *msg);
180 * Returns the verb call for 'msg'
181 * Returns NULL if 'msg' is not for a CALL
183 extern const char *afb_wsj1_msg_verb(struct afb_wsj1_msg *msg);
186 * Returns the event name for 'msg'
187 * Returns NULL if 'msg' is not for an EVENT
189 extern const char *afb_wsj1_msg_event(struct afb_wsj1_msg *msg);
192 * Returns the token sent with 'msg' or NULL when no token was sent.
194 extern const char *afb_wsj1_msg_token(struct afb_wsj1_msg *msg);
197 * Returns the wsj1 of 'msg'
199 extern struct afb_wsj1 *afb_wsj1_msg_wsj1(struct afb_wsj1_msg *msg);
202 * Returns the string representation of the object received with 'msg'
204 extern const char *afb_wsj1_msg_object_s(struct afb_wsj1_msg *msg);
207 * Returns the object received with 'msg'
209 extern struct json_object *afb_wsj1_msg_object_j(struct afb_wsj1_msg *msg);