mirror of
https://github.com/cesanta/mongoose.git
synced 2026-10-04 07:04:14 +07:00
2.5 KiB
2.5 KiB
title, decl_name, symbol_kind, signature
| title | decl_name | symbol_kind | signature |
|---|---|---|---|
| mg_set_protocol_http_websocket() | mg_set_protocol_http_websocket | func | 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:
- MG_EV_HTTP_REQUEST: HTTP request has arrived. Parsed HTTP request
is passed as
struct http_messagethrough the handler'svoid *ev_datapointer. - MG_EV_HTTP_MULTIPART_REQUEST: A multipart POST request has received. This event is sent before body is parsed. After this, the 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
struct http_messagethrough the handler'svoid *ev_datapointer. - MG_EV_HTTP_CHUNK: The HTTP chunked-encoding chunk has arrived.
The parsed HTTP reply is passed as
struct http_messagethrough the handler'svoid *ev_datapointer.http_message::bodywould 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 the body as chunks are coming, and signal Mongoose to delete processed body by settingMG_F_DELETE_CHUNKinmg_connection::flags. When the last zero chunk is received, Mongoose sendsMG_EV_HTTP_REPLYevent 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 request.
ev_datacontains parsed HTTP request. - MG_EV_WEBSOCKET_HANDSHAKE_DONE: server has completed the WebSocket
handshake.
ev_dataisNULL. - MG_EV_WEBSOCKET_FRAME: new WebSocket frame has arrived.
ev_dataisstruct 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 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 Note: Mongoose should be compiled with MG_ENABLE_HTTP_STREAMING_MULTIPART to enable MG_EV_HTTP_MULTIPART_REQUEST, MG_EV_HTTP_REQUEST_END, MG_EV_HTTP_REQUEST_CANCEL, MG_EV_HTTP_PART_BEGIN, MG_EV_HTTP_PART_DATA, MG_EV_HTTP_PART_END constants