From 3feab3a16d319b255e1dee3ce15fee66a637deb9 Mon Sep 17 00:00:00 2001 From: Deomid Ryabkov Date: Mon, 25 Jul 2016 16:52:13 +0200 Subject: [PATCH] No-JS mode refactoring Now JS is controlled with a make variable as opposed to a proproc define. This allows skipping compiling a whole bunch of files when JS is disabled, e.g. whole freezing step on ESP, or compiling v7.c on CC3200 which takes a while only to be discarded in its entirety later. Var name is SJ_ENABLE_JS (note change from disable logic to enable to be in line with other stuff). Default is 1, meaning JS is enabled. Also changed clubby knob in the same way: SJ_ENABLE_CLUBBY, default is 1 as well. PUBLISHED_FROM=105277e9536e423d6363a51ff9acea9550a9c496 --- .../http.h/mg_set_protocol_http_websocket.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/c-api/http.h/mg_set_protocol_http_websocket.md b/docs/c-api/http.h/mg_set_protocol_http_websocket.md index 40d4d92b..9dcefcba 100644 --- a/docs/c-api/http.h/mg_set_protocol_http_websocket.md +++ b/docs/c-api/http.h/mg_set_protocol_http_websocket.md @@ -6,40 +6,40 @@ signature: | void mg_set_protocol_http_websocket(struct mg_connection *nc); --- -Attaches a built-in HTTP event handler to the given connection. -The user-defined event handler will receive following extra events: +Attach built-in HTTP event handler to the given connection. +User-defined event handler will receive following extra events: - MG_EV_HTTP_REQUEST: HTTP request has arrived. Parsed HTTP request is passed as `struct http_message` through the handler's `void *ev_data` pointer. - MG_EV_HTTP_MULTIPART_REQUEST: A multipart POST request has received. - This event is sent before body is parsed. After this, the user + This event is sent before body is parsed. After this user should expect a sequence of MG_EV_HTTP_PART_BEGIN/DATA/END requests. This is also the last time when headers and other request fields are accessible. -- MG_EV_HTTP_REPLY: The HTTP reply has arrived. The parsed HTTP reply is passed as +- MG_EV_HTTP_REPLY: HTTP reply has arrived. Parsed HTTP reply is passed as `struct http_message` through the handler's `void *ev_data` pointer. -- MG_EV_HTTP_CHUNK: The HTTP chunked-encoding chunk has arrived. - The parsed HTTP reply is passed as `struct http_message` through the +- MG_EV_HTTP_CHUNK: HTTP chunked-encoding chunk has arrived. + Parsed HTTP reply is passed as `struct http_message` through the handler's `void *ev_data` pointer. `http_message::body` would contain incomplete, reassembled HTTP body. - It will grow with every new chunk that arrives, and it can - potentially consume a lot of memory. An event handler may process + It will grow with every new chunk arrived, and + potentially can consume a lot of memory. An event handler may process the body as chunks are coming, and signal Mongoose to delete processed body by setting `MG_F_DELETE_CHUNK` in `mg_connection::flags`. When the last zero chunk is received, Mongoose sends `MG_EV_HTTP_REPLY` event with full reassembled body (if handler did not signal to delete chunks) or with empty body (if handler did signal to delete chunks). -- MG_EV_WEBSOCKET_HANDSHAKE_REQUEST: server has received the WebSocket handshake +- MG_EV_WEBSOCKET_HANDSHAKE_REQUEST: server has received websocket handshake request. `ev_data` contains parsed HTTP request. -- MG_EV_WEBSOCKET_HANDSHAKE_DONE: server has completed the WebSocket handshake. +- MG_EV_WEBSOCKET_HANDSHAKE_DONE: server has completed Websocket handshake. `ev_data` is `NULL`. -- MG_EV_WEBSOCKET_FRAME: new WebSocket frame has arrived. `ev_data` is +- MG_EV_WEBSOCKET_FRAME: new websocket frame has arrived. `ev_data` is `struct websocket_message *` - MG_EV_HTTP_PART_BEGIN: new part of multipart message is started, extra parameters are passed in mg_http_multipart_part -- MG_EV_HTTP_PART_DATA: new portion of data from the multiparted message +- MG_EV_HTTP_PART_DATA: new portion of data from multiparted message no additional headers are available, only data and data size - MG_EV_HTTP_PART_END: final boundary received, analogue to maybe used to find the end of packet