2 * Copyright 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.
30 #include "utils-upoll.h"
33 * declaration of the websock interface for afb-ws
35 static ssize_t aws_writev(struct afb_ws *ws, const struct iovec *iov, int iovcnt);
36 static ssize_t aws_readv(struct afb_ws *ws, const struct iovec *iov, int iovcnt);
37 static void aws_on_close(struct afb_ws *ws, uint16_t code, size_t size);
38 static void aws_on_text(struct afb_ws *ws, int last, size_t size);
39 static void aws_on_binary(struct afb_ws *ws, int last, size_t size);
40 static void aws_on_continue(struct afb_ws *ws, int last, size_t size);
41 static void aws_on_readable(struct afb_ws *ws);
42 static void aws_on_error(struct afb_ws *ws, uint16_t code, const void *data, size_t size);
44 static struct websock_itf aws_itf = {
45 .writev = (void*)aws_writev,
46 .readv = (void*)aws_readv,
50 .on_close = (void*)aws_on_close,
51 .on_text = (void*)aws_on_text,
52 .on_binary = (void*)aws_on_binary,
53 .on_continue = (void*)aws_on_continue,
56 .on_error = (void*)aws_on_error
60 * a common scheme of buffer handling
79 * the afb_ws structure
83 int fd; /* the socket file descriptor */
84 enum state state; /* current state */
85 const struct afb_ws_itf *itf; /* the callback interface */
86 void *closure; /* closure when calling the callbacks */
87 struct websock *ws; /* the websock handler */
88 struct upoll *up; /* the upoll handler for the socket */
89 struct buf buffer; /* the last read fragment */
93 * Returns the current buffer of 'ws' that is reset.
95 static inline struct buf aws_pick_buffer(struct afb_ws *ws)
97 struct buf result = ws->buffer;
98 ws->buffer.buffer = NULL;
104 * Disconnect the websocket 'ws' and calls on_hangup if
105 * 'call_on_hangup' is not null.
107 static void aws_disconnect(struct afb_ws *ws, int call_on_hangup)
109 struct websock *wsi = ws->ws;
114 websock_destroy(wsi);
115 free(aws_pick_buffer(ws).buffer);
117 if (call_on_hangup && ws->itf->on_hangup)
118 ws->itf->on_hangup(ws->closure);
123 * Creates the afb_ws structure for the file descritor
124 * 'fd' and the callbacks described by the interface 'itf'
127 * Returns the handle for the afb_ws created or NULL on error.
129 struct afb_ws *afb_ws_create(int fd, const struct afb_ws_itf *itf, void *closure)
131 struct afb_ws *result;
136 result = malloc(sizeof * result);
142 result->state = waiting;
144 result->closure = closure;
145 result->buffer.buffer = NULL;
146 result->buffer.size = 0;
148 /* creates the websocket */
149 result->ws = websock_create_v13(&aws_itf, result);
150 if (result->ws == NULL)
153 /* creates the upoll */
154 result->up = upoll_open(result->fd, result);
155 if (result->up == NULL)
159 upoll_on_readable(result->up, (void*)aws_on_readable);
160 upoll_on_hangup(result->up, (void*)afb_ws_hangup);
165 websock_destroy(result->ws);
173 * Destroys the websocket 'ws'
174 * It first hangup (but without calling on_hangup for safety reasons)
177 void afb_ws_destroy(struct afb_ws *ws)
179 aws_disconnect(ws, 0);
184 * Hangup the websocket 'ws'
186 void afb_ws_hangup(struct afb_ws *ws)
188 aws_disconnect(ws, 1);
192 * Sends a 'close' command to the endpoint of 'ws' with the 'code' and the
193 * 'reason' (that can be NULL and that else should not be greater than 123
195 * Returns 0 on success or -1 in case of error.
197 int afb_ws_close(struct afb_ws *ws, uint16_t code, const char *reason)
199 if (ws->ws == NULL) {
204 return websock_close(ws->ws, code, reason, reason == NULL ? 0 : strlen(reason));
208 * Sends a 'close' command to the endpoint of 'ws' with the 'code' and the
209 * 'reason' (that can be NULL and that else should not be greater than 123
211 * Raise an error after 'close' command is sent.
212 * Returns 0 on success or -1 in case of error.
214 int afb_ws_error(struct afb_ws *ws, uint16_t code, const char *reason)
216 if (ws->ws == NULL) {
221 return websock_error(ws->ws, code, reason, reason == NULL ? 0 : strlen(reason));
225 * Sends a 'text' of 'length' to the endpoint of 'ws'.
226 * Returns 0 on success or -1 in case of error.
228 int afb_ws_text(struct afb_ws *ws, const char *text, size_t length)
230 if (ws->ws == NULL) {
235 return websock_text(ws->ws, 1, text, length);
239 * Sends a binary 'data' of 'length' to the endpoint of 'ws'.
240 * Returns 0 on success or -1 in case of error.
242 int afb_ws_binary(struct afb_ws *ws, const void *data, size_t length)
244 if (ws->ws == NULL) {
249 return websock_binary(ws->ws, 1, data, length);
253 * callback for writing data
255 static ssize_t aws_writev(struct afb_ws *ws, const struct iovec *iov, int iovcnt)
259 rc = writev(ws->fd, iov, iovcnt);
260 } while(rc == -1 && errno == EINTR);
265 * callback for reading data
267 static ssize_t aws_readv(struct afb_ws *ws, const struct iovec *iov, int iovcnt)
271 rc = readv(ws->fd, iov, iovcnt);
272 } while(rc == -1 && errno == EINTR);
281 * callback on incoming data
283 static void aws_on_readable(struct afb_ws *ws)
287 assert(ws->ws != NULL);
288 rc = websock_dispatch(ws->ws);
289 if (rc < 0 && errno == EPIPE)
294 * Reads from the websocket handled by 'ws' data of length 'size'
295 * and append it to the current buffer of 'ws'.
296 * Returns 0 in case of error or 1 in case of success.
298 static int aws_read(struct afb_ws *ws, size_t size)
304 buffer = realloc(ws->buffer.buffer, ws->buffer.size + size + 1);
307 ws->buffer.buffer = buffer;
308 sz = websock_read(ws->ws, &buffer[ws->buffer.size], size);
309 if ((size_t)sz != size)
311 ws->buffer.size += size;
317 * Callback when 'close' command received from 'ws' with 'code' and 'size'.
319 static void aws_on_close(struct afb_ws *ws, uint16_t code, size_t size)
324 free(aws_pick_buffer(ws).buffer);
325 if (ws->itf->on_close == NULL) {
326 websock_drop(ws->ws);
328 } else if (!aws_read(ws, size))
329 ws->itf->on_close(ws->closure, code, NULL, 0);
331 b = aws_pick_buffer(ws);
332 ws->itf->on_close(ws->closure, code, b.buffer, b.size);
337 * Drops any incoming data and send an error of 'code'
339 static void aws_drop_error(struct afb_ws *ws, uint16_t code)
342 free(aws_pick_buffer(ws).buffer);
343 websock_drop(ws->ws);
344 websock_error(ws->ws, code, NULL, 0);
348 * Reads either text or binary data of 'size' from 'ws' eventually 'last'.
350 static void aws_continue(struct afb_ws *ws, int last, size_t size)
355 if (!aws_read(ws, size))
356 aws_drop_error(ws, WEBSOCKET_CODE_ABNORMAL);
358 istxt = ws->state == reading_text;
360 b = aws_pick_buffer(ws);
361 b.buffer[b.size] = 0;
362 (istxt ? ws->itf->on_text : ws->itf->on_binary)(ws->closure, b.buffer, b.size);
367 * Callback when 'text' message received from 'ws' with 'size' and possibly 'last'.
369 static void aws_on_text(struct afb_ws *ws, int last, size_t size)
371 if (ws->state != waiting)
372 aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
373 else if (ws->itf->on_text == NULL)
374 aws_drop_error(ws, WEBSOCKET_CODE_CANT_ACCEPT);
376 ws->state = reading_text;
377 aws_continue(ws, last, size);
382 * Callback when 'binary' message received from 'ws' with 'size' and possibly 'last'.
384 static void aws_on_binary(struct afb_ws *ws, int last, size_t size)
386 if (ws->state != waiting)
387 aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
388 else if (ws->itf->on_binary == NULL)
389 aws_drop_error(ws, WEBSOCKET_CODE_CANT_ACCEPT);
391 ws->state = reading_binary;
392 aws_continue(ws, last, size);
397 * Callback when 'close' command received from 'ws' with 'code' and 'size'.
399 static void aws_on_continue(struct afb_ws *ws, int last, size_t size)
401 if (ws->state == waiting)
402 aws_drop_error(ws, WEBSOCKET_CODE_PROTOCOL_ERROR);
404 aws_continue(ws, last, size);
408 * Callback when 'close' command is sent to 'ws' with 'code' and 'size'.
410 static void aws_on_error(struct afb_ws *ws, uint16_t code, const void *data, size_t size)
412 if (ws->itf->on_error != NULL)
413 ws->itf->on_error(ws->closure, code, data, size);