Andy Green | a0da8a8 | 2010-11-08 17:12:19 +0000 | [diff] [blame] | 1 | /* |
| 2 | * libwebsockets - small server side websockets and web server implementation |
Andy Green | e77ddd8 | 2010-11-13 10:03:47 +0000 | [diff] [blame] | 3 | * |
Andy Green | 7b40545 | 2013-02-01 10:50:15 +0800 | [diff] [blame] | 4 | * Copyright (C) 2010-2013 Andy Green <andy@warmcat.com> |
Andy Green | a0da8a8 | 2010-11-08 17:12:19 +0000 | [diff] [blame] | 5 | * |
| 6 | * This library is free software; you can redistribute it and/or |
| 7 | * modify it under the terms of the GNU Lesser General Public |
| 8 | * License as published by the Free Software Foundation: |
| 9 | * version 2.1 of the License. |
| 10 | * |
| 11 | * This library is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 14 | * Lesser General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU Lesser General Public |
| 17 | * License along with this library; if not, write to the Free Software |
| 18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, |
| 19 | * MA 02110-1301 USA |
| 20 | */ |
| 21 | |
Andy Green | ab990e4 | 2010-10-31 12:42:52 +0000 | [diff] [blame] | 22 | #ifndef __LIBWEBSOCKET_H__ |
| 23 | #define __LIBWEBSOCKET_H__ |
| 24 | |
Andy Green | a11fe94 | 2011-09-25 10:30:26 +0100 | [diff] [blame] | 25 | #ifdef __cplusplus |
| 26 | extern "C" { |
Paulo Roberto Urio | 4144e83 | 2012-06-04 09:04:33 +0800 | [diff] [blame] | 27 | #include <cstddef> |
Andy Green | a11fe94 | 2011-09-25 10:30:26 +0100 | [diff] [blame] | 28 | #endif |
| 29 | |
Peter Hinz | 56885f3 | 2011-03-02 22:03:47 +0000 | [diff] [blame] | 30 | #ifdef WIN32 |
| 31 | |
| 32 | #ifndef WIN32_LEAN_AND_MEAN |
| 33 | #define WIN32_LEAN_AND_MEAN |
| 34 | #endif |
| 35 | #include <winsock2.h> |
| 36 | #include <ws2tcpip.h> |
Paulo Roberto Urio | 4144e83 | 2012-06-04 09:04:33 +0800 | [diff] [blame] | 37 | #include <stddef.h> |
Andy Green | 2a480ea | 2012-04-12 10:54:22 +0800 | [diff] [blame] | 38 | #include "../win32port/win32helpers/websock-w32.h" |
Peter Hinz | 56885f3 | 2011-03-02 22:03:47 +0000 | [diff] [blame] | 39 | |
Andy Green | a314788 | 2012-04-12 11:02:06 +0800 | [diff] [blame] | 40 | #include "../win32port/win32helpers/gettimeofday.h" |
Michel Archambault | 03bec39 | 2011-05-24 17:15:25 +0100 | [diff] [blame] | 41 | |
Oleg Golosovskiy | 2ef7505 | 2011-10-04 20:20:14 +0800 | [diff] [blame] | 42 | #define strcasecmp stricmp |
Andy Green | dfb2304 | 2013-01-17 12:26:48 +0800 | [diff] [blame] | 43 | #define getdtablesize() 30000 |
Oleg Golosovskiy | 2ef7505 | 2011-10-04 20:20:14 +0800 | [diff] [blame] | 44 | |
David Brooks | 06fbcee | 2012-05-02 06:02:45 +0800 | [diff] [blame] | 45 | typedef int ssize_t; |
| 46 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 47 | #ifdef LWS_DLL |
| 48 | #ifdef LWS_INTERNAL |
| 49 | #define LWS_EXTERN extern __declspec(dllexport) |
| 50 | #else |
| 51 | #define LWS_EXTERN extern __declspec(dllimport) |
| 52 | #endif |
| 53 | #endif |
| 54 | |
Joakim Soderberg | f272cb0 | 2013-02-13 09:29:26 +0800 | [diff] [blame] | 55 | #else // NOT WIN32 |
Andy Green | 9f99034 | 2011-02-12 11:57:45 +0000 | [diff] [blame] | 56 | #include <poll.h> |
Andy Green | dfb2304 | 2013-01-17 12:26:48 +0800 | [diff] [blame] | 57 | #include <unistd.h> |
Peter Hinz | 56885f3 | 2011-03-02 22:03:47 +0000 | [diff] [blame] | 58 | #endif |
Andy Green | 9f99034 | 2011-02-12 11:57:45 +0000 | [diff] [blame] | 59 | |
Peter Young | 27b3237 | 2013-01-17 10:10:10 +0800 | [diff] [blame] | 60 | #include <assert.h> |
| 61 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 62 | #ifndef LWS_EXTERN |
| 63 | #define LWS_EXTERN extern |
| 64 | #endif |
| 65 | |
Andy Green | 4739e5c | 2011-01-22 12:51:57 +0000 | [diff] [blame] | 66 | #define CONTEXT_PORT_NO_LISTEN 0 |
Andy Green | a41314f | 2011-05-23 10:00:03 +0100 | [diff] [blame] | 67 | #define MAX_MUX_RECURSION 2 |
Andy Green | bfb051f | 2011-02-09 08:49:14 +0000 | [diff] [blame] | 68 | |
Andy Green | 43db045 | 2013-01-10 19:50:35 +0800 | [diff] [blame] | 69 | enum lws_log_levels { |
| 70 | LLL_ERR = 1 << 0, |
| 71 | LLL_WARN = 1 << 1, |
Andy Green | 7c19c34 | 2013-01-19 12:18:07 +0800 | [diff] [blame] | 72 | LLL_NOTICE = 1 << 2, |
| 73 | LLL_INFO = 1 << 3, |
| 74 | LLL_DEBUG = 1 << 4, |
| 75 | LLL_PARSER = 1 << 5, |
| 76 | LLL_HEADER = 1 << 6, |
| 77 | LLL_EXT = 1 << 7, |
| 78 | LLL_CLIENT = 1 << 8, |
Andy Green | d636e35 | 2013-01-29 12:36:17 +0800 | [diff] [blame] | 79 | LLL_LATENCY = 1 << 9, |
Andy Green | 43db045 | 2013-01-10 19:50:35 +0800 | [diff] [blame] | 80 | |
Andy Green | d636e35 | 2013-01-29 12:36:17 +0800 | [diff] [blame] | 81 | LLL_COUNT = 10 /* set to count of valid flags */ |
Andy Green | 43db045 | 2013-01-10 19:50:35 +0800 | [diff] [blame] | 82 | }; |
| 83 | |
Joakim Soderberg | f272cb0 | 2013-02-13 09:29:26 +0800 | [diff] [blame] | 84 | LWS_EXTERN void _lws_log(int filter, const char *format, ...); |
Andy Green | 69e4364 | 2013-01-19 11:58:07 +0800 | [diff] [blame] | 85 | |
Andy Green | d636e35 | 2013-01-29 12:36:17 +0800 | [diff] [blame] | 86 | /* notice, warn and log are always compiled in */ |
Andy Green | 69e4364 | 2013-01-19 11:58:07 +0800 | [diff] [blame] | 87 | #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__) |
| 88 | #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__) |
| 89 | #define lwsl_err(...) _lws_log(LLL_ERR, __VA_ARGS__) |
Andy Green | 69e4364 | 2013-01-19 11:58:07 +0800 | [diff] [blame] | 90 | /* |
Andy Green | d636e35 | 2013-01-29 12:36:17 +0800 | [diff] [blame] | 91 | * weaker logging can be deselected at configure time using --disable-debug |
Andy Green | 69e4364 | 2013-01-19 11:58:07 +0800 | [diff] [blame] | 92 | * that gets rid of the overhead of checking while keeping _warn and _err |
| 93 | * active |
| 94 | */ |
| 95 | #ifdef _DEBUG |
Andy Green | d636e35 | 2013-01-29 12:36:17 +0800 | [diff] [blame] | 96 | |
Andy Green | 69e4364 | 2013-01-19 11:58:07 +0800 | [diff] [blame] | 97 | #define lwsl_info(...) _lws_log(LLL_INFO, __VA_ARGS__) |
| 98 | #define lwsl_debug(...) _lws_log(LLL_DEBUG, __VA_ARGS__) |
| 99 | #define lwsl_parser(...) _lws_log(LLL_PARSER, __VA_ARGS__) |
| 100 | #define lwsl_header(...) _lws_log(LLL_HEADER, __VA_ARGS__) |
Andy Green | d636e35 | 2013-01-29 12:36:17 +0800 | [diff] [blame] | 101 | #define lwsl_ext(...) _lws_log(LLL_EXT, __VA_ARGS__) |
Andy Green | 69e4364 | 2013-01-19 11:58:07 +0800 | [diff] [blame] | 102 | #define lwsl_client(...) _lws_log(LLL_CLIENT, __VA_ARGS__) |
Andy Green | d636e35 | 2013-01-29 12:36:17 +0800 | [diff] [blame] | 103 | #define lwsl_latency(...) _lws_log(LLL_LATENCY, __VA_ARGS__) |
Joakim Soderberg | f272cb0 | 2013-02-13 09:29:26 +0800 | [diff] [blame] | 104 | LWS_EXTERN void lwsl_hexdump(void *buf, size_t len); |
Andy Green | d636e35 | 2013-01-29 12:36:17 +0800 | [diff] [blame] | 105 | |
Andy Green | 69e4364 | 2013-01-19 11:58:07 +0800 | [diff] [blame] | 106 | #else /* no debug */ |
Andy Green | d636e35 | 2013-01-29 12:36:17 +0800 | [diff] [blame] | 107 | |
Andy Green | 69e4364 | 2013-01-19 11:58:07 +0800 | [diff] [blame] | 108 | #define lwsl_info(...) |
| 109 | #define lwsl_debug(...) |
| 110 | #define lwsl_parser(...) |
| 111 | #define lwsl_header(...) |
| 112 | #define lwsl_ext(...) |
| 113 | #define lwsl_client(...) |
Andy Green | d636e35 | 2013-01-29 12:36:17 +0800 | [diff] [blame] | 114 | #define lwsl_latency(...) |
Andy Green | 69e4364 | 2013-01-19 11:58:07 +0800 | [diff] [blame] | 115 | #define lwsl_hexdump(a, b) |
Andy Green | d636e35 | 2013-01-29 12:36:17 +0800 | [diff] [blame] | 116 | |
Andy Green | 69e4364 | 2013-01-19 11:58:07 +0800 | [diff] [blame] | 117 | #endif |
| 118 | |
Andy Green | bfb051f | 2011-02-09 08:49:14 +0000 | [diff] [blame] | 119 | enum libwebsocket_context_options { |
Andy Green | c6bf2c2 | 2011-02-20 11:10:47 +0000 | [diff] [blame] | 120 | LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT = 2, |
Andy Green | 788c4a8 | 2012-10-22 12:29:57 +0100 | [diff] [blame] | 121 | LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME = 4, |
Andy Green | bfb051f | 2011-02-09 08:49:14 +0000 | [diff] [blame] | 122 | }; |
Andy Green | 8014b29 | 2011-01-30 20:57:25 +0000 | [diff] [blame] | 123 | |
Andy Green | 775c0dd | 2010-10-29 14:15:22 +0100 | [diff] [blame] | 124 | enum libwebsocket_callback_reasons { |
| 125 | LWS_CALLBACK_ESTABLISHED, |
David Brooks | 80a4497 | 2012-04-20 12:18:47 +0800 | [diff] [blame] | 126 | LWS_CALLBACK_CLIENT_CONNECTION_ERROR, |
Andy Green | 2b57a34 | 2013-02-06 15:15:25 +0900 | [diff] [blame] | 127 | LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH, |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 128 | LWS_CALLBACK_CLIENT_ESTABLISHED, |
Andy Green | 775c0dd | 2010-10-29 14:15:22 +0100 | [diff] [blame] | 129 | LWS_CALLBACK_CLOSED, |
Andy Green | 775c0dd | 2010-10-29 14:15:22 +0100 | [diff] [blame] | 130 | LWS_CALLBACK_RECEIVE, |
Andy Green | 4739e5c | 2011-01-22 12:51:57 +0000 | [diff] [blame] | 131 | LWS_CALLBACK_CLIENT_RECEIVE, |
Andy Green | a6cbece | 2011-01-27 20:06:03 +0000 | [diff] [blame] | 132 | LWS_CALLBACK_CLIENT_RECEIVE_PONG, |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 133 | LWS_CALLBACK_CLIENT_WRITEABLE, |
Andy Green | 9e4c2b6 | 2011-03-07 20:47:39 +0000 | [diff] [blame] | 134 | LWS_CALLBACK_SERVER_WRITEABLE, |
Andy Green | a2b0ab0 | 2010-11-11 12:28:29 +0000 | [diff] [blame] | 135 | LWS_CALLBACK_HTTP, |
Andy Green | d280b6e | 2013-01-15 13:40:23 +0800 | [diff] [blame] | 136 | LWS_CALLBACK_HTTP_FILE_COMPLETION, |
Andy Green | 54cb346 | 2013-02-14 22:23:54 +0800 | [diff] [blame] | 137 | LWS_CALLBACK_HTTP_WRITEABLE, |
Andy Green | 0703409 | 2011-02-13 08:37:12 +0000 | [diff] [blame] | 138 | LWS_CALLBACK_FILTER_NETWORK_CONNECTION, |
Andy Green | c85619d | 2011-02-13 08:25:26 +0000 | [diff] [blame] | 139 | LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION, |
Andy Green | 0894bda | 2011-02-19 09:09:11 +0000 | [diff] [blame] | 140 | LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS, |
Andy Green | c6bf2c2 | 2011-02-20 11:10:47 +0000 | [diff] [blame] | 141 | LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS, |
Andy Green | 6901cb3 | 2011-02-21 08:06:47 +0000 | [diff] [blame] | 142 | LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION, |
Andy Green | 385e7ad | 2011-03-01 21:06:02 +0000 | [diff] [blame] | 143 | LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER, |
Andy Green | c511482 | 2011-03-06 10:29:35 +0000 | [diff] [blame] | 144 | LWS_CALLBACK_CONFIRM_EXTENSION_OKAY, |
Andy Green | c6517fa | 2011-03-06 13:15:29 +0000 | [diff] [blame] | 145 | LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED, |
Andy Green | a7109e6 | 2013-02-11 12:05:54 +0800 | [diff] [blame] | 146 | LWS_CALLBACK_PROTOCOL_INIT, |
| 147 | LWS_CALLBACK_PROTOCOL_DESTROY, |
Andy Green | 3221f92 | 2011-02-12 13:14:11 +0000 | [diff] [blame] | 148 | /* external poll() management support */ |
| 149 | LWS_CALLBACK_ADD_POLL_FD, |
| 150 | LWS_CALLBACK_DEL_POLL_FD, |
| 151 | LWS_CALLBACK_SET_MODE_POLL_FD, |
| 152 | LWS_CALLBACK_CLEAR_MODE_POLL_FD, |
Andy Green | 5fd8a5e | 2010-10-31 11:57:17 +0000 | [diff] [blame] | 153 | }; |
| 154 | |
Andy Green | 3182ece | 2013-01-20 17:08:31 +0800 | [diff] [blame] | 155 | #ifndef LWS_NO_EXTENSIONS |
Andy Green | c511482 | 2011-03-06 10:29:35 +0000 | [diff] [blame] | 156 | enum libwebsocket_extension_callback_reasons { |
Andy Green | a41314f | 2011-05-23 10:00:03 +0100 | [diff] [blame] | 157 | LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT, |
| 158 | LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT, |
| 159 | LWS_EXT_CALLBACK_SERVER_CONTEXT_DESTRUCT, |
| 160 | LWS_EXT_CALLBACK_CLIENT_CONTEXT_DESTRUCT, |
Andy Green | c511482 | 2011-03-06 10:29:35 +0000 | [diff] [blame] | 161 | LWS_EXT_CALLBACK_CONSTRUCT, |
Andy Green | 2366b1c | 2011-03-06 13:15:31 +0000 | [diff] [blame] | 162 | LWS_EXT_CALLBACK_CLIENT_CONSTRUCT, |
Andy Green | 68b4504 | 2011-05-25 21:41:57 +0100 | [diff] [blame] | 163 | LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE, |
Andy Green | 0922650 | 2011-05-28 10:19:19 +0100 | [diff] [blame] | 164 | LWS_EXT_CALLBACK_CHECK_OK_TO_PROPOSE_EXTENSION, |
Andy Green | c511482 | 2011-03-06 10:29:35 +0000 | [diff] [blame] | 165 | LWS_EXT_CALLBACK_DESTROY, |
Andy Green | a41314f | 2011-05-23 10:00:03 +0100 | [diff] [blame] | 166 | LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING, |
| 167 | LWS_EXT_CALLBACK_ANY_WSI_ESTABLISHED, |
Andy Green | 98a717c | 2011-03-06 13:14:15 +0000 | [diff] [blame] | 168 | LWS_EXT_CALLBACK_PACKET_RX_PREPARSE, |
Andy Green | 3b84c00 | 2011-03-06 13:14:42 +0000 | [diff] [blame] | 169 | LWS_EXT_CALLBACK_PACKET_TX_PRESEND, |
Andy Green | a41314f | 2011-05-23 10:00:03 +0100 | [diff] [blame] | 170 | LWS_EXT_CALLBACK_PACKET_TX_DO_SEND, |
| 171 | LWS_EXT_CALLBACK_HANDSHAKE_REPLY_TX, |
Andy Green | c44159f | 2011-03-07 07:08:18 +0000 | [diff] [blame] | 172 | LWS_EXT_CALLBACK_FLUSH_PENDING_TX, |
Andy Green | a41314f | 2011-05-23 10:00:03 +0100 | [diff] [blame] | 173 | LWS_EXT_CALLBACK_EXTENDED_PAYLOAD_RX, |
| 174 | LWS_EXT_CALLBACK_CAN_PROXY_CLIENT_CONNECTION, |
| 175 | LWS_EXT_CALLBACK_1HZ, |
| 176 | LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE, |
| 177 | LWS_EXT_CALLBACK_IS_WRITEABLE, |
David Galeano | e2cf992 | 2013-01-09 18:06:55 +0800 | [diff] [blame] | 178 | LWS_EXT_CALLBACK_PAYLOAD_TX, |
| 179 | LWS_EXT_CALLBACK_PAYLOAD_RX, |
Andy Green | c511482 | 2011-03-06 10:29:35 +0000 | [diff] [blame] | 180 | }; |
Andy Green | 3182ece | 2013-01-20 17:08:31 +0800 | [diff] [blame] | 181 | #endif |
Andy Green | c511482 | 2011-03-06 10:29:35 +0000 | [diff] [blame] | 182 | |
Andy Green | 5fd8a5e | 2010-10-31 11:57:17 +0000 | [diff] [blame] | 183 | enum libwebsocket_write_protocol { |
| 184 | LWS_WRITE_TEXT, |
| 185 | LWS_WRITE_BINARY, |
Andy Green | 5d9d94b | 2011-03-07 20:47:41 +0000 | [diff] [blame] | 186 | LWS_WRITE_CONTINUATION, |
Andy Green | 38e57bb | 2011-01-19 12:20:27 +0000 | [diff] [blame] | 187 | LWS_WRITE_HTTP, |
| 188 | |
Andy Green | 5e1fa17 | 2011-02-10 09:07:05 +0000 | [diff] [blame] | 189 | /* special 04+ opcodes */ |
Andy Green | 38e57bb | 2011-01-19 12:20:27 +0000 | [diff] [blame] | 190 | |
| 191 | LWS_WRITE_CLOSE, |
| 192 | LWS_WRITE_PING, |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 193 | LWS_WRITE_PONG, |
| 194 | |
Andy Green | bd96d80 | 2011-01-30 08:24:31 +0000 | [diff] [blame] | 195 | /* flags */ |
| 196 | |
| 197 | LWS_WRITE_NO_FIN = 0x40, |
| 198 | /* |
| 199 | * client packet payload goes out on wire unmunged |
| 200 | * only useful for security tests since normal servers cannot |
| 201 | * decode the content if used |
| 202 | */ |
| 203 | LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80 |
Andy Green | ff95d7a | 2010-10-28 22:36:01 +0100 | [diff] [blame] | 204 | }; |
| 205 | |
Andy Green | c85619d | 2011-02-13 08:25:26 +0000 | [diff] [blame] | 206 | /* |
| 207 | * you need these to look at headers that have been parsed if using the |
| 208 | * LWS_CALLBACK_FILTER_CONNECTION callback. If a header from the enum |
| 209 | * list below is absent, .token = NULL and token_len = 0. Otherwise .token |
| 210 | * points to .token_len chars containing that header content. |
| 211 | */ |
| 212 | |
| 213 | struct lws_tokens { |
| 214 | char *token; |
| 215 | int token_len; |
| 216 | }; |
| 217 | |
| 218 | enum lws_token_indexes { |
| 219 | WSI_TOKEN_GET_URI, |
| 220 | WSI_TOKEN_HOST, |
| 221 | WSI_TOKEN_CONNECTION, |
| 222 | WSI_TOKEN_KEY1, |
| 223 | WSI_TOKEN_KEY2, |
| 224 | WSI_TOKEN_PROTOCOL, |
| 225 | WSI_TOKEN_UPGRADE, |
| 226 | WSI_TOKEN_ORIGIN, |
| 227 | WSI_TOKEN_DRAFT, |
| 228 | WSI_TOKEN_CHALLENGE, |
| 229 | |
| 230 | /* new for 04 */ |
| 231 | WSI_TOKEN_KEY, |
| 232 | WSI_TOKEN_VERSION, |
| 233 | WSI_TOKEN_SWORIGIN, |
| 234 | |
| 235 | /* new for 05 */ |
| 236 | WSI_TOKEN_EXTENSIONS, |
| 237 | |
| 238 | /* client receives these */ |
| 239 | WSI_TOKEN_ACCEPT, |
| 240 | WSI_TOKEN_NONCE, |
| 241 | WSI_TOKEN_HTTP, |
Andy Green | a41314f | 2011-05-23 10:00:03 +0100 | [diff] [blame] | 242 | WSI_TOKEN_MUXURL, |
Andy Green | c85619d | 2011-02-13 08:25:26 +0000 | [diff] [blame] | 243 | |
Andy Green | e77fb80 | 2013-02-11 13:04:45 +0800 | [diff] [blame] | 244 | /* use token storage to stash these */ |
| 245 | |
| 246 | _WSI_TOKEN_CLIENT_SENT_PROTOCOLS, |
| 247 | _WSI_TOKEN_CLIENT_PEER_ADDRESS, |
| 248 | _WSI_TOKEN_CLIENT_URI, |
| 249 | _WSI_TOKEN_CLIENT_HOST, |
| 250 | _WSI_TOKEN_CLIENT_ORIGIN, |
| 251 | |
Andy Green | c85619d | 2011-02-13 08:25:26 +0000 | [diff] [blame] | 252 | /* always last real token index*/ |
| 253 | WSI_TOKEN_COUNT, |
| 254 | /* parser state additions */ |
| 255 | WSI_TOKEN_NAME_PART, |
| 256 | WSI_TOKEN_SKIPPING, |
| 257 | WSI_TOKEN_SKIPPING_SAW_CR, |
Andy Green | a41314f | 2011-05-23 10:00:03 +0100 | [diff] [blame] | 258 | WSI_PARSING_COMPLETE, |
| 259 | WSI_INIT_TOKEN_MUXURL, |
Andy Green | c85619d | 2011-02-13 08:25:26 +0000 | [diff] [blame] | 260 | }; |
| 261 | |
Andy Green | 687b018 | 2011-02-26 11:04:01 +0000 | [diff] [blame] | 262 | /* |
David Galeano | 2915a80 | 2013-01-09 15:26:08 +0800 | [diff] [blame] | 263 | * From RFC 6455 |
Andy Green | 687b018 | 2011-02-26 11:04:01 +0000 | [diff] [blame] | 264 | 1000 |
| 265 | |
David Galeano | 2915a80 | 2013-01-09 15:26:08 +0800 | [diff] [blame] | 266 | 1000 indicates a normal closure, meaning that the purpose for |
| 267 | which the connection was established has been fulfilled. |
Andy Green | 687b018 | 2011-02-26 11:04:01 +0000 | [diff] [blame] | 268 | |
| 269 | 1001 |
| 270 | |
| 271 | 1001 indicates that an endpoint is "going away", such as a server |
David Galeano | 2915a80 | 2013-01-09 15:26:08 +0800 | [diff] [blame] | 272 | going down or a browser having navigated away from a page. |
Andy Green | 687b018 | 2011-02-26 11:04:01 +0000 | [diff] [blame] | 273 | |
| 274 | 1002 |
| 275 | |
| 276 | 1002 indicates that an endpoint is terminating the connection due |
| 277 | to a protocol error. |
| 278 | |
| 279 | 1003 |
| 280 | |
| 281 | 1003 indicates that an endpoint is terminating the connection |
David Galeano | 2915a80 | 2013-01-09 15:26:08 +0800 | [diff] [blame] | 282 | because it has received a type of data it cannot accept (e.g., an |
| 283 | endpoint that understands only text data MAY send this if it |
| 284 | receives a binary message). |
Andy Green | 687b018 | 2011-02-26 11:04:01 +0000 | [diff] [blame] | 285 | |
| 286 | 1004 |
| 287 | |
David Galeano | 2915a80 | 2013-01-09 15:26:08 +0800 | [diff] [blame] | 288 | Reserved. The specific meaning might be defined in the future. |
| 289 | |
| 290 | 1005 |
| 291 | |
| 292 | 1005 is a reserved value and MUST NOT be set as a status code in a |
| 293 | Close control frame by an endpoint. It is designated for use in |
| 294 | applications expecting a status code to indicate that no status |
| 295 | code was actually present. |
| 296 | |
| 297 | 1006 |
| 298 | |
| 299 | 1006 is a reserved value and MUST NOT be set as a status code in a |
| 300 | Close control frame by an endpoint. It is designated for use in |
| 301 | applications expecting a status code to indicate that the |
| 302 | connection was closed abnormally, e.g., without sending or |
| 303 | receiving a Close control frame. |
| 304 | |
| 305 | 1007 |
| 306 | |
| 307 | 1007 indicates that an endpoint is terminating the connection |
| 308 | because it has received data within a message that was not |
| 309 | consistent with the type of the message (e.g., non-UTF-8 [RFC3629] |
| 310 | data within a text message). |
| 311 | |
| 312 | 1008 |
| 313 | |
| 314 | 1008 indicates that an endpoint is terminating the connection |
| 315 | because it has received a message that violates its policy. This |
| 316 | is a generic status code that can be returned when there is no |
| 317 | other more suitable status code (e.g., 1003 or 1009) or if there |
| 318 | is a need to hide specific details about the policy. |
| 319 | |
| 320 | 1009 |
| 321 | |
| 322 | 1009 indicates that an endpoint is terminating the connection |
| 323 | because it has received a message that is too big for it to |
| 324 | process. |
| 325 | |
| 326 | 1010 |
| 327 | |
| 328 | 1010 indicates that an endpoint (client) is terminating the |
| 329 | connection because it has expected the server to negotiate one or |
| 330 | more extension, but the server didn't return them in the response |
| 331 | message of the WebSocket handshake. The list of extensions that |
| 332 | are needed SHOULD appear in the /reason/ part of the Close frame. |
| 333 | Note that this status code is not used by the server, because it |
| 334 | can fail the WebSocket handshake instead. |
| 335 | |
| 336 | 1011 |
| 337 | |
| 338 | 1011 indicates that a server is terminating the connection because |
| 339 | it encountered an unexpected condition that prevented it from |
| 340 | fulfilling the request. |
| 341 | |
| 342 | 1015 |
| 343 | |
| 344 | 1015 is a reserved value and MUST NOT be set as a status code in a |
| 345 | Close control frame by an endpoint. It is designated for use in |
| 346 | applications expecting a status code to indicate that the |
| 347 | connection was closed due to a failure to perform a TLS handshake |
| 348 | (e.g., the server certificate can't be verified). |
Andy Green | 687b018 | 2011-02-26 11:04:01 +0000 | [diff] [blame] | 349 | */ |
| 350 | |
| 351 | enum lws_close_status { |
| 352 | LWS_CLOSE_STATUS_NOSTATUS = 0, |
| 353 | LWS_CLOSE_STATUS_NORMAL = 1000, |
| 354 | LWS_CLOSE_STATUS_GOINGAWAY = 1001, |
| 355 | LWS_CLOSE_STATUS_PROTOCOL_ERR = 1002, |
| 356 | LWS_CLOSE_STATUS_UNACCEPTABLE_OPCODE = 1003, |
David Galeano | 2915a80 | 2013-01-09 15:26:08 +0800 | [diff] [blame] | 357 | LWS_CLOSE_STATUS_RESERVED = 1004, |
| 358 | LWS_CLOSE_STATUS_NO_STATUS = 1005, |
| 359 | LWS_CLOSE_STATUS_ABNORMAL_CLOSE = 1006, |
| 360 | LWS_CLOSE_STATUS_INVALID_PAYLOAD = 1007, |
| 361 | LWS_CLOSE_STATUS_POLICY_VIOLATION = 1008, |
| 362 | LWS_CLOSE_STATUS_MESSAGE_TOO_LARGE = 1009, |
| 363 | LWS_CLOSE_STATUS_EXTENSION_REQUIRED = 1010, |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 364 | LWS_CLOSE_STATUS_UNEXPECTED_CONDITION = 1011, |
| 365 | LWS_CLOSE_STATUS_TLS_FAILURE = 1015, |
Andy Green | 687b018 | 2011-02-26 11:04:01 +0000 | [diff] [blame] | 366 | }; |
| 367 | |
Andy Green | 775c0dd | 2010-10-29 14:15:22 +0100 | [diff] [blame] | 368 | struct libwebsocket; |
Andy Green | b45993c | 2010-12-18 15:13:50 +0000 | [diff] [blame] | 369 | struct libwebsocket_context; |
Andy Green | 3182ece | 2013-01-20 17:08:31 +0800 | [diff] [blame] | 370 | /* needed even with extensions disabled for create context */ |
Andy Green | 46c2ea0 | 2011-03-22 09:04:01 +0000 | [diff] [blame] | 371 | struct libwebsocket_extension; |
Andy Green | ff95d7a | 2010-10-28 22:36:01 +0100 | [diff] [blame] | 372 | |
Andy Green | 8f037e4 | 2010-12-19 22:13:26 +0000 | [diff] [blame] | 373 | /** |
David Brooks | 6c6a3d3 | 2012-04-20 12:13:50 +0800 | [diff] [blame] | 374 | * callback_function() - User server actions |
Andy Green | 32375b7 | 2011-02-19 08:32:53 +0000 | [diff] [blame] | 375 | * @context: Websockets context |
Andy Green | 8f037e4 | 2010-12-19 22:13:26 +0000 | [diff] [blame] | 376 | * @wsi: Opaque websocket instance pointer |
| 377 | * @reason: The reason for the call |
| 378 | * @user: Pointer to per-session user data allocated by library |
| 379 | * @in: Pointer used for some callback reasons |
| 380 | * @len: Length set for some callback reasons |
| 381 | * |
| 382 | * This callback is the way the user controls what is served. All the |
| 383 | * protocol detail is hidden and handled by the library. |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 384 | * |
Andy Green | 8f037e4 | 2010-12-19 22:13:26 +0000 | [diff] [blame] | 385 | * For each connection / session there is user data allocated that is |
| 386 | * pointed to by "user". You set the size of this user data area when |
| 387 | * the library is initialized with libwebsocket_create_server. |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 388 | * |
Andy Green | 8f037e4 | 2010-12-19 22:13:26 +0000 | [diff] [blame] | 389 | * You get an opportunity to initialize user data when called back with |
| 390 | * LWS_CALLBACK_ESTABLISHED reason. |
| 391 | * |
Andy Green | 2b57a34 | 2013-02-06 15:15:25 +0900 | [diff] [blame] | 392 | * LWS_CALLBACK_ESTABLISHED: after the server completes a handshake with |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 393 | * an incoming client |
| 394 | * |
David Brooks | 80a4497 | 2012-04-20 12:18:47 +0800 | [diff] [blame] | 395 | * LWS_CALLBACK_CLIENT_CONNECTION_ERROR: the request client connection has |
| 396 | * been unable to complete a handshake with the remote server |
| 397 | * |
Andy Green | 2b57a34 | 2013-02-06 15:15:25 +0900 | [diff] [blame] | 398 | * LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH: this is the last chance for the |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 399 | * client user code to examine the http headers |
| 400 | * and decide to reject the connection. If the |
| 401 | * content in the headers is interesting to the |
| 402 | * client (url, etc) it needs to copy it out at |
| 403 | * this point since it will be destroyed before |
| 404 | * the CLIENT_ESTABLISHED call |
Andy Green | 2b57a34 | 2013-02-06 15:15:25 +0900 | [diff] [blame] | 405 | * |
David Brooks | 80a4497 | 2012-04-20 12:18:47 +0800 | [diff] [blame] | 406 | * LWS_CALLBACK_CLIENT_ESTABLISHED: after your client connection completed |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 407 | * a handshake with the remote server |
Andy Green | 8f037e4 | 2010-12-19 22:13:26 +0000 | [diff] [blame] | 408 | * |
| 409 | * LWS_CALLBACK_CLOSED: when the websocket session ends |
| 410 | * |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 411 | * LWS_CALLBACK_RECEIVE: data has appeared for this server endpoint from a |
| 412 | * remote client, it can be found at *in and is |
| 413 | * len bytes long |
| 414 | * |
Andy Green | a6cbece | 2011-01-27 20:06:03 +0000 | [diff] [blame] | 415 | * LWS_CALLBACK_CLIENT_RECEIVE_PONG: if you elected to see PONG packets, |
| 416 | * they appear with this callback reason. PONG |
| 417 | * packets only exist in 04+ protocol |
| 418 | * |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 419 | * LWS_CALLBACK_CLIENT_RECEIVE: data has appeared from the server for the |
| 420 | * client connection, it can be found at *in and |
| 421 | * is len bytes long |
Andy Green | 8f037e4 | 2010-12-19 22:13:26 +0000 | [diff] [blame] | 422 | * |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 423 | * LWS_CALLBACK_HTTP: an http request has come from a client that is not |
Andy Green | 8f037e4 | 2010-12-19 22:13:26 +0000 | [diff] [blame] | 424 | * asking to upgrade the connection to a websocket |
| 425 | * one. This is a chance to serve http content, |
| 426 | * for example, to send a script to the client |
| 427 | * which will then open the websockets connection. |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 428 | * @in points to the URI path requested and |
Andy Green | 8f037e4 | 2010-12-19 22:13:26 +0000 | [diff] [blame] | 429 | * libwebsockets_serve_http_file() makes it very |
| 430 | * simple to send back a file to the client. |
Andy Green | 24b588b | 2013-01-13 09:53:18 +0800 | [diff] [blame] | 431 | * Normally after sending the file you are done |
| 432 | * with the http connection, since the rest of the |
| 433 | * activity will come by websockets from the script |
| 434 | * that was delivered by http, so you will want to |
| 435 | * return 1; to close and free up the connection. |
| 436 | * That's important because it uses a slot in the |
| 437 | * total number of client connections allowed set |
| 438 | * by MAX_CLIENTS. |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 439 | * |
Andy Green | 54cb346 | 2013-02-14 22:23:54 +0800 | [diff] [blame] | 440 | * LWS_CALLBACK_HTTP_WRITEABLE: you can write more down the http protocol |
| 441 | * link now. |
| 442 | * |
Andy Green | d280b6e | 2013-01-15 13:40:23 +0800 | [diff] [blame] | 443 | * LWS_CALLBACK_HTTP_FILE_COMPLETION: a file requested to be send down |
| 444 | * http link has completed. |
| 445 | * |
Andy Green | 9e4c2b6 | 2011-03-07 20:47:39 +0000 | [diff] [blame] | 446 | * LWS_CALLBACK_CLIENT_WRITEABLE: |
| 447 | * LWS_CALLBACK_SERVER_WRITEABLE: If you call |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 448 | * libwebsocket_callback_on_writable() on a connection, you will |
Andy Green | 9e4c2b6 | 2011-03-07 20:47:39 +0000 | [diff] [blame] | 449 | * get one of these callbacks coming when the connection socket |
| 450 | * is able to accept another write packet without blocking. |
| 451 | * If it already was able to take another packet without blocking, |
| 452 | * you'll get this callback at the next call to the service loop |
| 453 | * function. Notice that CLIENTs get LWS_CALLBACK_CLIENT_WRITEABLE |
| 454 | * and servers get LWS_CALLBACK_SERVER_WRITEABLE. |
Andy Green | e7981dc | 2011-02-12 21:24:03 +0000 | [diff] [blame] | 455 | * |
Andy Green | 0703409 | 2011-02-13 08:37:12 +0000 | [diff] [blame] | 456 | * LWS_CALLBACK_FILTER_NETWORK_CONNECTION: called when a client connects to |
| 457 | * the server at network level; the connection is accepted but then |
| 458 | * passed to this callback to decide whether to hang up immediately |
Edwin van den Oetelaar | 8c8a8e1 | 2013-02-20 20:56:59 +0800 | [diff] [blame] | 459 | * or not, based on the client IP. @in contains the connection |
Andy Green | 0703409 | 2011-02-13 08:37:12 +0000 | [diff] [blame] | 460 | * socket's descriptor. Return non-zero to terminate |
| 461 | * the connection before sending or receiving anything. |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 462 | * Because this happens immediately after the network connection |
Andy Green | 0703409 | 2011-02-13 08:37:12 +0000 | [diff] [blame] | 463 | * from the client, there's no websocket protocol selected yet so |
| 464 | * this callback is issued only to protocol 0. |
| 465 | * |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 466 | * LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION: called when the handshake has |
| 467 | * been received and parsed from the client, but the response is |
| 468 | * not sent yet. Return non-zero to disallow the connection. |
Andy Green | c85619d | 2011-02-13 08:25:26 +0000 | [diff] [blame] | 469 | * @user is a pointer to an array of struct lws_tokens, you can |
| 470 | * use the header enums lws_token_indexes from libwebsockets.h |
| 471 | * to check for and read the supported header presence and |
| 472 | * content before deciding to allow the handshake to proceed or |
| 473 | * to kill the connection. |
| 474 | * |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 475 | * LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS: if configured for |
| 476 | * including OpenSSL support, this callback allows your user code |
| 477 | * to perform extra SSL_CTX_load_verify_locations() or similar |
Andy Green | 0894bda | 2011-02-19 09:09:11 +0000 | [diff] [blame] | 478 | * calls to direct OpenSSL where to find certificates the client |
| 479 | * can use to confirm the remote server identity. @user is the |
| 480 | * OpenSSL SSL_CTX* |
Andy Green | c85619d | 2011-02-13 08:25:26 +0000 | [diff] [blame] | 481 | * |
Andy Green | c6bf2c2 | 2011-02-20 11:10:47 +0000 | [diff] [blame] | 482 | * LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS: if configured for |
| 483 | * including OpenSSL support, this callback allows your user code |
| 484 | * to load extra certifcates into the server which allow it to |
| 485 | * verify the validity of certificates returned by clients. @user |
| 486 | * is the server's OpenSSL SSL_CTX* |
| 487 | * |
Andy Green | 6901cb3 | 2011-02-21 08:06:47 +0000 | [diff] [blame] | 488 | * LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION: if the |
| 489 | * libwebsockets context was created with the option |
| 490 | * LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT, then this |
| 491 | * callback is generated during OpenSSL verification of the cert |
| 492 | * sent from the client. It is sent to protocol[0] callback as |
| 493 | * no protocol has been negotiated on the connection yet. |
| 494 | * Notice that the libwebsockets context and wsi are both NULL |
| 495 | * during this callback. See |
| 496 | * http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html |
| 497 | * to understand more detail about the OpenSSL callback that |
| 498 | * generates this libwebsockets callback and the meanings of the |
| 499 | * arguments passed. In this callback, @user is the x509_ctx, |
| 500 | * @in is the ssl pointer and @len is preverify_ok |
| 501 | * Notice that this callback maintains libwebsocket return |
| 502 | * conventions, return 0 to mean the cert is OK or 1 to fail it. |
| 503 | * This also means that if you don't handle this callback then |
| 504 | * the default callback action of returning 0 allows the client |
| 505 | * certificates. |
| 506 | * |
Andy Green | 385e7ad | 2011-03-01 21:06:02 +0000 | [diff] [blame] | 507 | * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER: this callback happens |
| 508 | * when a client handshake is being compiled. @user is NULL, |
| 509 | * @in is a char **, it's pointing to a char * which holds the |
| 510 | * next location in the header buffer where you can add |
| 511 | * headers, and @len is the remaining space in the header buffer, |
| 512 | * which is typically some hundreds of bytes. So, to add a canned |
| 513 | * cookie, your handler code might look similar to: |
| 514 | * |
| 515 | * char **p = (char **)in; |
| 516 | * |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 517 | * if (len < 100) |
| 518 | * return 1; |
Andy Green | 385e7ad | 2011-03-01 21:06:02 +0000 | [diff] [blame] | 519 | * |
| 520 | * *p += sprintf(*p, "Cookie: a=b\x0d\x0a"); |
| 521 | * |
| 522 | * return 0; |
| 523 | * |
| 524 | * Notice if you add anything, you just have to take care about |
| 525 | * the CRLF on the line you added. Obviously this callback is |
| 526 | * optional, if you don't handle it everything is fine. |
| 527 | * |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 528 | * Notice the callback is coming to protocols[0] all the time, |
Andy Green | 385e7ad | 2011-03-01 21:06:02 +0000 | [diff] [blame] | 529 | * because there is no specific protocol handshook yet. |
| 530 | * |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 531 | * LWS_CALLBACK_CONFIRM_EXTENSION_OKAY: When the server handshake code |
Andy Green | c511482 | 2011-03-06 10:29:35 +0000 | [diff] [blame] | 532 | * sees that it does support a requested extension, before |
| 533 | * accepting the extension by additing to the list sent back to |
| 534 | * the client it gives this callback just to check that it's okay |
| 535 | * to use that extension. It calls back to the requested protocol |
| 536 | * and with @in being the extension name, @len is 0 and @user is |
| 537 | * valid. Note though at this time the ESTABLISHED callback hasn't |
| 538 | * happened yet so if you initialize @user content there, @user |
| 539 | * content during this callback might not be useful for anything. |
| 540 | * Notice this callback comes to protocols[0]. |
| 541 | * |
Andy Green | c6517fa | 2011-03-06 13:15:29 +0000 | [diff] [blame] | 542 | * LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED: When a client |
| 543 | * connection is being prepared to start a handshake to a server, |
| 544 | * each supported extension is checked with protocols[0] callback |
| 545 | * with this reason, giving the user code a chance to suppress the |
| 546 | * claim to support that extension by returning non-zero. If |
| 547 | * unhandled, by default 0 will be returned and the extension |
| 548 | * support included in the header to the server. Notice this |
| 549 | * callback comes to protocols[0]. |
| 550 | * |
Andy Green | a7109e6 | 2013-02-11 12:05:54 +0800 | [diff] [blame] | 551 | * LWS_CALLBACK_PROTOCOL_INIT: One-time call per protocol so it can |
| 552 | * do initial setup / allocations etc |
| 553 | * |
| 554 | * LWS_CALLBACK_PROTOCOL_DESTROY: One-time call per protocol indicating |
| 555 | * this protocol won't get used at all after this callback, the |
| 556 | * context is getting destroyed. Take the opportunity to |
| 557 | * deallocate everything that was allocated by the protocol. |
| 558 | * |
Andy Green | e7981dc | 2011-02-12 21:24:03 +0000 | [diff] [blame] | 559 | * The next four reasons are optional and only need taking care of if you |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 560 | * will be integrating libwebsockets sockets into an external polling |
| 561 | * array. |
| 562 | * |
| 563 | * LWS_CALLBACK_ADD_POLL_FD: libwebsocket deals with its poll() loop |
| 564 | * internally, but in the case you are integrating with another |
| 565 | * server you will need to have libwebsocket sockets share a |
| 566 | * polling array with the other server. This and the other |
| 567 | * POLL_FD related callbacks let you put your specialized |
| 568 | * poll array interface code in the callback for protocol 0, the |
| 569 | * first protocol you support, usually the HTTP protocol in the |
| 570 | * serving case. This callback happens when a socket needs to be |
Andy Green | 50097dd | 2013-02-15 22:36:30 +0800 | [diff] [blame] | 571 | * added to the polling loop: @in contains the fd, and |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 572 | * @len is the events bitmap (like, POLLIN). If you are using the |
Andy Green | e7981dc | 2011-02-12 21:24:03 +0000 | [diff] [blame] | 573 | * internal polling loop (the "service" callback), you can just |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 574 | * ignore these callbacks. |
Andy Green | e7981dc | 2011-02-12 21:24:03 +0000 | [diff] [blame] | 575 | * |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 576 | * LWS_CALLBACK_DEL_POLL_FD: This callback happens when a socket descriptor |
Andy Green | 50097dd | 2013-02-15 22:36:30 +0800 | [diff] [blame] | 577 | * needs to be removed from an external polling array. @in is |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 578 | * the socket desricptor. If you are using the internal polling |
| 579 | * loop, you can just ignore it. |
Andy Green | e7981dc | 2011-02-12 21:24:03 +0000 | [diff] [blame] | 580 | * |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 581 | * LWS_CALLBACK_SET_MODE_POLL_FD: This callback happens when libwebsockets |
Andy Green | 50097dd | 2013-02-15 22:36:30 +0800 | [diff] [blame] | 582 | * wants to modify the events for the socket descriptor in @in. |
Andy Green | e7981dc | 2011-02-12 21:24:03 +0000 | [diff] [blame] | 583 | * The handler should OR @len on to the events member of the pollfd |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 584 | * struct for this socket descriptor. If you are using the |
Andy Green | e7981dc | 2011-02-12 21:24:03 +0000 | [diff] [blame] | 585 | * internal polling loop, you can just ignore it. |
| 586 | * |
| 587 | * LWS_CALLBACK_CLEAR_MODE_POLL_FD: This callback occurs when libwebsockets |
Andy Green | 50097dd | 2013-02-15 22:36:30 +0800 | [diff] [blame] | 588 | * wants to modify the events for the socket descriptor in @in. |
Andy Green | e7981dc | 2011-02-12 21:24:03 +0000 | [diff] [blame] | 589 | * The handler should AND ~@len on to the events member of the |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 590 | * pollfd struct for this socket descriptor. If you are using the |
Andy Green | e7981dc | 2011-02-12 21:24:03 +0000 | [diff] [blame] | 591 | * internal polling loop, you can just ignore it. |
Andy Green | 8f037e4 | 2010-12-19 22:13:26 +0000 | [diff] [blame] | 592 | */ |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 593 | LWS_EXTERN int callback(struct libwebsocket_context *context, |
Andy Green | 62c54d2 | 2011-02-14 09:14:25 +0000 | [diff] [blame] | 594 | struct libwebsocket *wsi, |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 595 | enum libwebsocket_callback_reasons reason, void *user, |
Andy Green | 8f037e4 | 2010-12-19 22:13:26 +0000 | [diff] [blame] | 596 | void *in, size_t len); |
| 597 | |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 598 | typedef int (callback_function)(struct libwebsocket_context *context, |
David Brooks | 6c6a3d3 | 2012-04-20 12:13:50 +0800 | [diff] [blame] | 599 | struct libwebsocket *wsi, |
| 600 | enum libwebsocket_callback_reasons reason, void *user, |
| 601 | void *in, size_t len); |
| 602 | |
Andy Green | 3182ece | 2013-01-20 17:08:31 +0800 | [diff] [blame] | 603 | #ifndef LWS_NO_EXTENSIONS |
Andy Green | 57b4e9a | 2011-03-06 13:14:46 +0000 | [diff] [blame] | 604 | /** |
David Brooks | 6c6a3d3 | 2012-04-20 12:13:50 +0800 | [diff] [blame] | 605 | * extension_callback_function() - Hooks to allow extensions to operate |
Andy Green | 57b4e9a | 2011-03-06 13:14:46 +0000 | [diff] [blame] | 606 | * @context: Websockets context |
Andy Green | 46c2ea0 | 2011-03-22 09:04:01 +0000 | [diff] [blame] | 607 | * @ext: This extension |
Andy Green | 57b4e9a | 2011-03-06 13:14:46 +0000 | [diff] [blame] | 608 | * @wsi: Opaque websocket instance pointer |
| 609 | * @reason: The reason for the call |
| 610 | * @user: Pointer to per-session user data allocated by library |
| 611 | * @in: Pointer used for some callback reasons |
| 612 | * @len: Length set for some callback reasons |
| 613 | * |
| 614 | * Each extension that is active on a particular connection receives |
| 615 | * callbacks during the connection lifetime to allow the extension to |
| 616 | * operate on websocket data and manage itself. |
| 617 | * |
| 618 | * Libwebsockets takes care of allocating and freeing "user" memory for |
| 619 | * each active extension on each connection. That is what is pointed to |
| 620 | * by the @user parameter. |
| 621 | * |
| 622 | * LWS_EXT_CALLBACK_CONSTRUCT: called when the server has decided to |
| 623 | * select this extension from the list provided by the client, |
| 624 | * just before the server will send back the handshake accepting |
| 625 | * the connection with this extension active. This gives the |
| 626 | * extension a chance to initialize its connection context found |
| 627 | * in @user. |
| 628 | * |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 629 | * LWS_EXT_CALLBACK_CLIENT_CONSTRUCT: same as LWS_EXT_CALLBACK_CONSTRUCT |
Andy Green | 2366b1c | 2011-03-06 13:15:31 +0000 | [diff] [blame] | 630 | * but called when client is instantiating this extension. Some |
| 631 | * extensions will work the same on client and server side and then |
| 632 | * you can just merge handlers for both CONSTRUCTS. |
| 633 | * |
Andy Green | 57b4e9a | 2011-03-06 13:14:46 +0000 | [diff] [blame] | 634 | * LWS_EXT_CALLBACK_DESTROY: called when the connection the extension was |
| 635 | * being used on is about to be closed and deallocated. It's the |
| 636 | * last chance for the extension to deallocate anything it has |
| 637 | * allocated in the user data (pointed to by @user) before the |
Andy Green | 2366b1c | 2011-03-06 13:15:31 +0000 | [diff] [blame] | 638 | * user data is deleted. This same callback is used whether you |
| 639 | * are in client or server instantiation context. |
Andy Green | 57b4e9a | 2011-03-06 13:14:46 +0000 | [diff] [blame] | 640 | * |
| 641 | * LWS_EXT_CALLBACK_PACKET_RX_PREPARSE: when this extension was active on |
| 642 | * a connection, and a packet of data arrived at the connection, |
| 643 | * it is passed to this callback to give the extension a chance to |
| 644 | * change the data, eg, decompress it. @user is pointing to the |
| 645 | * extension's private connection context data, @in is pointing |
| 646 | * to an lws_tokens struct, it consists of a char * pointer called |
| 647 | * token, and an int called token_len. At entry, these are |
| 648 | * set to point to the received buffer and set to the content |
| 649 | * length. If the extension will grow the content, it should use |
| 650 | * a new buffer allocated in its private user context data and |
| 651 | * set the pointed-to lws_tokens members to point to its buffer. |
| 652 | * |
| 653 | * LWS_EXT_CALLBACK_PACKET_TX_PRESEND: this works the same way as |
| 654 | * LWS_EXT_CALLBACK_PACKET_RX_PREPARSE above, except it gives the |
| 655 | * extension a chance to change websocket data just before it will |
| 656 | * be sent out. Using the same lws_token pointer scheme in @in, |
| 657 | * the extension can change the buffer and the length to be |
| 658 | * transmitted how it likes. Again if it wants to grow the |
| 659 | * buffer safely, it should copy the data into its own buffer and |
| 660 | * set the lws_tokens token pointer to it. |
| 661 | */ |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 662 | LWS_EXTERN int extension_callback(struct libwebsocket_context *context, |
Andy Green | 46c2ea0 | 2011-03-22 09:04:01 +0000 | [diff] [blame] | 663 | struct libwebsocket_extension *ext, |
Andy Green | 57b4e9a | 2011-03-06 13:14:46 +0000 | [diff] [blame] | 664 | struct libwebsocket *wsi, |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 665 | enum libwebsocket_extension_callback_reasons reason, |
| 666 | void *user, void *in, size_t len); |
Andy Green | 57b4e9a | 2011-03-06 13:14:46 +0000 | [diff] [blame] | 667 | |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 668 | typedef int (extension_callback_function)(struct libwebsocket_context *context, |
David Brooks | 6c6a3d3 | 2012-04-20 12:13:50 +0800 | [diff] [blame] | 669 | struct libwebsocket_extension *ext, |
| 670 | struct libwebsocket *wsi, |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 671 | enum libwebsocket_extension_callback_reasons reason, |
| 672 | void *user, void *in, size_t len); |
Andy Green | 3182ece | 2013-01-20 17:08:31 +0800 | [diff] [blame] | 673 | #endif |
Andy Green | 57b4e9a | 2011-03-06 13:14:46 +0000 | [diff] [blame] | 674 | |
Andy Green | 4f3943a | 2010-11-12 10:44:16 +0000 | [diff] [blame] | 675 | /** |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 676 | * struct libwebsocket_protocols - List of protocols and handlers server |
| 677 | * supports. |
Andy Green | 4f3943a | 2010-11-12 10:44:16 +0000 | [diff] [blame] | 678 | * @name: Protocol name that must match the one given in the client |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 679 | * Javascript new WebSocket(url, 'protocol') name |
Andy Green | 4f3943a | 2010-11-12 10:44:16 +0000 | [diff] [blame] | 680 | * @callback: The service callback used for this protocol. It allows the |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 681 | * service action for an entire protocol to be encapsulated in |
| 682 | * the protocol-specific callback |
Andy Green | 4f3943a | 2010-11-12 10:44:16 +0000 | [diff] [blame] | 683 | * @per_session_data_size: Each new connection using this protocol gets |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 684 | * this much memory allocated on connection establishment and |
| 685 | * freed on connection takedown. A pointer to this per-connection |
| 686 | * allocation is passed into the callback in the 'user' parameter |
Andy Green | 5449511 | 2013-02-06 21:10:16 +0900 | [diff] [blame] | 687 | * @rx_buffer_size: if you want atomic frames delivered to the callback, you |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 688 | * should set this to the size of the biggest legal frame that |
| 689 | * you support. If the frame size is exceeded, there is no |
| 690 | * error, but the buffer will spill to the user callback when |
| 691 | * full, which you can detect by using |
| 692 | * libwebsockets_remaining_packet_payload(). Notice that you |
| 693 | * just talk about frame size here, the LWS_SEND_BUFFER_PRE_PADDING |
| 694 | * and post-padding are automatically also allocated on top. |
Andy Green | b45993c | 2010-12-18 15:13:50 +0000 | [diff] [blame] | 695 | * @owning_server: the server init call fills in this opaque pointer when |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 696 | * registering this protocol with the server. |
Andy Green | b45993c | 2010-12-18 15:13:50 +0000 | [diff] [blame] | 697 | * @protocol_index: which protocol we are starting from zero |
Andy Green | e77ddd8 | 2010-11-13 10:03:47 +0000 | [diff] [blame] | 698 | * |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 699 | * This structure represents one protocol supported by the server. An |
| 700 | * array of these structures is passed to libwebsocket_create_server() |
| 701 | * allows as many protocols as you like to be handled by one server. |
Andy Green | 4f3943a | 2010-11-12 10:44:16 +0000 | [diff] [blame] | 702 | */ |
| 703 | |
| 704 | struct libwebsocket_protocols { |
| 705 | const char *name; |
David Brooks | 6c6a3d3 | 2012-04-20 12:13:50 +0800 | [diff] [blame] | 706 | callback_function *callback; |
Andy Green | 4f3943a | 2010-11-12 10:44:16 +0000 | [diff] [blame] | 707 | size_t per_session_data_size; |
Andy Green | 5449511 | 2013-02-06 21:10:16 +0900 | [diff] [blame] | 708 | size_t rx_buffer_size; |
Andy Green | b45993c | 2010-12-18 15:13:50 +0000 | [diff] [blame] | 709 | |
| 710 | /* |
| 711 | * below are filled in on server init and can be left uninitialized, |
| 712 | * no need for user to use them directly either |
| 713 | */ |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 714 | |
Andy Green | b45993c | 2010-12-18 15:13:50 +0000 | [diff] [blame] | 715 | struct libwebsocket_context *owning_server; |
Andy Green | b45993c | 2010-12-18 15:13:50 +0000 | [diff] [blame] | 716 | int protocol_index; |
Andy Green | 4f3943a | 2010-11-12 10:44:16 +0000 | [diff] [blame] | 717 | }; |
| 718 | |
Andy Green | 3182ece | 2013-01-20 17:08:31 +0800 | [diff] [blame] | 719 | #ifndef LWS_NO_EXTENSIONS |
Andy Green | d6e0911 | 2011-03-05 16:12:15 +0000 | [diff] [blame] | 720 | /** |
| 721 | * struct libwebsocket_extension - An extension we know how to cope with |
| 722 | * |
| 723 | * @name: Formal extension name, eg, "deflate-stream" |
| 724 | * @callback: Service callback |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 725 | * @per_session_data_size: Libwebsockets will auto-malloc this much |
| 726 | * memory for the use of the extension, a pointer |
Andy Green | d6e0911 | 2011-03-05 16:12:15 +0000 | [diff] [blame] | 727 | * to it comes in the @user callback parameter |
Peter Pentchev | c74964e | 2013-02-07 16:17:13 +0200 | [diff] [blame] | 728 | * @per_context_private_data: Optional storage for this extension that |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 729 | * is per-context, so it can track stuff across |
| 730 | * all sessions, etc, if it wants |
Andy Green | d6e0911 | 2011-03-05 16:12:15 +0000 | [diff] [blame] | 731 | */ |
| 732 | |
| 733 | struct libwebsocket_extension { |
| 734 | const char *name; |
David Brooks | 6c6a3d3 | 2012-04-20 12:13:50 +0800 | [diff] [blame] | 735 | extension_callback_function *callback; |
Andy Green | d6e0911 | 2011-03-05 16:12:15 +0000 | [diff] [blame] | 736 | size_t per_session_data_size; |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 737 | void *per_context_private_data; |
Andy Green | d6e0911 | 2011-03-05 16:12:15 +0000 | [diff] [blame] | 738 | }; |
Andy Green | 3182ece | 2013-01-20 17:08:31 +0800 | [diff] [blame] | 739 | #endif |
Andy Green | d6e0911 | 2011-03-05 16:12:15 +0000 | [diff] [blame] | 740 | |
Andy Green | 1b26527 | 2013-02-09 14:01:09 +0800 | [diff] [blame] | 741 | /** |
| 742 | * struct lws_context_creation_info: parameters to create context with |
| 743 | * |
| 744 | * @port: Port to listen on... you can use 0 to suppress listening on |
| 745 | * any port, that's what you want if you are not running a |
| 746 | * websocket server at all but just using it as a client |
Andy Green | 7a506ba | 2013-02-12 10:13:02 +0800 | [diff] [blame] | 747 | * @iface: NULL to bind the listen socket to all interfaces, or the |
Andy Green | 1b26527 | 2013-02-09 14:01:09 +0800 | [diff] [blame] | 748 | * interface name, eg, "eth2" |
| 749 | * @protocols: Array of structures listing supported protocols and a protocol- |
| 750 | * specific callback for each one. The list is ended with an |
| 751 | * entry that has a NULL callback pointer. |
| 752 | * It's not const because we write the owning_server member |
| 753 | * @extensions: NULL or array of libwebsocket_extension structs listing the |
| 754 | * extensions this context supports. If you configured with |
| 755 | * --without-extensions, you should give NULL here. |
| 756 | * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want |
| 757 | * to listen using SSL, set to the filepath to fetch the |
| 758 | * server cert from, otherwise NULL for unencrypted |
| 759 | * @ssl_private_key_filepath: filepath to private key if wanting SSL mode, |
| 760 | * else ignored |
| 761 | * @ssl_ca_filepath: CA certificate filepath or NULL |
Andy Green | 2672fb2 | 2013-02-22 09:54:35 +0800 | [diff] [blame] | 762 | * @ssl_cipher_list: List of valid ciphers to use (eg, |
| 763 | * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL" |
| 764 | * or you can leave it as NULL to get "DEFAULT" |
Andy Green | 1b26527 | 2013-02-09 14:01:09 +0800 | [diff] [blame] | 765 | * @gid: group id to change to after setting listen socket, or -1. |
| 766 | * @uid: user id to change to after setting listen socket, or -1. |
| 767 | * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK |
| 768 | * @user: optional user pointer that can be recovered via the context |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 769 | * pointer using libwebsocket_context_user |
Andy Green | a690cd0 | 2013-02-09 12:25:31 +0800 | [diff] [blame] | 770 | * @ka_time: 0 for no keepalive, otherwise apply this keepalive timeout to |
| 771 | * all libwebsocket sockets, client or server |
| 772 | * @ka_probes: if ka_time was nonzero, after the timeout expires how many |
| 773 | * times to try to get a response from the peer before giving up |
| 774 | * and killing the connection |
| 775 | * @ka_interval: if ka_time was nonzero, how long to wait before each ka_probes |
| 776 | * attempt |
Andy Green | 1b26527 | 2013-02-09 14:01:09 +0800 | [diff] [blame] | 777 | */ |
| 778 | |
| 779 | struct lws_context_creation_info { |
| 780 | int port; |
Joakim Soderberg | 63ff120 | 2013-02-11 17:52:23 +0100 | [diff] [blame] | 781 | const char *iface; |
Andy Green | 1b26527 | 2013-02-09 14:01:09 +0800 | [diff] [blame] | 782 | struct libwebsocket_protocols *protocols; |
| 783 | struct libwebsocket_extension *extensions; |
| 784 | const char *ssl_cert_filepath; |
| 785 | const char *ssl_private_key_filepath; |
| 786 | const char *ssl_ca_filepath; |
Andy Green | 2672fb2 | 2013-02-22 09:54:35 +0800 | [diff] [blame] | 787 | const char *ssl_cipher_list; |
Andy Green | 1b26527 | 2013-02-09 14:01:09 +0800 | [diff] [blame] | 788 | int gid; |
| 789 | int uid; |
| 790 | unsigned int options; |
| 791 | void *user; |
Andy Green | a690cd0 | 2013-02-09 12:25:31 +0800 | [diff] [blame] | 792 | int ka_time; |
| 793 | int ka_probes; |
| 794 | int ka_interval; |
| 795 | |
Andy Green | 1b26527 | 2013-02-09 14:01:09 +0800 | [diff] [blame] | 796 | }; |
| 797 | |
Andy Green | 43db045 | 2013-01-10 19:50:35 +0800 | [diff] [blame] | 798 | LWS_EXTERN |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 799 | void lws_set_log_level(int level, |
| 800 | void (*log_emit_function)(int level, const char *line)); |
Andy Green | d6e0911 | 2011-03-05 16:12:15 +0000 | [diff] [blame] | 801 | |
Andy Green | c11db20 | 2013-01-19 11:12:16 +0800 | [diff] [blame] | 802 | LWS_EXTERN void |
| 803 | lwsl_emit_syslog(int level, const char *line); |
| 804 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 805 | LWS_EXTERN struct libwebsocket_context * |
Andy Green | 1b26527 | 2013-02-09 14:01:09 +0800 | [diff] [blame] | 806 | libwebsocket_create_context(struct lws_context_creation_info *info); |
Andy Green | ff95d7a | 2010-10-28 22:36:01 +0100 | [diff] [blame] | 807 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 808 | LWS_EXTERN void |
Darin Willits | c19456f | 2011-02-14 17:52:39 +0000 | [diff] [blame] | 809 | libwebsocket_context_destroy(struct libwebsocket_context *context); |
Andy Green | 6964bb5 | 2011-01-23 16:50:33 +0000 | [diff] [blame] | 810 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 811 | LWS_EXTERN int |
Darin Willits | c19456f | 2011-02-14 17:52:39 +0000 | [diff] [blame] | 812 | libwebsocket_service(struct libwebsocket_context *context, int timeout_ms); |
Andy Green | e92cd17 | 2011-01-19 13:11:55 +0000 | [diff] [blame] | 813 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 814 | LWS_EXTERN int |
Darin Willits | c19456f | 2011-02-14 17:52:39 +0000 | [diff] [blame] | 815 | libwebsocket_service_fd(struct libwebsocket_context *context, |
Andy Green | 9f99034 | 2011-02-12 11:57:45 +0000 | [diff] [blame] | 816 | struct pollfd *pollfd); |
| 817 | |
Alon Levy | 0291eb3 | 2012-10-19 11:21:56 +0200 | [diff] [blame] | 818 | LWS_EXTERN void * |
| 819 | libwebsocket_context_user(struct libwebsocket_context *context); |
| 820 | |
Andy Green | 4ea6006 | 2010-10-30 12:15:07 +0100 | [diff] [blame] | 821 | /* |
| 822 | * IMPORTANT NOTICE! |
Andy Green | e77ddd8 | 2010-11-13 10:03:47 +0000 | [diff] [blame] | 823 | * |
Andy Green | 5fd8a5e | 2010-10-31 11:57:17 +0000 | [diff] [blame] | 824 | * When sending with websocket protocol (LWS_WRITE_TEXT or LWS_WRITE_BINARY) |
| 825 | * the send buffer has to have LWS_SEND_BUFFER_PRE_PADDING bytes valid BEFORE |
Andy Green | 4ea6006 | 2010-10-30 12:15:07 +0100 | [diff] [blame] | 826 | * buf, and LWS_SEND_BUFFER_POST_PADDING bytes valid AFTER (buf + len). |
Andy Green | e77ddd8 | 2010-11-13 10:03:47 +0000 | [diff] [blame] | 827 | * |
Andy Green | 4ea6006 | 2010-10-30 12:15:07 +0100 | [diff] [blame] | 828 | * This allows us to add protocol info before and after the data, and send as |
| 829 | * one packet on the network without payload copying, for maximum efficiency. |
Andy Green | e77ddd8 | 2010-11-13 10:03:47 +0000 | [diff] [blame] | 830 | * |
Andy Green | 4ea6006 | 2010-10-30 12:15:07 +0100 | [diff] [blame] | 831 | * So for example you need this kind of code to use libwebsocket_write with a |
Andy Green | e77ddd8 | 2010-11-13 10:03:47 +0000 | [diff] [blame] | 832 | * 128-byte payload |
| 833 | * |
Andy Green | ab990e4 | 2010-10-31 12:42:52 +0000 | [diff] [blame] | 834 | * char buf[LWS_SEND_BUFFER_PRE_PADDING + 128 + LWS_SEND_BUFFER_POST_PADDING]; |
Andy Green | e77ddd8 | 2010-11-13 10:03:47 +0000 | [diff] [blame] | 835 | * |
Andy Green | ab990e4 | 2010-10-31 12:42:52 +0000 | [diff] [blame] | 836 | * // fill your part of the buffer... for example here it's all zeros |
| 837 | * memset(&buf[LWS_SEND_BUFFER_PRE_PADDING], 0, 128); |
Andy Green | e77ddd8 | 2010-11-13 10:03:47 +0000 | [diff] [blame] | 838 | * |
Andy Green | ab990e4 | 2010-10-31 12:42:52 +0000 | [diff] [blame] | 839 | * libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING], 128); |
Andy Green | e77ddd8 | 2010-11-13 10:03:47 +0000 | [diff] [blame] | 840 | * |
Andy Green | 5fd8a5e | 2010-10-31 11:57:17 +0000 | [diff] [blame] | 841 | * When sending LWS_WRITE_HTTP, there is no protocol addition and you can just |
| 842 | * use the whole buffer without taking care of the above. |
Andy Green | 4ea6006 | 2010-10-30 12:15:07 +0100 | [diff] [blame] | 843 | */ |
| 844 | |
Andy Green | 687b018 | 2011-02-26 11:04:01 +0000 | [diff] [blame] | 845 | /* |
| 846 | * this is the frame nonce plus two header plus 8 length |
Andy Green | a41314f | 2011-05-23 10:00:03 +0100 | [diff] [blame] | 847 | * there's an additional two for mux extension per mux nesting level |
Andy Green | 687b018 | 2011-02-26 11:04:01 +0000 | [diff] [blame] | 848 | * 2 byte prepend on close will already fit because control frames cannot use |
| 849 | * the big length style |
| 850 | */ |
Andy Green | 4739e5c | 2011-01-22 12:51:57 +0000 | [diff] [blame] | 851 | |
Andy Green | a41314f | 2011-05-23 10:00:03 +0100 | [diff] [blame] | 852 | #define LWS_SEND_BUFFER_PRE_PADDING (4 + 10 + (2 * MAX_MUX_RECURSION)) |
David Galeano | e2cf992 | 2013-01-09 18:06:55 +0800 | [diff] [blame] | 853 | #define LWS_SEND_BUFFER_POST_PADDING 4 |
Andy Green | 4ea6006 | 2010-10-30 12:15:07 +0100 | [diff] [blame] | 854 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 855 | LWS_EXTERN int |
Andy Green | e77ddd8 | 2010-11-13 10:03:47 +0000 | [diff] [blame] | 856 | libwebsocket_write(struct libwebsocket *wsi, unsigned char *buf, size_t len, |
Andy Green | 5fd8a5e | 2010-10-31 11:57:17 +0000 | [diff] [blame] | 857 | enum libwebsocket_write_protocol protocol); |
Andy Green | a2b0ab0 | 2010-11-11 12:28:29 +0000 | [diff] [blame] | 858 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 859 | LWS_EXTERN int |
Andy Green | d280b6e | 2013-01-15 13:40:23 +0800 | [diff] [blame] | 860 | libwebsockets_serve_http_file(struct libwebsocket_context *context, |
| 861 | struct libwebsocket *wsi, const char *file, |
Andy Green | e77ddd8 | 2010-11-13 10:03:47 +0000 | [diff] [blame] | 862 | const char *content_type); |
Andy Green | d280b6e | 2013-01-15 13:40:23 +0800 | [diff] [blame] | 863 | LWS_EXTERN int |
| 864 | libwebsockets_serve_http_file_fragment(struct libwebsocket_context *context, |
| 865 | struct libwebsocket *wsi); |
Andy Green | ab990e4 | 2010-10-31 12:42:52 +0000 | [diff] [blame] | 866 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 867 | LWS_EXTERN const struct libwebsocket_protocols * |
Andy Green | b45993c | 2010-12-18 15:13:50 +0000 | [diff] [blame] | 868 | libwebsockets_get_protocol(struct libwebsocket *wsi); |
| 869 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 870 | LWS_EXTERN int |
Darin Willits | c19456f | 2011-02-14 17:52:39 +0000 | [diff] [blame] | 871 | libwebsocket_callback_on_writable(struct libwebsocket_context *context, |
Andy Green | 62c54d2 | 2011-02-14 09:14:25 +0000 | [diff] [blame] | 872 | struct libwebsocket *wsi); |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 873 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 874 | LWS_EXTERN int |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 875 | libwebsocket_callback_on_writable_all_protocol( |
| 876 | const struct libwebsocket_protocols *protocol); |
| 877 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 878 | LWS_EXTERN int |
Andy Green | a6cbece | 2011-01-27 20:06:03 +0000 | [diff] [blame] | 879 | libwebsocket_get_socket_fd(struct libwebsocket *wsi); |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 880 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 881 | LWS_EXTERN int |
Andy Green | 82c3d54 | 2011-03-07 21:16:31 +0000 | [diff] [blame] | 882 | libwebsocket_is_final_fragment(struct libwebsocket *wsi); |
| 883 | |
David Galeano | e2cf992 | 2013-01-09 18:06:55 +0800 | [diff] [blame] | 884 | LWS_EXTERN unsigned char |
| 885 | libwebsocket_get_reserved_bits(struct libwebsocket *wsi); |
| 886 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 887 | LWS_EXTERN int |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 888 | libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable); |
| 889 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 890 | LWS_EXTERN size_t |
Andy Green | 38e57bb | 2011-01-19 12:20:27 +0000 | [diff] [blame] | 891 | libwebsockets_remaining_packet_payload(struct libwebsocket *wsi); |
| 892 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 893 | LWS_EXTERN struct libwebsocket * |
Andy Green | 4739e5c | 2011-01-22 12:51:57 +0000 | [diff] [blame] | 894 | libwebsocket_client_connect(struct libwebsocket_context *clients, |
| 895 | const char *address, |
| 896 | int port, |
Andy Green | 90c7cbc | 2011-01-27 06:26:52 +0000 | [diff] [blame] | 897 | int ssl_connection, |
Andy Green | 4739e5c | 2011-01-22 12:51:57 +0000 | [diff] [blame] | 898 | const char *path, |
| 899 | const char *host, |
| 900 | const char *origin, |
Andy Green | bfb051f | 2011-02-09 08:49:14 +0000 | [diff] [blame] | 901 | const char *protocol, |
| 902 | int ietf_version_or_minus_one); |
Andy Green | 4739e5c | 2011-01-22 12:51:57 +0000 | [diff] [blame] | 903 | |
David Brooks | 2c60d95 | 2012-04-20 12:19:01 +0800 | [diff] [blame] | 904 | LWS_EXTERN struct libwebsocket * |
| 905 | libwebsocket_client_connect_extended(struct libwebsocket_context *clients, |
| 906 | const char *address, |
| 907 | int port, |
| 908 | int ssl_connection, |
| 909 | const char *path, |
| 910 | const char *host, |
| 911 | const char *origin, |
| 912 | const char *protocol, |
| 913 | int ietf_version_or_minus_one, |
| 914 | void *userdata); |
| 915 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 916 | LWS_EXTERN const char * |
Darin Willits | c19456f | 2011-02-14 17:52:39 +0000 | [diff] [blame] | 917 | libwebsocket_canonical_hostname(struct libwebsocket_context *context); |
Andy Green | 2ac5a6f | 2011-01-28 10:00:18 +0000 | [diff] [blame] | 918 | |
Andy Green | 4739e5c | 2011-01-22 12:51:57 +0000 | [diff] [blame] | 919 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 920 | LWS_EXTERN void |
Andy Green | aaf0b9f | 2013-01-30 08:12:20 +0800 | [diff] [blame] | 921 | libwebsockets_get_peer_addresses(struct libwebsocket_context *context, |
| 922 | struct libwebsocket *wsi, int fd, char *name, int name_len, |
Andy Green | 0703409 | 2011-02-13 08:37:12 +0000 | [diff] [blame] | 923 | char *rip, int rip_len); |
| 924 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 925 | LWS_EXTERN int |
Andy Green | 8acc194 | 2011-03-07 20:47:40 +0000 | [diff] [blame] | 926 | libwebsockets_get_random(struct libwebsocket_context *context, |
| 927 | void *buf, int len); |
| 928 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 929 | LWS_EXTERN int |
Andy Green | 279a303 | 2013-01-17 10:05:39 +0800 | [diff] [blame] | 930 | lws_daemonize(const char *_lock_path); |
| 931 | |
| 932 | LWS_EXTERN int |
Andy Green | 043a0ba | 2011-04-25 23:54:11 +0800 | [diff] [blame] | 933 | lws_send_pipe_choked(struct libwebsocket *wsi); |
| 934 | |
Andy Green | 2fd3f2f | 2013-01-18 09:49:20 +0800 | [diff] [blame] | 935 | LWS_EXTERN int |
| 936 | lws_frame_is_binary(struct libwebsocket *wsi); |
| 937 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 938 | LWS_EXTERN unsigned char * |
Andy Green | 2836c64 | 2011-03-07 20:47:41 +0000 | [diff] [blame] | 939 | libwebsockets_SHA1(const unsigned char *d, size_t n, unsigned char *md); |
| 940 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 941 | LWS_EXTERN int |
Andy Green | f94e058 | 2011-05-14 15:07:56 +0200 | [diff] [blame] | 942 | lws_b64_encode_string(const char *in, int in_len, char *out, int out_size); |
| 943 | |
David Galeano | 9454e21 | 2011-09-26 12:17:20 +0100 | [diff] [blame] | 944 | LWS_EXTERN int |
Andy Green | f94e058 | 2011-05-14 15:07:56 +0200 | [diff] [blame] | 945 | lws_b64_decode_string(const char *in, char *out, int out_size); |
| 946 | |
Andy Green | 7b40545 | 2013-02-01 10:50:15 +0800 | [diff] [blame] | 947 | LWS_EXTERN const char * |
| 948 | lws_get_library_version(void); |
| 949 | |
Andy Green | 16ab318 | 2013-02-10 18:02:31 +0800 | [diff] [blame] | 950 | /* access to headers... only valid while headers valid */ |
| 951 | |
Joakim Soderberg | f272cb0 | 2013-02-13 09:29:26 +0800 | [diff] [blame] | 952 | LWS_EXTERN int |
Andy Green | 16ab318 | 2013-02-10 18:02:31 +0800 | [diff] [blame] | 953 | lws_hdr_total_length(struct libwebsocket *wsi, enum lws_token_indexes h); |
| 954 | |
Joakim Soderberg | f272cb0 | 2013-02-13 09:29:26 +0800 | [diff] [blame] | 955 | LWS_EXTERN int |
Andy Green | b5b2319 | 2013-02-11 17:13:32 +0800 | [diff] [blame] | 956 | lws_hdr_copy(struct libwebsocket *wsi, char *dest, int len, |
| 957 | enum lws_token_indexes h); |
Andy Green | 16ab318 | 2013-02-10 18:02:31 +0800 | [diff] [blame] | 958 | |
Andy Green | ea0642a | 2013-01-29 06:52:00 +0800 | [diff] [blame] | 959 | /* |
| 960 | * Note: this is not normally needed as a user api. It's provided in case it is |
| 961 | * useful when integrating with other app poll loop service code. |
| 962 | */ |
| 963 | |
| 964 | LWS_EXTERN int |
| 965 | libwebsocket_read(struct libwebsocket_context *context, |
| 966 | struct libwebsocket *wsi, |
| 967 | unsigned char *buf, size_t len); |
| 968 | |
Andy Green | 3182ece | 2013-01-20 17:08:31 +0800 | [diff] [blame] | 969 | #ifndef LWS_NO_EXTENSIONS |
Joakim Soderberg | f272cb0 | 2013-02-13 09:29:26 +0800 | [diff] [blame] | 970 | LWS_EXTERN struct libwebsocket_extension *libwebsocket_get_internal_extensions(); |
Andy Green | 3182ece | 2013-01-20 17:08:31 +0800 | [diff] [blame] | 971 | #endif |
Andy Green | 4cd87a0 | 2011-03-06 13:15:32 +0000 | [diff] [blame] | 972 | |
Peter Hinz | 56885f3 | 2011-03-02 22:03:47 +0000 | [diff] [blame] | 973 | #ifdef __cplusplus |
| 974 | } |
| 975 | #endif |
Andy Green | a11fe94 | 2011-09-25 10:30:26 +0100 | [diff] [blame] | 976 | |
Andy Green | ab990e4 | 2010-10-31 12:42:52 +0000 | [diff] [blame] | 977 | #endif |