2019-02-13 03:13:35 +00:00
<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
2020-06-08 12:29:54 +00:00
< title > WebSocketBehavior | uWebSockets.js v18.1.0 documentation< / title >
2019-02-13 03:13:35 +00:00
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.js" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
2020-06-08 12:29:54 +00:00
< a href = "../index.html" class = "title" > uWebSockets.js v18.1.0 documentation< / a >
2019-02-13 03:13:35 +00:00
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-only-exported" / >
< label class = "tsd-widget" for = "tsd-filter-only-exported" > Only exported< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "../index.html" > Globals< / a >
< / li >
< li >
< a href = "websocketbehavior.html" > WebSocketBehavior< / a >
< / li >
< / ul >
< h1 > Interface WebSocketBehavior< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-05-20 18:23:46 +00:00
< p > A structure holding settings and handlers for a WebSocket URL route handler.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > WebSocketBehavior< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > Index< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
2019-12-21 19:46:31 +00:00
< section class = "tsd-index-section " >
2019-02-13 03:13:35 +00:00
< h3 > Properties< / h3 >
< ul class = "tsd-index-list" >
2019-12-21 19:46:31 +00:00
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "websocketbehavior.html#close" class = "tsd-kind-icon" > close< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "websocketbehavior.html#compression" class = "tsd-kind-icon" > compression< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "websocketbehavior.html#drain" class = "tsd-kind-icon" > drain< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "websocketbehavior.html#idletimeout" class = "tsd-kind-icon" > idle< wbr > Timeout< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "websocketbehavior.html#maxbackpressure" class = "tsd-kind-icon" > max< wbr > Backpressure< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "websocketbehavior.html#maxpayloadlength" class = "tsd-kind-icon" > max< wbr > Payload< wbr > Length< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "websocketbehavior.html#message" class = "tsd-kind-icon" > message< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "websocketbehavior.html#open" class = "tsd-kind-icon" > open< / a > < / li >
2020-03-01 00:35:14 +00:00
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "websocketbehavior.html#ping" class = "tsd-kind-icon" > ping< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "websocketbehavior.html#pong" class = "tsd-kind-icon" > pong< / a > < / li >
2020-06-08 12:29:54 +00:00
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "websocketbehavior.html#upgrade" class = "tsd-kind-icon" > upgrade< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / section >
< / div >
< / section >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel-group tsd-member-group " >
2019-02-13 03:13:35 +00:00
< h2 > Properties< / h2 >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "close" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > close< / h3 >
< div class = "tsd-signature tsd-kind-icon" > close< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > function< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2020-06-08 14:51:11 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/1989d69/docs/index.d.ts#L201" > index.d.ts:201< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-05-20 18:23:46 +00:00
< p > Handler for close event, no matter if error, timeout or graceful close. You may not use WebSocket after this event. Do not send on this WebSocket from within here, it is closed.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-siganture" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > ws< span class = "tsd-signature-symbol" > : < / span > < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > , code< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > , message< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > ArrayBuffer< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > ws: < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / h5 >
< / li >
< li >
< h5 > code: < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li >
< h5 > message: < span class = "tsd-signature-type" > ArrayBuffer< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "compression" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > compression< / h3 >
2019-11-18 18:37:30 +00:00
< div class = "tsd-signature tsd-kind-icon" > compression< span class = "tsd-signature-symbol" > :< / span > < a href = "../index.html#compressoptions" class = "tsd-signature-type" > CompressOptions< / a > < / div >
2019-02-13 03:13:35 +00:00
< aside class = "tsd-sources" >
< ul >
2020-06-08 14:51:11 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/1989d69/docs/index.d.ts#L187" > index.d.ts:187< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-05-20 18:23:46 +00:00
< p > What permessage-deflate compression to use. uWS.DISABLED, uWS.SHARED_COMPRESSOR or any of the uWS.DEDICATED_COMPRESSOR_xxxKB.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "drain" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > drain< / h3 >
< div class = "tsd-signature tsd-kind-icon" > drain< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > function< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2020-06-08 14:51:11 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/1989d69/docs/index.d.ts#L199" > index.d.ts:199< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-05-20 18:23:46 +00:00
< p > Handler for when WebSocket backpressure drains. Check ws.getBufferedAmount(). Use this to guide / drive your backpressure throttling.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-siganture" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > ws< span class = "tsd-signature-symbol" > : < / span > < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > ws: < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "idletimeout" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > idle< wbr > Timeout< / h3 >
< div class = "tsd-signature tsd-kind-icon" > idle< wbr > Timeout< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2020-06-08 14:51:11 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/1989d69/docs/index.d.ts#L185" > index.d.ts:185< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-05-20 18:23:46 +00:00
< p > Maximum amount of seconds that may pass without sending or getting a message. Connection is closed if this timeout passes. Resolution (granularity) for timeouts are typically 4 seconds, rounded to closest.
Disable by leaving 0.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
2019-10-09 13:24:56 +00:00
< a name = "maxbackpressure" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > max< wbr > Backpressure< / h3 >
< div class = "tsd-signature tsd-kind-icon" > max< wbr > Backpressure< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2020-06-08 14:51:11 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/1989d69/docs/index.d.ts#L189" > index.d.ts:189< / a > < / li >
2019-10-09 13:24:56 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-05-20 18:23:46 +00:00
< p > Maximum length of allowed backpressure per socket when PUBLISHING messages (does not apply to ws.send). Slow receivers with too high backpressure will be skipped until they catch up or timeout.< / p >
2019-10-09 13:24:56 +00:00
< / div >
< / div >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "maxpayloadlength" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > max< wbr > Payload< wbr > Length< / h3 >
< div class = "tsd-signature tsd-kind-icon" > max< wbr > Payload< wbr > Length< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2020-06-08 14:51:11 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/1989d69/docs/index.d.ts#L181" > index.d.ts:181< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-05-20 18:23:46 +00:00
< p > Maximum length of received message. If a client tries to send you a message larger than this, the connection is immediately closed.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "message" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > message< / h3 >
< div class = "tsd-signature tsd-kind-icon" > message< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > function< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2020-06-08 14:51:11 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/1989d69/docs/index.d.ts#L197" > index.d.ts:197< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-05-20 18:23:46 +00:00
< p > Handler for a WebSocket message. Messages are given as ArrayBuffer no matter if they are binary or not. Given ArrayBuffer is valid during the lifetime of this callback (until first await or return) and will be neutered.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-siganture" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > ws< span class = "tsd-signature-symbol" > : < / span > < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > , message< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > ArrayBuffer< / span > , isBinary< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > ws: < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / h5 >
< / li >
< li >
< h5 > message: < span class = "tsd-signature-type" > ArrayBuffer< / span > < / h5 >
< / li >
< li >
< h5 > isBinary: < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "open" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > open< / h3 >
< div class = "tsd-signature tsd-kind-icon" > open< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > function< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2020-06-08 14:51:11 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/1989d69/docs/index.d.ts#L195" > index.d.ts:195< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-06-08 14:51:11 +00:00
< p > Handler for new WebSocket connection. WebSocket is valid from open to close, no errors.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-siganture" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported" >
2020-06-08 14:51:11 +00:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > ws< span class = "tsd-signature-symbol" > : < / span > < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > ws: < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / section >
2020-03-01 00:35:14 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "ping" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > ping< / h3 >
< div class = "tsd-signature tsd-kind-icon" > ping< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > function< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2020-06-08 14:51:11 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/1989d69/docs/index.d.ts#L203" > index.d.ts:203< / a > < / li >
2020-03-01 00:35:14 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-05-20 18:23:46 +00:00
< p > Handler for received ping control message. You do not need to handle this, pong messages are automatically sent as per the standard.< / p >
2020-03-01 00:35:14 +00:00
< / div >
< / div >
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-siganture" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > ws< span class = "tsd-signature-symbol" > : < / span > < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > ws: < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "pong" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > pong< / h3 >
< div class = "tsd-signature tsd-kind-icon" > pong< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > function< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2020-06-08 14:51:11 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/1989d69/docs/index.d.ts#L205" > index.d.ts:205< / a > < / li >
2020-03-01 00:35:14 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Handler for received pong control message.< / p >
< / div >
< / div >
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-siganture" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > ws< span class = "tsd-signature-symbol" > : < / span > < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > ws: < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / section >
2020-06-08 12:29:54 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "upgrade" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > upgrade< / h3 >
< div class = "tsd-signature tsd-kind-icon" > upgrade< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > function< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2020-06-08 14:51:11 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/1989d69/docs/index.d.ts#L193" > index.d.ts:193< / a > < / li >
2020-06-08 12:29:54 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Upgrade handler used to intercept HTTP upgrade requests and potentially upgrade to WebSocket.
See UpgradeAsync and UpgradeSync example files.< / p >
< / div >
< / div >
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-siganture" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > res< span class = "tsd-signature-symbol" > : < / span > < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > , req< span class = "tsd-signature-symbol" > : < / span > < a href = "httprequest.html" class = "tsd-signature-type" > HttpRequest< / a > , context< span class = "tsd-signature-symbol" > : < / span > < a href = "us_socket_context_t.html" class = "tsd-signature-type" > us_socket_context_t< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > res: < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / h5 >
< / li >
< li >
< h5 > req: < a href = "httprequest.html" class = "tsd-signature-type" > HttpRequest< / a > < / h5 >
< / li >
< li >
< h5 > context: < a href = "us_socket_context_t.html" class = "tsd-signature-type" > us_socket_context_t< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / section >
2019-02-13 03:13:35 +00:00
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = "globals " >
< a href = "../index.html" > < em > Globals< / em > < / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "appoptions.html" class = "tsd-kind-icon" > App< wbr > Options< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "httprequest.html" class = "tsd-kind-icon" > Http< wbr > Request< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "httpresponse.html" class = "tsd-kind-icon" > Http< wbr > Response< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "templatedapp.html" class = "tsd-kind-icon" > Templated< wbr > App< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocket.html" class = "tsd-kind-icon" > Web< wbr > Socket< / a >
< / li >
< / ul >
< ul class = "current" >
2019-12-21 19:46:31 +00:00
< li class = "current tsd-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocketbehavior.html" class = "tsd-kind-icon" > Web< wbr > Socket< wbr > Behavior< / a >
< ul >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocketbehavior.html#close" class = "tsd-kind-icon" > close< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocketbehavior.html#compression" class = "tsd-kind-icon" > compression< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocketbehavior.html#drain" class = "tsd-kind-icon" > drain< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocketbehavior.html#idletimeout" class = "tsd-kind-icon" > idle< wbr > Timeout< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-property tsd-parent-kind-interface" >
2019-10-09 13:24:56 +00:00
< a href = "websocketbehavior.html#maxbackpressure" class = "tsd-kind-icon" > max< wbr > Backpressure< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocketbehavior.html#maxpayloadlength" class = "tsd-kind-icon" > max< wbr > Payload< wbr > Length< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocketbehavior.html#message" class = "tsd-kind-icon" > message< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-property tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocketbehavior.html#open" class = "tsd-kind-icon" > open< / a >
< / li >
2020-03-01 00:35:14 +00:00
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "websocketbehavior.html#ping" class = "tsd-kind-icon" > ping< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "websocketbehavior.html#pong" class = "tsd-kind-icon" > pong< / a >
< / li >
2020-06-08 12:29:54 +00:00
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "websocketbehavior.html#upgrade" class = "tsd-kind-icon" > upgrade< / a >
< / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "us_listen_socket.html" class = "tsd-kind-icon" > us_< wbr > listen_< wbr > socket< / a >
< / li >
2020-06-08 12:29:54 +00:00
< li class = " tsd-kind-interface" >
< a href = "us_socket_context_t.html" class = "tsd-kind-icon" > us_< wbr > socket_< wbr > context_< wbr > t< / a >
< / li >
2019-11-18 18:37:30 +00:00
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#compressoptions" class = "tsd-kind-icon" > Compress< wbr > Options< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-type-alias" >
2019-03-03 07:15:48 +00:00
< a href = "../index.html#recognizedstring" class = "tsd-kind-icon" > Recognized< wbr > String< / a >
< / li >
2020-03-01 00:26:30 +00:00
< li class = " tsd-kind-variable" >
< a href = "../index.html#dedicated_compressor_128kb" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 128KB< / a >
< / li >
< li class = " tsd-kind-variable" >
< a href = "../index.html#dedicated_compressor_16kb" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 16KB< / a >
< / li >
< li class = " tsd-kind-variable" >
< a href = "../index.html#dedicated_compressor_256kb" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 256KB< / a >
< / li >
< li class = " tsd-kind-variable" >
< a href = "../index.html#dedicated_compressor_32kb" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 32KB< / a >
< / li >
< li class = " tsd-kind-variable" >
< a href = "../index.html#dedicated_compressor_3kb" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 3KB< / a >
< / li >
< li class = " tsd-kind-variable" >
< a href = "../index.html#dedicated_compressor_4kb" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 4KB< / a >
< / li >
< li class = " tsd-kind-variable" >
< a href = "../index.html#dedicated_compressor_64kb" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 64KB< / a >
< / li >
< li class = " tsd-kind-variable" >
< a href = "../index.html#dedicated_compressor_8kb" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 8KB< / a >
< / li >
2019-11-18 18:37:30 +00:00
< li class = " tsd-kind-variable" >
< a href = "../index.html#disabled" class = "tsd-kind-icon" > DISABLED< / a >
< / li >
< li class = " tsd-kind-variable" >
< a href = "../index.html#shared_compressor" class = "tsd-kind-icon" > SHARED_< wbr > COMPRESSOR< / a >
< / li >
2019-02-13 03:13:35 +00:00
< li class = " tsd-kind-function" >
< a href = "../index.html#app" class = "tsd-kind-icon" > App< / a >
< / li >
< li class = " tsd-kind-function" >
< a href = "../index.html#sslapp" class = "tsd-kind-icon" > SSLApp< / a >
< / li >
< li class = " tsd-kind-function" >
< a href = "../index.html#us_listen_socket_close" class = "tsd-kind-icon" > us_< wbr > listen_< wbr > socket_< wbr > close< / a >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > Legend< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-module" > < span class = "tsd-kind-icon" > Module< / span > < / li >
< li class = "tsd-kind-object-literal" > < span class = "tsd-kind-icon" > Object literal< / span > < / li >
< li class = "tsd-kind-variable" > < span class = "tsd-kind-icon" > Variable< / span > < / li >
< li class = "tsd-kind-function" > < span class = "tsd-kind-icon" > Function< / span > < / li >
< li class = "tsd-kind-function tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Function with type parameter< / span > < / li >
< li class = "tsd-kind-index-signature" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< li class = "tsd-kind-type-alias" > < span class = "tsd-kind-icon" > Type alias< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-enum" > < span class = "tsd-kind-icon" > Enumeration< / span > < / li >
< li class = "tsd-kind-enum-member" > < span class = "tsd-kind-icon" > Enumeration member< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-enum" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-enum" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-interface" > < span class = "tsd-kind-icon" > Interface< / span > < / li >
< li class = "tsd-kind-interface tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Interface with type parameter< / span > < / li >
< li class = "tsd-kind-constructor tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< li class = "tsd-kind-index-signature tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-class" > < span class = "tsd-kind-icon" > Class< / span > < / li >
< li class = "tsd-kind-class tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Class with type parameter< / span > < / li >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Accessor< / span > < / li >
< li class = "tsd-kind-index-signature tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static property< / span > < / li >
< li class = "tsd-kind-call-signature tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
2020-06-08 12:29:54 +00:00
< p > Generated using < a href = "http://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
2019-02-13 03:13:35 +00:00
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' ) ; < / script >
< / body >
< / html >
