Update copyright dates
[src/app-framework-binder.git] / src / websock.h
index 6376a37..5066333 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 iot.bzh
+ * Copyright (C) 2015-2020 "IoT.bzh"
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  *   Copyright 2010-2012 self.disconnect (APACHE-2)
  */
 
+#pragma once
+
 struct iovec;
 
-#define WEBSOCKET_CODE_UNSET                0
 #define WEBSOCKET_CODE_OK                1000
 #define WEBSOCKET_CODE_GOING_AWAY        1001
 #define WEBSOCKET_CODE_PROTOCOL_ERROR    1002
-#define WEBSOCKET_CODE_RESERVED          1004  /* Protocol 8: frame too large */
+#define WEBSOCKET_CODE_CANT_ACCEPT       1003
+#define WEBSOCKET_CODE_RESERVED          1004
+#define WEBSOCKET_CODE_NOT_SET           1005
+#define WEBSOCKET_CODE_ABNORMAL          1006
 #define WEBSOCKET_CODE_INVALID_UTF8      1007
 #define WEBSOCKET_CODE_POLICY_VIOLATION  1008
 #define WEBSOCKET_CODE_MESSAGE_TOO_LARGE 1009
@@ -36,32 +40,42 @@ struct iovec;
 struct websock_itf {
        ssize_t (*writev) (void *, const struct iovec *, int);
        ssize_t (*readv) (void *, const struct iovec *, int);
-       void (*disconnect) (void *);
 
-       void (*on_ping) (void *); /* if not NULL, responsible of pong */
-       void (*on_pong) (void *);
+       void (*on_ping) (void *, size_t size); /* optional, if not NULL, responsible of pong */
+       void (*on_pong) (void *, size_t size); /* optional */
        void (*on_close) (void *, uint16_t code, size_t size);
        void (*on_text) (void *, int last, size_t size);
        void (*on_binary) (void *, int last, size_t size);
        void (*on_continue) (void *, int last, size_t size);
        int (*on_extension) (void *, int last, int rsv1, int rsv2, int rsv3, int opcode, size_t size);
+
+       void (*on_error) (void *, uint16_t code, const void *data, size_t size); /* optional */
 };
 
 struct websock;
 
-void websock_close(struct websock *ws);
-void websock_close_code(struct websock *ws, uint16_t code);
+extern int websock_close_empty(struct websock *ws);
+extern int websock_close(struct websock *ws, uint16_t code, const void *data, size_t length);
+extern int websock_error(struct websock *ws, uint16_t code, const void *data, size_t length);
+
+extern int websock_ping(struct websock *ws, const void *data, size_t length);
+extern int websock_pong(struct websock *ws, const void *data, size_t length);
+extern int websock_text(struct websock *ws, int last, const void *text, size_t length);
+extern int websock_text_v(struct websock *ws, int last, const struct iovec *iovec, int count);
+extern int websock_binary(struct websock *ws, int last, const void *data, size_t length);
+extern int websock_binary_v(struct websock *ws, int last, const struct iovec *iovec, int count);
+extern int websock_continue(struct websock *ws, int last, const void *data, size_t length);
+extern int websock_continue_v(struct websock *ws, int last, const struct iovec *iovec, int count);
 
-void websock_ping(struct websock *ws);
-void websock_pong(struct websock *ws);
-void websock_text(struct websock *ws, const char *text, size_t length);
-void websock_binary(struct websock *ws, const void *data, size_t length);
+extern ssize_t websock_read(struct websock *ws, void *buffer, size_t size);
+extern int websock_drop(struct websock *ws);
 
-ssize_t websock_read(struct websock *ws, void *buffer, size_t size);
-void websock_drop(struct websock *ws);
+extern int websock_dispatch(struct websock *ws, int loop);
 
-int websock_dispatch(struct websock *ws);
+extern struct websock *websock_create_v13(const struct websock_itf *itf, void *closure);
+extern void websock_destroy(struct websock *ws);
 
-struct websock *websock_create_v13(const struct websock_itf *itf, void *closure);
-void websock_destroy(struct websock *ws);
+extern void websock_set_default_max_length(size_t maxlen);
+extern void websock_set_max_length(struct websock *ws, size_t maxlen);
 
+extern const char *websocket_explain_error(uint16_t code);