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-03-01 00:26:30 +00:00
< title > WebSocket | uWebSockets.js v17.3.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-03-01 00:26:30 +00:00
< a href = "../index.html" class = "title" > uWebSockets.js v17.3.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 = "websocket.html" > WebSocket< / a >
< / li >
< / ul >
< h1 > Interface WebSocket< / 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" >
< p > A WebSocket connection that is valid from open to close event< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > WebSocket< / span >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-kind-interface" >
2019-03-10 11:52:42 +00:00
< h3 class = "tsd-before-signature" > Indexable< / h3 >
< div class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > [< / span > key: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ]: < / span > < span class = "tsd-signature-type" > any< / span > < / div >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Arbitrary user data may be attached to this object< / p >
< / div >
< / div >
< / section >
2019-02-13 03:13:35 +00:00
< 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 > Methods< / h3 >
< ul class = "tsd-index-list" >
2019-12-21 19:46:31 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "websocket.html#close" class = "tsd-kind-icon" > close< / a > < / li >
2020-01-10 18:02:51 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "websocket.html#cork" class = "tsd-kind-icon" > cork< / a > < / li >
2019-12-21 19:46:31 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "websocket.html#end" class = "tsd-kind-icon" > end< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "websocket.html#getbufferedamount" class = "tsd-kind-icon" > get< wbr > Buffered< wbr > Amount< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "websocket.html#getremoteaddress" class = "tsd-kind-icon" > get< wbr > Remote< wbr > Address< / a > < / li >
2020-01-19 19:24:44 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "websocket.html#ping" class = "tsd-kind-icon" > ping< / a > < / li >
2019-12-21 19:46:31 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "websocket.html#publish" class = "tsd-kind-icon" > publish< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "websocket.html#send" class = "tsd-kind-icon" > send< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "websocket.html#subscribe" class = "tsd-kind-icon" > subscribe< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "websocket.html#unsubscribe" class = "tsd-kind-icon" > unsubscribe< / a > < / li >
2020-01-19 19:24:44 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "websocket.html#unsubscribeall" class = "tsd-kind-icon" > unsubscribe< wbr > All< / 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 > Methods< / h2 >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "close" class = "tsd-anchor" > < / a >
< h3 > close< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< li class = "tsd-signature tsd-kind-icon" > close< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2020-03-01 00:26:30 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/9840bb0/docs/index.d.ts#L23" > index.d.ts:23< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2019-12-21 19:46:31 +00:00
< p > Forcefully closes this WebSocket< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / h4 >
< / li >
< / ul >
< / section >
2020-01-10 18:02:51 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "cork" class = "tsd-anchor" > < / a >
< h3 > cork< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > cork< span class = "tsd-signature-symbol" > (< / span > cb< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > function< / 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" >
< aside class = "tsd-sources" >
< ul >
2020-03-01 00:26:30 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/9840bb0/docs/index.d.ts#L41" > index.d.ts:41< / a > < / li >
2020-01-10 18:02:51 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > See HttpResponse.cork< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > cb: < span class = "tsd-signature-type" > function< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-siganture" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-is-not-exported" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / 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-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "end" class = "tsd-anchor" > < / a >
< h3 > end< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2019-06-09 09:38:09 +00:00
< li class = "tsd-signature tsd-kind-icon" > end< span class = "tsd-signature-symbol" > (< / span > code< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > number< / span > , shortMessage< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2020-03-01 00:26:30 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/9840bb0/docs/index.d.ts#L20" > index.d.ts:20< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2019-12-21 19:46:31 +00:00
< p > Gracefully closes this WebSocket. Immediately calls close handler.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2019-06-09 09:38:09 +00:00
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > code: < span class = "tsd-signature-type" > number< / span > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< li >
2019-06-09 09:38:09 +00:00
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > shortMessage: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / h4 >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "getbufferedamount" class = "tsd-anchor" > < / a >
< h3 > get< wbr > Buffered< wbr > Amount< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< li class = "tsd-signature tsd-kind-icon" > get< wbr > Buffered< wbr > Amount< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2020-03-01 00:26:30 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/9840bb0/docs/index.d.ts#L17" > index.d.ts:17< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns the bytes buffered in backpressure.< / p >
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > number< / span > < / h4 >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2019-03-03 07:15:48 +00:00
< a name = "getremoteaddress" class = "tsd-anchor" > < / a >
< h3 > get< wbr > Remote< wbr > Address< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2019-03-03 07:15:48 +00:00
< li class = "tsd-signature tsd-kind-icon" > get< wbr > Remote< wbr > Address< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > ArrayBuffer< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2020-03-01 00:26:30 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/9840bb0/docs/index.d.ts#L44" > index.d.ts:44< / a > < / li >
2019-03-03 07:15:48 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns the remote IP address< / p >
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > ArrayBuffer< / span > < / h4 >
< / li >
< / ul >
< / section >
2020-01-19 19:24:44 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "ping" class = "tsd-anchor" > < / a >
< h3 > ping< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > ping< span class = "tsd-signature-symbol" > (< / span > message< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2020-03-01 00:26:30 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/9840bb0/docs/index.d.ts#L26" > index.d.ts:26< / a > < / li >
2020-01-19 19:24:44 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Sends a ping control message. Returns true on success, see WebSocket.send. This helper function correlates to WebSocket::send(message, uWS::OpCode::PING, ...).< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > message: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "publish" class = "tsd-anchor" > < / a >
< h3 > publish< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2019-10-09 13:24:56 +00:00
< li class = "tsd-signature tsd-kind-icon" > publish< span class = "tsd-signature-symbol" > (< / span > topic< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > , message< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > , isBinary< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > , compress< 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 > < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2020-03-01 00:26:30 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/9840bb0/docs/index.d.ts#L38" > index.d.ts:38< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Publish a message to a topic in MQTT syntax< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2019-03-03 07:15:48 +00:00
< h5 > topic: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< li >
2019-03-03 07:15:48 +00:00
< h5 > message: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
2019-10-09 13:24:56 +00:00
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > isBinary: < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > compress: < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
2019-02-13 03:13:35 +00:00
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / h4 >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "send" class = "tsd-anchor" > < / a >
< h3 > send< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2019-06-09 09:38:09 +00:00
< li class = "tsd-signature tsd-kind-icon" > send< span class = "tsd-signature-symbol" > (< / span > message< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > , isBinary< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > , compress< 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" > boolean< / span > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2020-03-01 00:26:30 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/9840bb0/docs/index.d.ts#L14" > index.d.ts:14< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Sends a message. Make sure to check getBufferedAmount() before sending. Returns true for success, false for built up backpressure that will drain when time is given.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2019-03-03 07:15:48 +00:00
< h5 > message: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< li >
2019-06-09 09:38:09 +00:00
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > isBinary: < span class = "tsd-signature-type" > boolean< / span > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< li >
2019-06-09 09:38:09 +00:00
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > compress: < span class = "tsd-signature-type" > boolean< / span > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "subscribe" class = "tsd-anchor" > < / a >
< h3 > subscribe< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2019-03-03 07:15:48 +00:00
< li class = "tsd-signature tsd-kind-icon" > subscribe< span class = "tsd-signature-symbol" > (< / span > topic< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2020-03-01 00:26:30 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/9840bb0/docs/index.d.ts#L29" > index.d.ts:29< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Subscribe to a topic in MQTT syntax< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2019-03-03 07:15:48 +00:00
< h5 > topic: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "websocket.html" class = "tsd-signature-type" > WebSocket< / a > < / h4 >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "unsubscribe" class = "tsd-anchor" > < / a >
< h3 > unsubscribe< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2019-10-09 13:24:56 +00:00
< li class = "tsd-signature tsd-kind-icon" > unsubscribe< span class = "tsd-signature-symbol" > (< / span > topic< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2020-03-01 00:26:30 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/9840bb0/docs/index.d.ts#L32" > index.d.ts:32< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2019-10-09 13:24:56 +00:00
< p > Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2019-03-03 07:15:48 +00:00
< h5 > topic: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
2019-10-09 13:24:56 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< / section >
2020-01-19 19:24:44 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "unsubscribeall" class = "tsd-anchor" > < / a >
< h3 > unsubscribe< wbr > All< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > unsubscribe< wbr > All< span class = "tsd-signature-symbol" > (< / 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" >
< aside class = "tsd-sources" >
< ul >
2020-03-01 00:26:30 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/9840bb0/docs/index.d.ts#L35" > index.d.ts:35< / a > < / li >
2020-01-19 19:24:44 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Unsubscribe from all topics.< / p >
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / 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 >
< / 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 = "websocket.html" class = "tsd-kind-icon" > Web< wbr > Socket< / a >
< ul >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocket.html#close" class = "tsd-kind-icon" > close< / a >
< / li >
2020-01-10 18:02:51 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "websocket.html#cork" class = "tsd-kind-icon" > cork< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocket.html#end" class = "tsd-kind-icon" > end< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocket.html#getbufferedamount" class = "tsd-kind-icon" > get< wbr > Buffered< wbr > Amount< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2019-03-03 07:15:48 +00:00
< a href = "websocket.html#getremoteaddress" class = "tsd-kind-icon" > get< wbr > Remote< wbr > Address< / a >
< / li >
2020-01-19 19:24:44 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "websocket.html#ping" class = "tsd-kind-icon" > ping< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocket.html#publish" class = "tsd-kind-icon" > publish< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocket.html#send" class = "tsd-kind-icon" > send< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocket.html#subscribe" class = "tsd-kind-icon" > subscribe< / a >
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a href = "websocket.html#unsubscribe" class = "tsd-kind-icon" > unsubscribe< / a >
< / li >
2020-01-19 19:24:44 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "websocket.html#unsubscribeall" class = "tsd-kind-icon" > unsubscribe< wbr > All< / 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 = "websocketbehavior.html" class = "tsd-kind-icon" > Web< wbr > Socket< wbr > Behavior< / 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 = "us_listen_socket.html" class = "tsd-kind-icon" > us_< wbr > listen_< wbr > socket< / 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 >
2019-11-18 18:37:30 +00:00
< li class = " tsd-kind-variable" >
< a href = "../index.html#dedicated_compressor" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR< / 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 >
2019-10-09 13:24:56 +00:00
< li class = "tsd-kind-type-alias tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Type alias with type parameter< / span > < / li >
2019-02-13 03:13:35 +00:00
< / 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" >
2019-10-09 13:24:56 +00:00
< p > Generated using < a href = "https://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 >
