diff --git a/docs/Makefile b/docs/Makefile index 79e8b59..c7f2504 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,2 +1,2 @@ default: - typedoc --out generated --includeDeclarations --excludeExternals --name "uWebSockets.js v18.1.0 documentation" --mode file --readme none . + typedoc --out generated --includeDeclarations --excludeExternals --name "uWebSockets.js v19.0.0 documentation" --mode file --readme none . diff --git a/docs/generated/assets/js/search.json b/docs/generated/assets/js/search.json index 7ba3221..328125a 100644 --- a/docs/generated/assets/js/search.json +++ b/docs/generated/assets/js/search.json @@ -1 +1 @@ -{"kinds":{"32":"Variable","64":"Function","256":"Interface","1024":"Property","2048":"Method","65536":"Type literal","4194304":"Type alias"},"rows":[{"id":0,"kind":256,"name":"us_listen_socket","url":"interfaces/us_listen_socket.html","classes":"tsd-kind-interface"},{"id":1,"kind":256,"name":"us_socket_context_t","url":"interfaces/us_socket_context_t.html","classes":"tsd-kind-interface"},{"id":2,"kind":256,"name":"WebSocket","url":"interfaces/websocket.html","classes":"tsd-kind-interface"},{"id":3,"kind":2048,"name":"send","url":"interfaces/websocket.html#send","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":4,"kind":2048,"name":"getBufferedAmount","url":"interfaces/websocket.html#getbufferedamount","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":5,"kind":2048,"name":"end","url":"interfaces/websocket.html#end","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":6,"kind":2048,"name":"close","url":"interfaces/websocket.html#close","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":7,"kind":2048,"name":"ping","url":"interfaces/websocket.html#ping","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":8,"kind":2048,"name":"subscribe","url":"interfaces/websocket.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":9,"kind":2048,"name":"unsubscribe","url":"interfaces/websocket.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":10,"kind":2048,"name":"unsubscribeAll","url":"interfaces/websocket.html#unsubscribeall","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":11,"kind":2048,"name":"publish","url":"interfaces/websocket.html#publish","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":12,"kind":2048,"name":"cork","url":"interfaces/websocket.html#cork","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":13,"kind":2048,"name":"getRemoteAddress","url":"interfaces/websocket.html#getremoteaddress","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":14,"kind":2048,"name":"getRemoteAddressAsText","url":"interfaces/websocket.html#getremoteaddressastext","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":15,"kind":256,"name":"HttpResponse","url":"interfaces/httpresponse.html","classes":"tsd-kind-interface"},{"id":16,"kind":2048,"name":"writeStatus","url":"interfaces/httpresponse.html#writestatus","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":17,"kind":2048,"name":"writeHeader","url":"interfaces/httpresponse.html#writeheader","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":18,"kind":2048,"name":"write","url":"interfaces/httpresponse.html#write","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":19,"kind":2048,"name":"end","url":"interfaces/httpresponse.html#end","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":20,"kind":2048,"name":"tryEnd","url":"interfaces/httpresponse.html#tryend","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":21,"kind":2048,"name":"close","url":"interfaces/httpresponse.html#close","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":22,"kind":2048,"name":"getWriteOffset","url":"interfaces/httpresponse.html#getwriteoffset","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":23,"kind":2048,"name":"onWritable","url":"interfaces/httpresponse.html#onwritable","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":24,"kind":2048,"name":"onAborted","url":"interfaces/httpresponse.html#onaborted","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":25,"kind":2048,"name":"onData","url":"interfaces/httpresponse.html#ondata","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":26,"kind":2048,"name":"getRemoteAddress","url":"interfaces/httpresponse.html#getremoteaddress","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":27,"kind":2048,"name":"getRemoteAddressAsText","url":"interfaces/httpresponse.html#getremoteaddressastext","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":28,"kind":2048,"name":"getProxiedRemoteAddress","url":"interfaces/httpresponse.html#getproxiedremoteaddress","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":29,"kind":2048,"name":"getProxiedRemoteAddressAsText","url":"interfaces/httpresponse.html#getproxiedremoteaddressastext","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":30,"kind":2048,"name":"cork","url":"interfaces/httpresponse.html#cork","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":31,"kind":2048,"name":"upgrade","url":"interfaces/httpresponse.html#upgrade","classes":"tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter","parent":"HttpResponse"},{"id":32,"kind":256,"name":"HttpRequest","url":"interfaces/httprequest.html","classes":"tsd-kind-interface"},{"id":33,"kind":2048,"name":"getHeader","url":"interfaces/httprequest.html#getheader","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":34,"kind":2048,"name":"getParameter","url":"interfaces/httprequest.html#getparameter","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":35,"kind":2048,"name":"getUrl","url":"interfaces/httprequest.html#geturl","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":36,"kind":2048,"name":"getMethod","url":"interfaces/httprequest.html#getmethod","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":37,"kind":2048,"name":"getQuery","url":"interfaces/httprequest.html#getquery","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":38,"kind":2048,"name":"forEach","url":"interfaces/httprequest.html#foreach","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":39,"kind":2048,"name":"setYield","url":"interfaces/httprequest.html#setyield","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":40,"kind":256,"name":"WebSocketBehavior","url":"interfaces/websocketbehavior.html","classes":"tsd-kind-interface"},{"id":41,"kind":1024,"name":"maxPayloadLength","url":"interfaces/websocketbehavior.html#maxpayloadlength","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":42,"kind":1024,"name":"idleTimeout","url":"interfaces/websocketbehavior.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":43,"kind":1024,"name":"compression","url":"interfaces/websocketbehavior.html#compression","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":44,"kind":1024,"name":"maxBackpressure","url":"interfaces/websocketbehavior.html#maxbackpressure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":45,"kind":1024,"name":"upgrade","url":"interfaces/websocketbehavior.html#upgrade","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":46,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#upgrade.__type-6","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.upgrade"},{"id":47,"kind":1024,"name":"open","url":"interfaces/websocketbehavior.html#open","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":48,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#open.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.open"},{"id":49,"kind":1024,"name":"message","url":"interfaces/websocketbehavior.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":50,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#message.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.message"},{"id":51,"kind":1024,"name":"drain","url":"interfaces/websocketbehavior.html#drain","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":52,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#drain.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.drain"},{"id":53,"kind":1024,"name":"close","url":"interfaces/websocketbehavior.html#close","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":54,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#close.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.close"},{"id":55,"kind":1024,"name":"ping","url":"interfaces/websocketbehavior.html#ping","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":56,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#ping.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.ping"},{"id":57,"kind":1024,"name":"pong","url":"interfaces/websocketbehavior.html#pong","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":58,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#pong.__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.pong"},{"id":59,"kind":256,"name":"AppOptions","url":"interfaces/appoptions.html","classes":"tsd-kind-interface"},{"id":60,"kind":1024,"name":"key_file_name","url":"interfaces/appoptions.html#key_file_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AppOptions"},{"id":61,"kind":1024,"name":"cert_file_name","url":"interfaces/appoptions.html#cert_file_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AppOptions"},{"id":62,"kind":1024,"name":"passphrase","url":"interfaces/appoptions.html#passphrase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AppOptions"},{"id":63,"kind":1024,"name":"dh_params_file_name","url":"interfaces/appoptions.html#dh_params_file_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AppOptions"},{"id":64,"kind":1024,"name":"ssl_prefer_low_memory_usage","url":"interfaces/appoptions.html#ssl_prefer_low_memory_usage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AppOptions"},{"id":65,"kind":256,"name":"TemplatedApp","url":"interfaces/templatedapp.html","classes":"tsd-kind-interface"},{"id":66,"kind":2048,"name":"listen","url":"interfaces/templatedapp.html#listen","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":67,"kind":2048,"name":"get","url":"interfaces/templatedapp.html#get","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":68,"kind":2048,"name":"post","url":"interfaces/templatedapp.html#post","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":69,"kind":2048,"name":"options","url":"interfaces/templatedapp.html#options","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":70,"kind":2048,"name":"del","url":"interfaces/templatedapp.html#del","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":71,"kind":2048,"name":"patch","url":"interfaces/templatedapp.html#patch","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":72,"kind":2048,"name":"put","url":"interfaces/templatedapp.html#put","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":73,"kind":2048,"name":"head","url":"interfaces/templatedapp.html#head","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":74,"kind":2048,"name":"connect","url":"interfaces/templatedapp.html#connect","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":75,"kind":2048,"name":"trace","url":"interfaces/templatedapp.html#trace","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":76,"kind":2048,"name":"any","url":"interfaces/templatedapp.html#any","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":77,"kind":2048,"name":"ws","url":"interfaces/templatedapp.html#ws","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":78,"kind":2048,"name":"publish","url":"interfaces/templatedapp.html#publish","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":79,"kind":4194304,"name":"RecognizedString","url":"index.html#recognizedstring","classes":"tsd-kind-type-alias"},{"id":80,"kind":64,"name":"App","url":"index.html#app","classes":"tsd-kind-function"},{"id":81,"kind":64,"name":"SSLApp","url":"index.html#sslapp","classes":"tsd-kind-function"},{"id":82,"kind":64,"name":"us_listen_socket_close","url":"index.html#us_listen_socket_close","classes":"tsd-kind-function"},{"id":83,"kind":4194304,"name":"CompressOptions","url":"index.html#compressoptions","classes":"tsd-kind-type-alias"},{"id":84,"kind":32,"name":"DISABLED","url":"index.html#disabled","classes":"tsd-kind-variable"},{"id":85,"kind":32,"name":"SHARED_COMPRESSOR","url":"index.html#shared_compressor","classes":"tsd-kind-variable"},{"id":86,"kind":32,"name":"DEDICATED_COMPRESSOR_3KB","url":"index.html#dedicated_compressor_3kb","classes":"tsd-kind-variable"},{"id":87,"kind":32,"name":"DEDICATED_COMPRESSOR_4KB","url":"index.html#dedicated_compressor_4kb","classes":"tsd-kind-variable"},{"id":88,"kind":32,"name":"DEDICATED_COMPRESSOR_8KB","url":"index.html#dedicated_compressor_8kb","classes":"tsd-kind-variable"},{"id":89,"kind":32,"name":"DEDICATED_COMPRESSOR_16KB","url":"index.html#dedicated_compressor_16kb","classes":"tsd-kind-variable"},{"id":90,"kind":32,"name":"DEDICATED_COMPRESSOR_32KB","url":"index.html#dedicated_compressor_32kb","classes":"tsd-kind-variable"},{"id":91,"kind":32,"name":"DEDICATED_COMPRESSOR_64KB","url":"index.html#dedicated_compressor_64kb","classes":"tsd-kind-variable"},{"id":92,"kind":32,"name":"DEDICATED_COMPRESSOR_128KB","url":"index.html#dedicated_compressor_128kb","classes":"tsd-kind-variable"},{"id":93,"kind":32,"name":"DEDICATED_COMPRESSOR_256KB","url":"index.html#dedicated_compressor_256kb","classes":"tsd-kind-variable"}],"index":{"version":"2.3.8","fields":["name","parent"],"fieldVectors":[["name/0",[0,41.484]],["parent/0",[]],["name/1",[1,41.484]],["parent/1",[]],["name/2",[2,19.512]],["parent/2",[]],["name/3",[3,41.484]],["parent/3",[2,1.723]],["name/4",[4,41.484]],["parent/4",[2,1.723]],["name/5",[5,36.376]],["parent/5",[2,1.723]],["name/6",[6,33.011]],["parent/6",[2,1.723]],["name/7",[7,36.376]],["parent/7",[2,1.723]],["name/8",[8,41.484]],["parent/8",[2,1.723]],["name/9",[9,41.484]],["parent/9",[2,1.723]],["name/10",[10,41.484]],["parent/10",[2,1.723]],["name/11",[11,36.376]],["parent/11",[2,1.723]],["name/12",[12,36.376]],["parent/12",[2,1.723]],["name/13",[13,36.376]],["parent/13",[2,1.723]],["name/14",[14,36.376]],["parent/14",[2,1.723]],["name/15",[15,16.917]],["parent/15",[]],["name/16",[16,41.484]],["parent/16",[15,1.494]],["name/17",[17,41.484]],["parent/17",[15,1.494]],["name/18",[18,41.484]],["parent/18",[15,1.494]],["name/19",[5,36.376]],["parent/19",[15,1.494]],["name/20",[19,41.484]],["parent/20",[15,1.494]],["name/21",[6,33.011]],["parent/21",[15,1.494]],["name/22",[20,41.484]],["parent/22",[15,1.494]],["name/23",[21,41.484]],["parent/23",[15,1.494]],["name/24",[22,41.484]],["parent/24",[15,1.494]],["name/25",[23,41.484]],["parent/25",[15,1.494]],["name/26",[13,36.376]],["parent/26",[15,1.494]],["name/27",[14,36.376]],["parent/27",[15,1.494]],["name/28",[24,41.484]],["parent/28",[15,1.494]],["name/29",[25,41.484]],["parent/29",[15,1.494]],["name/30",[12,36.376]],["parent/30",[15,1.494]],["name/31",[26,36.376]],["parent/31",[15,1.494]],["name/32",[27,24.138]],["parent/32",[]],["name/33",[28,41.484]],["parent/33",[27,2.131]],["name/34",[29,41.484]],["parent/34",[27,2.131]],["name/35",[30,41.484]],["parent/35",[27,2.131]],["name/36",[31,41.484]],["parent/36",[27,2.131]],["name/37",[32,41.484]],["parent/37",[27,2.131]],["name/38",[33,41.484]],["parent/38",[27,2.131]],["name/39",[34,41.484]],["parent/39",[27,2.131]],["name/40",[35,20.281]],["parent/40",[]],["name/41",[36,41.484]],["parent/41",[35,1.791]],["name/42",[37,41.484]],["parent/42",[35,1.791]],["name/43",[38,41.484]],["parent/43",[35,1.791]],["name/44",[39,41.484]],["parent/44",[35,1.791]],["name/45",[26,36.376]],["parent/45",[35,1.791]],["name/46",[40,25.39]],["parent/46",[41,3.663]],["name/47",[42,41.484]],["parent/47",[35,1.791]],["name/48",[40,25.39]],["parent/48",[43,3.663]],["name/49",[44,41.484]],["parent/49",[35,1.791]],["name/50",[40,25.39]],["parent/50",[45,3.663]],["name/51",[46,41.484]],["parent/51",[35,1.791]],["name/52",[40,25.39]],["parent/52",[47,3.663]],["name/53",[6,33.011]],["parent/53",[35,1.791]],["name/54",[40,25.39]],["parent/54",[48,3.663]],["name/55",[7,36.376]],["parent/55",[35,1.791]],["name/56",[40,25.39]],["parent/56",[49,3.663]],["name/57",[50,41.484]],["parent/57",[35,1.791]],["name/58",[40,25.39]],["parent/58",[51,3.663]],["name/59",[52,26.821]],["parent/59",[]],["name/60",[53,41.484]],["parent/60",[52,2.368]],["name/61",[54,41.484]],["parent/61",[52,2.368]],["name/62",[55,41.484]],["parent/62",[52,2.368]],["name/63",[56,41.484]],["parent/63",[52,2.368]],["name/64",[57,41.484]],["parent/64",[52,2.368]],["name/65",[58,18.797]],["parent/65",[]],["name/66",[59,41.484]],["parent/66",[58,1.66]],["name/67",[60,41.484]],["parent/67",[58,1.66]],["name/68",[61,41.484]],["parent/68",[58,1.66]],["name/69",[62,41.484]],["parent/69",[58,1.66]],["name/70",[63,41.484]],["parent/70",[58,1.66]],["name/71",[64,41.484]],["parent/71",[58,1.66]],["name/72",[65,41.484]],["parent/72",[58,1.66]],["name/73",[66,41.484]],["parent/73",[58,1.66]],["name/74",[67,41.484]],["parent/74",[58,1.66]],["name/75",[68,41.484]],["parent/75",[58,1.66]],["name/76",[69,41.484]],["parent/76",[58,1.66]],["name/77",[70,41.484]],["parent/77",[58,1.66]],["name/78",[11,36.376]],["parent/78",[58,1.66]],["name/79",[71,41.484]],["parent/79",[]],["name/80",[72,41.484]],["parent/80",[]],["name/81",[73,41.484]],["parent/81",[]],["name/82",[74,41.484]],["parent/82",[]],["name/83",[75,41.484]],["parent/83",[]],["name/84",[76,41.484]],["parent/84",[]],["name/85",[77,41.484]],["parent/85",[]],["name/86",[78,41.484]],["parent/86",[]],["name/87",[79,41.484]],["parent/87",[]],["name/88",[80,41.484]],["parent/88",[]],["name/89",[81,41.484]],["parent/89",[]],["name/90",[82,41.484]],["parent/90",[]],["name/91",[83,41.484]],["parent/91",[]],["name/92",[84,41.484]],["parent/92",[]],["name/93",[85,41.484]],["parent/93",[]]],"invertedIndex":[["__type",{"_index":40,"name":{"46":{},"48":{},"50":{},"52":{},"54":{},"56":{},"58":{}},"parent":{}}],["any",{"_index":69,"name":{"76":{}},"parent":{}}],["app",{"_index":72,"name":{"80":{}},"parent":{}}],["appoptions",{"_index":52,"name":{"59":{}},"parent":{"60":{},"61":{},"62":{},"63":{},"64":{}}}],["cert_file_name",{"_index":54,"name":{"61":{}},"parent":{}}],["close",{"_index":6,"name":{"6":{},"21":{},"53":{}},"parent":{}}],["compression",{"_index":38,"name":{"43":{}},"parent":{}}],["compressoptions",{"_index":75,"name":{"83":{}},"parent":{}}],["connect",{"_index":67,"name":{"74":{}},"parent":{}}],["cork",{"_index":12,"name":{"12":{},"30":{}},"parent":{}}],["dedicated_compressor_128kb",{"_index":84,"name":{"92":{}},"parent":{}}],["dedicated_compressor_16kb",{"_index":81,"name":{"89":{}},"parent":{}}],["dedicated_compressor_256kb",{"_index":85,"name":{"93":{}},"parent":{}}],["dedicated_compressor_32kb",{"_index":82,"name":{"90":{}},"parent":{}}],["dedicated_compressor_3kb",{"_index":78,"name":{"86":{}},"parent":{}}],["dedicated_compressor_4kb",{"_index":79,"name":{"87":{}},"parent":{}}],["dedicated_compressor_64kb",{"_index":83,"name":{"91":{}},"parent":{}}],["dedicated_compressor_8kb",{"_index":80,"name":{"88":{}},"parent":{}}],["del",{"_index":63,"name":{"70":{}},"parent":{}}],["dh_params_file_name",{"_index":56,"name":{"63":{}},"parent":{}}],["disabled",{"_index":76,"name":{"84":{}},"parent":{}}],["drain",{"_index":46,"name":{"51":{}},"parent":{}}],["end",{"_index":5,"name":{"5":{},"19":{}},"parent":{}}],["foreach",{"_index":33,"name":{"38":{}},"parent":{}}],["get",{"_index":60,"name":{"67":{}},"parent":{}}],["getbufferedamount",{"_index":4,"name":{"4":{}},"parent":{}}],["getheader",{"_index":28,"name":{"33":{}},"parent":{}}],["getmethod",{"_index":31,"name":{"36":{}},"parent":{}}],["getparameter",{"_index":29,"name":{"34":{}},"parent":{}}],["getproxiedremoteaddress",{"_index":24,"name":{"28":{}},"parent":{}}],["getproxiedremoteaddressastext",{"_index":25,"name":{"29":{}},"parent":{}}],["getquery",{"_index":32,"name":{"37":{}},"parent":{}}],["getremoteaddress",{"_index":13,"name":{"13":{},"26":{}},"parent":{}}],["getremoteaddressastext",{"_index":14,"name":{"14":{},"27":{}},"parent":{}}],["geturl",{"_index":30,"name":{"35":{}},"parent":{}}],["getwriteoffset",{"_index":20,"name":{"22":{}},"parent":{}}],["head",{"_index":66,"name":{"73":{}},"parent":{}}],["httprequest",{"_index":27,"name":{"32":{}},"parent":{"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{}}}],["httpresponse",{"_index":15,"name":{"15":{}},"parent":{"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{}}}],["idletimeout",{"_index":37,"name":{"42":{}},"parent":{}}],["key_file_name",{"_index":53,"name":{"60":{}},"parent":{}}],["listen",{"_index":59,"name":{"66":{}},"parent":{}}],["maxbackpressure",{"_index":39,"name":{"44":{}},"parent":{}}],["maxpayloadlength",{"_index":36,"name":{"41":{}},"parent":{}}],["message",{"_index":44,"name":{"49":{}},"parent":{}}],["onaborted",{"_index":22,"name":{"24":{}},"parent":{}}],["ondata",{"_index":23,"name":{"25":{}},"parent":{}}],["onwritable",{"_index":21,"name":{"23":{}},"parent":{}}],["open",{"_index":42,"name":{"47":{}},"parent":{}}],["options",{"_index":62,"name":{"69":{}},"parent":{}}],["passphrase",{"_index":55,"name":{"62":{}},"parent":{}}],["patch",{"_index":64,"name":{"71":{}},"parent":{}}],["ping",{"_index":7,"name":{"7":{},"55":{}},"parent":{}}],["pong",{"_index":50,"name":{"57":{}},"parent":{}}],["post",{"_index":61,"name":{"68":{}},"parent":{}}],["publish",{"_index":11,"name":{"11":{},"78":{}},"parent":{}}],["put",{"_index":65,"name":{"72":{}},"parent":{}}],["recognizedstring",{"_index":71,"name":{"79":{}},"parent":{}}],["send",{"_index":3,"name":{"3":{}},"parent":{}}],["setyield",{"_index":34,"name":{"39":{}},"parent":{}}],["shared_compressor",{"_index":77,"name":{"85":{}},"parent":{}}],["ssl_prefer_low_memory_usage",{"_index":57,"name":{"64":{}},"parent":{}}],["sslapp",{"_index":73,"name":{"81":{}},"parent":{}}],["subscribe",{"_index":8,"name":{"8":{}},"parent":{}}],["templatedapp",{"_index":58,"name":{"65":{}},"parent":{"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{}}}],["trace",{"_index":68,"name":{"75":{}},"parent":{}}],["tryend",{"_index":19,"name":{"20":{}},"parent":{}}],["unsubscribe",{"_index":9,"name":{"9":{}},"parent":{}}],["unsubscribeall",{"_index":10,"name":{"10":{}},"parent":{}}],["upgrade",{"_index":26,"name":{"31":{},"45":{}},"parent":{}}],["us_listen_socket",{"_index":0,"name":{"0":{}},"parent":{}}],["us_listen_socket_close",{"_index":74,"name":{"82":{}},"parent":{}}],["us_socket_context_t",{"_index":1,"name":{"1":{}},"parent":{}}],["websocket",{"_index":2,"name":{"2":{}},"parent":{"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{}}}],["websocketbehavior",{"_index":35,"name":{"40":{}},"parent":{"41":{},"42":{},"43":{},"44":{},"45":{},"47":{},"49":{},"51":{},"53":{},"55":{},"57":{}}}],["websocketbehavior.close",{"_index":48,"name":{},"parent":{"54":{}}}],["websocketbehavior.drain",{"_index":47,"name":{},"parent":{"52":{}}}],["websocketbehavior.message",{"_index":45,"name":{},"parent":{"50":{}}}],["websocketbehavior.open",{"_index":43,"name":{},"parent":{"48":{}}}],["websocketbehavior.ping",{"_index":49,"name":{},"parent":{"56":{}}}],["websocketbehavior.pong",{"_index":51,"name":{},"parent":{"58":{}}}],["websocketbehavior.upgrade",{"_index":41,"name":{},"parent":{"46":{}}}],["write",{"_index":18,"name":{"18":{}},"parent":{}}],["writeheader",{"_index":17,"name":{"17":{}},"parent":{}}],["writestatus",{"_index":16,"name":{"16":{}},"parent":{}}],["ws",{"_index":70,"name":{"77":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file +{"kinds":{"4":"Enumeration","16":"Enumeration member","32":"Variable","64":"Function","256":"Interface","1024":"Property","2048":"Method","65536":"Type literal","4194304":"Type alias"},"rows":[{"id":0,"kind":256,"name":"us_listen_socket","url":"interfaces/us_listen_socket.html","classes":"tsd-kind-interface"},{"id":1,"kind":256,"name":"us_socket_context_t","url":"interfaces/us_socket_context_t.html","classes":"tsd-kind-interface"},{"id":2,"kind":256,"name":"WebSocket","url":"interfaces/websocket.html","classes":"tsd-kind-interface"},{"id":3,"kind":2048,"name":"send","url":"interfaces/websocket.html#send","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":4,"kind":2048,"name":"getBufferedAmount","url":"interfaces/websocket.html#getbufferedamount","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":5,"kind":2048,"name":"end","url":"interfaces/websocket.html#end","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":6,"kind":2048,"name":"close","url":"interfaces/websocket.html#close","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":7,"kind":2048,"name":"ping","url":"interfaces/websocket.html#ping","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":8,"kind":2048,"name":"subscribe","url":"interfaces/websocket.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":9,"kind":2048,"name":"unsubscribe","url":"interfaces/websocket.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":10,"kind":2048,"name":"isSubscribed","url":"interfaces/websocket.html#issubscribed","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":11,"kind":2048,"name":"getTopics","url":"interfaces/websocket.html#gettopics","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":12,"kind":2048,"name":"publish","url":"interfaces/websocket.html#publish","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":13,"kind":2048,"name":"cork","url":"interfaces/websocket.html#cork","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":14,"kind":2048,"name":"getRemoteAddress","url":"interfaces/websocket.html#getremoteaddress","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":15,"kind":2048,"name":"getRemoteAddressAsText","url":"interfaces/websocket.html#getremoteaddressastext","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocket"},{"id":16,"kind":256,"name":"HttpResponse","url":"interfaces/httpresponse.html","classes":"tsd-kind-interface"},{"id":17,"kind":2048,"name":"writeStatus","url":"interfaces/httpresponse.html#writestatus","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":18,"kind":2048,"name":"writeHeader","url":"interfaces/httpresponse.html#writeheader","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":19,"kind":2048,"name":"write","url":"interfaces/httpresponse.html#write","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":20,"kind":2048,"name":"end","url":"interfaces/httpresponse.html#end","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":21,"kind":2048,"name":"tryEnd","url":"interfaces/httpresponse.html#tryend","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":22,"kind":2048,"name":"close","url":"interfaces/httpresponse.html#close","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":23,"kind":2048,"name":"getWriteOffset","url":"interfaces/httpresponse.html#getwriteoffset","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":24,"kind":2048,"name":"onWritable","url":"interfaces/httpresponse.html#onwritable","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":25,"kind":2048,"name":"onAborted","url":"interfaces/httpresponse.html#onaborted","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":26,"kind":2048,"name":"onData","url":"interfaces/httpresponse.html#ondata","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":27,"kind":2048,"name":"getRemoteAddress","url":"interfaces/httpresponse.html#getremoteaddress","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":28,"kind":2048,"name":"getRemoteAddressAsText","url":"interfaces/httpresponse.html#getremoteaddressastext","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":29,"kind":2048,"name":"getProxiedRemoteAddress","url":"interfaces/httpresponse.html#getproxiedremoteaddress","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":30,"kind":2048,"name":"getProxiedRemoteAddressAsText","url":"interfaces/httpresponse.html#getproxiedremoteaddressastext","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":31,"kind":2048,"name":"cork","url":"interfaces/httpresponse.html#cork","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpResponse"},{"id":32,"kind":2048,"name":"upgrade","url":"interfaces/httpresponse.html#upgrade","classes":"tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter","parent":"HttpResponse"},{"id":33,"kind":256,"name":"HttpRequest","url":"interfaces/httprequest.html","classes":"tsd-kind-interface"},{"id":34,"kind":2048,"name":"getHeader","url":"interfaces/httprequest.html#getheader","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":35,"kind":2048,"name":"getParameter","url":"interfaces/httprequest.html#getparameter","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":36,"kind":2048,"name":"getUrl","url":"interfaces/httprequest.html#geturl","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":37,"kind":2048,"name":"getMethod","url":"interfaces/httprequest.html#getmethod","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":38,"kind":2048,"name":"getQuery","url":"interfaces/httprequest.html#getquery","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":39,"kind":2048,"name":"forEach","url":"interfaces/httprequest.html#foreach","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":40,"kind":2048,"name":"setYield","url":"interfaces/httprequest.html#setyield","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HttpRequest"},{"id":41,"kind":256,"name":"WebSocketBehavior","url":"interfaces/websocketbehavior.html","classes":"tsd-kind-interface"},{"id":42,"kind":1024,"name":"maxPayloadLength","url":"interfaces/websocketbehavior.html#maxpayloadlength","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":43,"kind":1024,"name":"idleTimeout","url":"interfaces/websocketbehavior.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":44,"kind":1024,"name":"compression","url":"interfaces/websocketbehavior.html#compression","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":45,"kind":1024,"name":"maxBackpressure","url":"interfaces/websocketbehavior.html#maxbackpressure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":46,"kind":1024,"name":"upgrade","url":"interfaces/websocketbehavior.html#upgrade","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":47,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#upgrade.__type-6","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.upgrade"},{"id":48,"kind":1024,"name":"open","url":"interfaces/websocketbehavior.html#open","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":49,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#open.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.open"},{"id":50,"kind":1024,"name":"message","url":"interfaces/websocketbehavior.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":51,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#message.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.message"},{"id":52,"kind":1024,"name":"drain","url":"interfaces/websocketbehavior.html#drain","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":53,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#drain.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.drain"},{"id":54,"kind":1024,"name":"close","url":"interfaces/websocketbehavior.html#close","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":55,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#close.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.close"},{"id":56,"kind":1024,"name":"ping","url":"interfaces/websocketbehavior.html#ping","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":57,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#ping.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.ping"},{"id":58,"kind":1024,"name":"pong","url":"interfaces/websocketbehavior.html#pong","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WebSocketBehavior"},{"id":59,"kind":65536,"name":"__type","url":"interfaces/websocketbehavior.html#pong.__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"WebSocketBehavior.pong"},{"id":60,"kind":256,"name":"AppOptions","url":"interfaces/appoptions.html","classes":"tsd-kind-interface"},{"id":61,"kind":1024,"name":"key_file_name","url":"interfaces/appoptions.html#key_file_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AppOptions"},{"id":62,"kind":1024,"name":"cert_file_name","url":"interfaces/appoptions.html#cert_file_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AppOptions"},{"id":63,"kind":1024,"name":"passphrase","url":"interfaces/appoptions.html#passphrase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AppOptions"},{"id":64,"kind":1024,"name":"dh_params_file_name","url":"interfaces/appoptions.html#dh_params_file_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AppOptions"},{"id":65,"kind":1024,"name":"ssl_prefer_low_memory_usage","url":"interfaces/appoptions.html#ssl_prefer_low_memory_usage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AppOptions"},{"id":66,"kind":4,"name":"ListenOptions","url":"enums/listenoptions.html","classes":"tsd-kind-enum"},{"id":67,"kind":16,"name":"LIBUS_LISTEN_DEFAULT","url":"enums/listenoptions.html#libus_listen_default","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ListenOptions"},{"id":68,"kind":16,"name":"LIBUS_LISTEN_EXCLUSIVE_PORT","url":"enums/listenoptions.html#libus_listen_exclusive_port","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ListenOptions"},{"id":69,"kind":256,"name":"TemplatedApp","url":"interfaces/templatedapp.html","classes":"tsd-kind-interface"},{"id":70,"kind":2048,"name":"listen","url":"interfaces/templatedapp.html#listen","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":71,"kind":2048,"name":"get","url":"interfaces/templatedapp.html#get","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":72,"kind":2048,"name":"post","url":"interfaces/templatedapp.html#post","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":73,"kind":2048,"name":"options","url":"interfaces/templatedapp.html#options","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":74,"kind":2048,"name":"del","url":"interfaces/templatedapp.html#del","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":75,"kind":2048,"name":"patch","url":"interfaces/templatedapp.html#patch","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":76,"kind":2048,"name":"put","url":"interfaces/templatedapp.html#put","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":77,"kind":2048,"name":"head","url":"interfaces/templatedapp.html#head","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":78,"kind":2048,"name":"connect","url":"interfaces/templatedapp.html#connect","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":79,"kind":2048,"name":"trace","url":"interfaces/templatedapp.html#trace","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":80,"kind":2048,"name":"any","url":"interfaces/templatedapp.html#any","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":81,"kind":2048,"name":"ws","url":"interfaces/templatedapp.html#ws","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":82,"kind":2048,"name":"publish","url":"interfaces/templatedapp.html#publish","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":83,"kind":2048,"name":"numSubscribers","url":"interfaces/templatedapp.html#numsubscribers","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"TemplatedApp"},{"id":84,"kind":256,"name":"MultipartField","url":"interfaces/multipartfield.html","classes":"tsd-kind-interface"},{"id":85,"kind":1024,"name":"data","url":"interfaces/multipartfield.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"MultipartField"},{"id":86,"kind":1024,"name":"name","url":"interfaces/multipartfield.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"MultipartField"},{"id":87,"kind":1024,"name":"type","url":"interfaces/multipartfield.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"MultipartField"},{"id":88,"kind":1024,"name":"filename","url":"interfaces/multipartfield.html#filename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"MultipartField"},{"id":89,"kind":4194304,"name":"RecognizedString","url":"index.html#recognizedstring","classes":"tsd-kind-type-alias"},{"id":90,"kind":64,"name":"App","url":"index.html#app","classes":"tsd-kind-function"},{"id":91,"kind":64,"name":"SSLApp","url":"index.html#sslapp","classes":"tsd-kind-function"},{"id":92,"kind":64,"name":"us_listen_socket_close","url":"index.html#us_listen_socket_close","classes":"tsd-kind-function"},{"id":93,"kind":64,"name":"getParts","url":"index.html#getparts","classes":"tsd-kind-function"},{"id":94,"kind":4194304,"name":"CompressOptions","url":"index.html#compressoptions","classes":"tsd-kind-type-alias"},{"id":95,"kind":32,"name":"DISABLED","url":"index.html#disabled","classes":"tsd-kind-variable"},{"id":96,"kind":32,"name":"SHARED_COMPRESSOR","url":"index.html#shared_compressor","classes":"tsd-kind-variable"},{"id":97,"kind":32,"name":"DEDICATED_COMPRESSOR_3KB","url":"index.html#dedicated_compressor_3kb","classes":"tsd-kind-variable"},{"id":98,"kind":32,"name":"DEDICATED_COMPRESSOR_4KB","url":"index.html#dedicated_compressor_4kb","classes":"tsd-kind-variable"},{"id":99,"kind":32,"name":"DEDICATED_COMPRESSOR_8KB","url":"index.html#dedicated_compressor_8kb","classes":"tsd-kind-variable"},{"id":100,"kind":32,"name":"DEDICATED_COMPRESSOR_16KB","url":"index.html#dedicated_compressor_16kb","classes":"tsd-kind-variable"},{"id":101,"kind":32,"name":"DEDICATED_COMPRESSOR_32KB","url":"index.html#dedicated_compressor_32kb","classes":"tsd-kind-variable"},{"id":102,"kind":32,"name":"DEDICATED_COMPRESSOR_64KB","url":"index.html#dedicated_compressor_64kb","classes":"tsd-kind-variable"},{"id":103,"kind":32,"name":"DEDICATED_COMPRESSOR_128KB","url":"index.html#dedicated_compressor_128kb","classes":"tsd-kind-variable"},{"id":104,"kind":32,"name":"DEDICATED_COMPRESSOR_256KB","url":"index.html#dedicated_compressor_256kb","classes":"tsd-kind-variable"}],"index":{"version":"2.3.8","fields":["name","parent"],"fieldVectors":[["name/0",[0,42.58]],["parent/0",[]],["name/1",[1,42.58]],["parent/1",[]],["name/2",[2,19.893]],["parent/2",[]],["name/3",[3,42.58]],["parent/3",[2,1.753]],["name/4",[4,42.58]],["parent/4",[2,1.753]],["name/5",[5,37.471]],["parent/5",[2,1.753]],["name/6",[6,34.107]],["parent/6",[2,1.753]],["name/7",[7,37.471]],["parent/7",[2,1.753]],["name/8",[8,42.58]],["parent/8",[2,1.753]],["name/9",[9,42.58]],["parent/9",[2,1.753]],["name/10",[10,42.58]],["parent/10",[2,1.753]],["name/11",[11,42.58]],["parent/11",[2,1.753]],["name/12",[12,37.471]],["parent/12",[2,1.753]],["name/13",[13,37.471]],["parent/13",[2,1.753]],["name/14",[14,37.471]],["parent/14",[2,1.753]],["name/15",[15,37.471]],["parent/15",[2,1.753]],["name/16",[16,18.012]],["parent/16",[]],["name/17",[17,42.58]],["parent/17",[16,1.588]],["name/18",[18,42.58]],["parent/18",[16,1.588]],["name/19",[19,42.58]],["parent/19",[16,1.588]],["name/20",[5,37.471]],["parent/20",[16,1.588]],["name/21",[20,42.58]],["parent/21",[16,1.588]],["name/22",[6,34.107]],["parent/22",[16,1.588]],["name/23",[21,42.58]],["parent/23",[16,1.588]],["name/24",[22,42.58]],["parent/24",[16,1.588]],["name/25",[23,42.58]],["parent/25",[16,1.588]],["name/26",[24,42.58]],["parent/26",[16,1.588]],["name/27",[14,37.471]],["parent/27",[16,1.588]],["name/28",[15,37.471]],["parent/28",[16,1.588]],["name/29",[25,42.58]],["parent/29",[16,1.588]],["name/30",[26,42.58]],["parent/30",[16,1.588]],["name/31",[13,37.471]],["parent/31",[16,1.588]],["name/32",[27,37.471]],["parent/32",[16,1.588]],["name/33",[28,25.234]],["parent/33",[]],["name/34",[29,42.58]],["parent/34",[28,2.224]],["name/35",[30,42.58]],["parent/35",[28,2.224]],["name/36",[31,42.58]],["parent/36",[28,2.224]],["name/37",[32,42.58]],["parent/37",[28,2.224]],["name/38",[33,42.58]],["parent/38",[28,2.224]],["name/39",[34,42.58]],["parent/39",[28,2.224]],["name/40",[35,42.58]],["parent/40",[28,2.224]],["name/41",[36,21.377]],["parent/41",[]],["name/42",[37,42.58]],["parent/42",[36,1.884]],["name/43",[38,42.58]],["parent/43",[36,1.884]],["name/44",[39,42.58]],["parent/44",[36,1.884]],["name/45",[40,42.58]],["parent/45",[36,1.884]],["name/46",[27,37.471]],["parent/46",[36,1.884]],["name/47",[41,26.485]],["parent/47",[42,3.753]],["name/48",[43,42.58]],["parent/48",[36,1.884]],["name/49",[41,26.485]],["parent/49",[44,3.753]],["name/50",[45,42.58]],["parent/50",[36,1.884]],["name/51",[41,26.485]],["parent/51",[46,3.753]],["name/52",[47,42.58]],["parent/52",[36,1.884]],["name/53",[41,26.485]],["parent/53",[48,3.753]],["name/54",[6,34.107]],["parent/54",[36,1.884]],["name/55",[41,26.485]],["parent/55",[49,3.753]],["name/56",[7,37.471]],["parent/56",[36,1.884]],["name/57",[41,26.485]],["parent/57",[50,3.753]],["name/58",[51,42.58]],["parent/58",[36,1.884]],["name/59",[41,26.485]],["parent/59",[52,3.753]],["name/60",[53,27.916]],["parent/60",[]],["name/61",[54,42.58]],["parent/61",[53,2.46]],["name/62",[55,42.58]],["parent/62",[53,2.46]],["name/63",[56,42.58]],["parent/63",[53,2.46]],["name/64",[57,42.58]],["parent/64",[53,2.46]],["name/65",[58,42.58]],["parent/65",[53,2.46]],["name/66",[59,34.107]],["parent/66",[]],["name/67",[60,42.58]],["parent/67",[59,3.006]],["name/68",[61,42.58]],["parent/68",[59,3.006]],["name/69",[62,19.226]],["parent/69",[]],["name/70",[63,42.58]],["parent/70",[62,1.694]],["name/71",[64,42.58]],["parent/71",[62,1.694]],["name/72",[65,42.58]],["parent/72",[62,1.694]],["name/73",[66,42.58]],["parent/73",[62,1.694]],["name/74",[67,42.58]],["parent/74",[62,1.694]],["name/75",[68,42.58]],["parent/75",[62,1.694]],["name/76",[69,42.58]],["parent/76",[62,1.694]],["name/77",[70,42.58]],["parent/77",[62,1.694]],["name/78",[71,42.58]],["parent/78",[62,1.694]],["name/79",[72,42.58]],["parent/79",[62,1.694]],["name/80",[73,42.58]],["parent/80",[62,1.694]],["name/81",[74,42.58]],["parent/81",[62,1.694]],["name/82",[12,37.471]],["parent/82",[62,1.694]],["name/83",[75,42.58]],["parent/83",[62,1.694]],["name/84",[76,29.587]],["parent/84",[]],["name/85",[77,42.58]],["parent/85",[76,2.608]],["name/86",[78,42.58]],["parent/86",[76,2.608]],["name/87",[79,42.58]],["parent/87",[76,2.608]],["name/88",[80,42.58]],["parent/88",[76,2.608]],["name/89",[81,42.58]],["parent/89",[]],["name/90",[82,42.58]],["parent/90",[]],["name/91",[83,42.58]],["parent/91",[]],["name/92",[84,42.58]],["parent/92",[]],["name/93",[85,42.58]],["parent/93",[]],["name/94",[86,42.58]],["parent/94",[]],["name/95",[87,42.58]],["parent/95",[]],["name/96",[88,42.58]],["parent/96",[]],["name/97",[89,42.58]],["parent/97",[]],["name/98",[90,42.58]],["parent/98",[]],["name/99",[91,42.58]],["parent/99",[]],["name/100",[92,42.58]],["parent/100",[]],["name/101",[93,42.58]],["parent/101",[]],["name/102",[94,42.58]],["parent/102",[]],["name/103",[95,42.58]],["parent/103",[]],["name/104",[96,42.58]],["parent/104",[]]],"invertedIndex":[["__type",{"_index":41,"name":{"47":{},"49":{},"51":{},"53":{},"55":{},"57":{},"59":{}},"parent":{}}],["any",{"_index":73,"name":{"80":{}},"parent":{}}],["app",{"_index":82,"name":{"90":{}},"parent":{}}],["appoptions",{"_index":53,"name":{"60":{}},"parent":{"61":{},"62":{},"63":{},"64":{},"65":{}}}],["cert_file_name",{"_index":55,"name":{"62":{}},"parent":{}}],["close",{"_index":6,"name":{"6":{},"22":{},"54":{}},"parent":{}}],["compression",{"_index":39,"name":{"44":{}},"parent":{}}],["compressoptions",{"_index":86,"name":{"94":{}},"parent":{}}],["connect",{"_index":71,"name":{"78":{}},"parent":{}}],["cork",{"_index":13,"name":{"13":{},"31":{}},"parent":{}}],["data",{"_index":77,"name":{"85":{}},"parent":{}}],["dedicated_compressor_128kb",{"_index":95,"name":{"103":{}},"parent":{}}],["dedicated_compressor_16kb",{"_index":92,"name":{"100":{}},"parent":{}}],["dedicated_compressor_256kb",{"_index":96,"name":{"104":{}},"parent":{}}],["dedicated_compressor_32kb",{"_index":93,"name":{"101":{}},"parent":{}}],["dedicated_compressor_3kb",{"_index":89,"name":{"97":{}},"parent":{}}],["dedicated_compressor_4kb",{"_index":90,"name":{"98":{}},"parent":{}}],["dedicated_compressor_64kb",{"_index":94,"name":{"102":{}},"parent":{}}],["dedicated_compressor_8kb",{"_index":91,"name":{"99":{}},"parent":{}}],["del",{"_index":67,"name":{"74":{}},"parent":{}}],["dh_params_file_name",{"_index":57,"name":{"64":{}},"parent":{}}],["disabled",{"_index":87,"name":{"95":{}},"parent":{}}],["drain",{"_index":47,"name":{"52":{}},"parent":{}}],["end",{"_index":5,"name":{"5":{},"20":{}},"parent":{}}],["filename",{"_index":80,"name":{"88":{}},"parent":{}}],["foreach",{"_index":34,"name":{"39":{}},"parent":{}}],["get",{"_index":64,"name":{"71":{}},"parent":{}}],["getbufferedamount",{"_index":4,"name":{"4":{}},"parent":{}}],["getheader",{"_index":29,"name":{"34":{}},"parent":{}}],["getmethod",{"_index":32,"name":{"37":{}},"parent":{}}],["getparameter",{"_index":30,"name":{"35":{}},"parent":{}}],["getparts",{"_index":85,"name":{"93":{}},"parent":{}}],["getproxiedremoteaddress",{"_index":25,"name":{"29":{}},"parent":{}}],["getproxiedremoteaddressastext",{"_index":26,"name":{"30":{}},"parent":{}}],["getquery",{"_index":33,"name":{"38":{}},"parent":{}}],["getremoteaddress",{"_index":14,"name":{"14":{},"27":{}},"parent":{}}],["getremoteaddressastext",{"_index":15,"name":{"15":{},"28":{}},"parent":{}}],["gettopics",{"_index":11,"name":{"11":{}},"parent":{}}],["geturl",{"_index":31,"name":{"36":{}},"parent":{}}],["getwriteoffset",{"_index":21,"name":{"23":{}},"parent":{}}],["head",{"_index":70,"name":{"77":{}},"parent":{}}],["httprequest",{"_index":28,"name":{"33":{}},"parent":{"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{}}}],["httpresponse",{"_index":16,"name":{"16":{}},"parent":{"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{}}}],["idletimeout",{"_index":38,"name":{"43":{}},"parent":{}}],["issubscribed",{"_index":10,"name":{"10":{}},"parent":{}}],["key_file_name",{"_index":54,"name":{"61":{}},"parent":{}}],["libus_listen_default",{"_index":60,"name":{"67":{}},"parent":{}}],["libus_listen_exclusive_port",{"_index":61,"name":{"68":{}},"parent":{}}],["listen",{"_index":63,"name":{"70":{}},"parent":{}}],["listenoptions",{"_index":59,"name":{"66":{}},"parent":{"67":{},"68":{}}}],["maxbackpressure",{"_index":40,"name":{"45":{}},"parent":{}}],["maxpayloadlength",{"_index":37,"name":{"42":{}},"parent":{}}],["message",{"_index":45,"name":{"50":{}},"parent":{}}],["multipartfield",{"_index":76,"name":{"84":{}},"parent":{"85":{},"86":{},"87":{},"88":{}}}],["name",{"_index":78,"name":{"86":{}},"parent":{}}],["numsubscribers",{"_index":75,"name":{"83":{}},"parent":{}}],["onaborted",{"_index":23,"name":{"25":{}},"parent":{}}],["ondata",{"_index":24,"name":{"26":{}},"parent":{}}],["onwritable",{"_index":22,"name":{"24":{}},"parent":{}}],["open",{"_index":43,"name":{"48":{}},"parent":{}}],["options",{"_index":66,"name":{"73":{}},"parent":{}}],["passphrase",{"_index":56,"name":{"63":{}},"parent":{}}],["patch",{"_index":68,"name":{"75":{}},"parent":{}}],["ping",{"_index":7,"name":{"7":{},"56":{}},"parent":{}}],["pong",{"_index":51,"name":{"58":{}},"parent":{}}],["post",{"_index":65,"name":{"72":{}},"parent":{}}],["publish",{"_index":12,"name":{"12":{},"82":{}},"parent":{}}],["put",{"_index":69,"name":{"76":{}},"parent":{}}],["recognizedstring",{"_index":81,"name":{"89":{}},"parent":{}}],["send",{"_index":3,"name":{"3":{}},"parent":{}}],["setyield",{"_index":35,"name":{"40":{}},"parent":{}}],["shared_compressor",{"_index":88,"name":{"96":{}},"parent":{}}],["ssl_prefer_low_memory_usage",{"_index":58,"name":{"65":{}},"parent":{}}],["sslapp",{"_index":83,"name":{"91":{}},"parent":{}}],["subscribe",{"_index":8,"name":{"8":{}},"parent":{}}],["templatedapp",{"_index":62,"name":{"69":{}},"parent":{"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{}}}],["trace",{"_index":72,"name":{"79":{}},"parent":{}}],["tryend",{"_index":20,"name":{"21":{}},"parent":{}}],["type",{"_index":79,"name":{"87":{}},"parent":{}}],["unsubscribe",{"_index":9,"name":{"9":{}},"parent":{}}],["upgrade",{"_index":27,"name":{"32":{},"46":{}},"parent":{}}],["us_listen_socket",{"_index":0,"name":{"0":{}},"parent":{}}],["us_listen_socket_close",{"_index":84,"name":{"92":{}},"parent":{}}],["us_socket_context_t",{"_index":1,"name":{"1":{}},"parent":{}}],["websocket",{"_index":2,"name":{"2":{}},"parent":{"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{}}}],["websocketbehavior",{"_index":36,"name":{"41":{}},"parent":{"42":{},"43":{},"44":{},"45":{},"46":{},"48":{},"50":{},"52":{},"54":{},"56":{},"58":{}}}],["websocketbehavior.close",{"_index":49,"name":{},"parent":{"55":{}}}],["websocketbehavior.drain",{"_index":48,"name":{},"parent":{"53":{}}}],["websocketbehavior.message",{"_index":46,"name":{},"parent":{"51":{}}}],["websocketbehavior.open",{"_index":44,"name":{},"parent":{"49":{}}}],["websocketbehavior.ping",{"_index":50,"name":{},"parent":{"57":{}}}],["websocketbehavior.pong",{"_index":52,"name":{},"parent":{"59":{}}}],["websocketbehavior.upgrade",{"_index":42,"name":{},"parent":{"47":{}}}],["write",{"_index":19,"name":{"19":{}},"parent":{}}],["writeheader",{"_index":18,"name":{"18":{}},"parent":{}}],["writestatus",{"_index":17,"name":{"17":{}},"parent":{}}],["ws",{"_index":74,"name":{"81":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/docs/generated/enums/listenoptions.html b/docs/generated/enums/listenoptions.html new file mode 100644 index 0000000..d3e48ca --- /dev/null +++ b/docs/generated/enums/listenoptions.html @@ -0,0 +1,228 @@ + + +
+ + +Generated using TypeDoc
+
getParts
++- get
Parts(body: RecognizedString, contentType: RecognizedString): MultipartField[] | undefined
+
++-
+
+
+
+
+
+
+
+Takes a POSTed body and contentType, and returns an array of parts if the request is a multipart request
+Parameters
++-
+
+ -
+
+
+body: RecognizedString
+contentType: RecognizedString
+Returns MultipartField[] | undefined
+us_listen_socket_close
@@ -371,7 +410,7 @@getQuery
Returns the part of URL after ? sign or empty string.
+Returns the raw querystring (the part of URL after ? sign) or empty string.
Returns string
Returns a decoded query parameter value or empty string.
+Parameters
++-
+
+
+key: string
+Returns string
+Returns TemplatedApp
+Listens to port and sets Listen Options. Callback hands either false or a listen socket.
+Parameters
++-
+
+ -
+
+ -
+
+
+port: number
+options: ListenOptions
+cb: (listenSocket: us_listen_socket | false) => void
++-
+
+
++- (listenSocket: us_listen_socket | false): void
+
++-
+
+
+Parameters
++-
+
+
+listenSocket: us_listen_socket | false
+Returns void
+Returns TemplatedApp
+numSubscribers
++- num
Subscribers(topic: RecognizedString): number
+
++-
+
+
+
+
+
+
Returns number of subscribers for this topic.
+Parameters
++-
+
+
+topic: RecognizedString
+Returns number
+publish
-- publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean): TemplatedApp
+ - publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean): boolean
Optional compress: boolean
-Returns TemplatedApp
+Returns boolean
@@ -662,7 +735,7 @@+-
+ Listen
Options
+
-
App
Options
@@ -808,6 +884,9 @@
-
Http
Response
+ -
+ Multipart
Field
+
+-
+ Listen
Options
+
-
App
Options
@@ -100,6 +103,9 @@
-
Http
Response
+ -
+ Multipart
Field
+
-
Templated
App
@@ -161,6 +167,9 @@
-
SSLApp
+ -
+ get
Parts
+
-
us_
listen_socket_close
diff --git a/docs/generated/interfaces/us_socket_context_t.html b/docs/generated/interfaces/us_socket_context_t.html
index 63c0774..b9037fc 100644
--- a/docs/generated/interfaces/us_socket_context_t.html
+++ b/docs/generated/interfaces/us_socket_context_t.html
@@ -3,8 +3,8 @@
- us_socket_context_t | uWebSockets.js v18.1.0 documentation
-
+ us_socket_context_t | uWebSockets.js v19.0.0 documentation
+
@@ -22,7 +22,7 @@
- Preparing search index...
- The search index is not available
- uWebSockets.js v18.1.0 documentation + uWebSockets.js v19.0.0 documentation+-
+ Listen
Options
+
-
App
Options
@@ -100,6 +103,9 @@
-
Http
Response
+ -
+ Multipart
Field
+
-
Templated
App
@@ -161,6 +167,9 @@
-
SSLApp
+ -
+ get
Parts
+
-
us_
listen_socket_close
diff --git a/docs/generated/interfaces/websocket.html b/docs/generated/interfaces/websocket.html
index c5e4a5f..9ee0731 100644
--- a/docs/generated/interfaces/websocket.html
+++ b/docs/generated/interfaces/websocket.html
@@ -3,8 +3,8 @@
- WebSocket | uWebSockets.js v18.1.0 documentation
-
+ WebSocket | uWebSockets.js v19.0.0 documentation
+
@@ -22,7 +22,7 @@
- Preparing search index...
- The search index is not available
- uWebSockets.js v18.1.0 documentation + uWebSockets.js v19.0.0 documentationgetTopics
++- get
Topics(): string[]
+
++-
+
+
+
+
+
+
+
+Returns a list of topics this websocket is subscribed to.
+Returns string[]
+isSubscribed
++- is
Subscribed(topic: RecognizedString): boolean
+
++-
+
+
+
+
+
+
+
+Returns whether this websocket is subscribed to topic.
+Parameters
++-
+
+
+topic: RecognizedString
+Returns boolean
+ping
@@ -290,7 +341,7 @@publish
-- publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean): WebSocket
+ - publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean): boolean
Optional compress: boolean
-Returns WebSocket
+Returns boolean
@@ -360,7 +411,7 @@subscribe
-- subscribe(topic: RecognizedString): WebSocket
+ - subscribe(topic: RecognizedString): boolean
topic: RecognizedString
-Returns WebSocket
+Returns boolean
@@ -427,7 +478,7 @@unsubscribeAll
--- unsubscribe
All(): void
-
---
-
-
-
-
-
-
-
-Unsubscribe from all topics. This is called automatically before any close handler is called, so you never need to call this manually in the close handler of a WebSocket.
-Returns void
-+-
+ Listen
Options
+
-
App
Options
@@ -488,6 +520,9 @@
-
Http
Response
+ -
+ Multipart
Field
+
-
Templated
App
@@ -514,6 +549,12 @@
-
get
RemoteAddressAsText
+ -
+ get
Topics
+
+ -
+ is
Subscribed
+
-
ping
@@ -529,9 +570,6 @@
-
unsubscribe
- -
- unsubscribe
All
-
@@ -587,6 +625,9 @@What permessage-deflate compression to use. uWS.DISABLED, uWS.SHARED_COMPRESSOR or any of the uWS.DEDICATED_COMPRESSOR_xxxKB.
+What permessage-deflate compression to use. uWS.DISABLED, uWS.SHARED_COMPRESSOR or any of the uWS.DEDICATED_COMPRESSOR_xxxKB. Defaults to uWS.DISABLED.
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.
+ Disable by using 0. Defaults to 120.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.
+Maximum length of allowed backpressure per socket when publishing or sending messages. Slow receivers with too high backpressure will be skipped until they catch up or timeout. Defaults to 1024 * 1024.
Maximum length of received message. If a client tries to send you a message larger than this, the connection is immediately closed.
+Maximum length of received message. If a client tries to send you a message larger than this, the connection is immediately closed. Defaults to 16 * 1024.
Optional ping
--- (ws: WebSocket): void
+ - (ws: WebSocket, message: ArrayBuffer): void
ws: WebSocket
message: ArrayBuffer
+Returns void
Optional pong
--- (ws: WebSocket): void
+ - (ws: WebSocket, message: ArrayBuffer): void
ws: WebSocket
message: ArrayBuffer
+Returns void
+-
+ Listen
Options
+
-
App
Options
@@ -457,6 +466,9 @@
-
Http
Response
+ -
+ Multipart
Field
+
-
Templated
App
@@ -553,6 +565,9 @@
-
SSLApp
+ -
+ get
Parts
+
-
us_
listen_socket_close
diff --git a/docs/index.d.ts b/docs/index.d.ts
index bcca745..40797aa 100644
--- a/docs/index.d.ts
+++ b/docs/index.d.ts
@@ -67,19 +67,22 @@ export interface WebSocket {
ping(message?: RecognizedString) : boolean;
/** Subscribe to a topic in MQTT syntax.
- *
+ *
* MQTT syntax includes things like "root/child/+/grandchild" where "+" is a
* wildcard and "root/#" where "#" is a terminating wildcard.
- *
+ *
* Read more about MQTT.
*/
- subscribe(topic: RecognizedString) : WebSocket;
+ subscribe(topic: RecognizedString) : boolean;
/** Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed. */
unsubscribe(topic: RecognizedString) : boolean;
- /** Unsubscribe from all topics. This is called automatically before any close handler is called, so you never need to call this manually in the close handler of a WebSocket. */
- unsubscribeAll() : void;
+ /** Returns whether this websocket is subscribed to topic. */
+ isSubscribed(topic: RecognizedString) : boolean;
+
+ /** Returns a list of topics this websocket is subscribed to. */
+ getTopics() : string[];
/** Publish a message to a topic in MQTT syntax. You cannot publish using wildcards, only fully specified topics. Just like with MQTT.
*
@@ -88,10 +91,10 @@ export interface WebSocket {
* The pub/sub system does not guarantee order between what you manually send using WebSocket.send
* and what you publish using WebSocket.publish. WebSocket messages are perfectly atomic, but the order in which they appear can get scrambled if you mix the two sending functions on the same socket.
* This shouldn't matter in most applications. Order is guaranteed relative to other calls to WebSocket.publish.
- *
+ *
* Also keep in mind that backpressure will be automatically managed with pub/sub, meaning some outgoing messages may be dropped if backpressure is greater than specified maxBackpressure.
*/
- publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean) : WebSocket;
+ publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean) : boolean;
/** See HttpResponse.cork. Takes a function in which the socket is corked (packing many sends into one single syscall/SSL block) */
cork(cb: () => void) : void;
@@ -117,19 +120,19 @@ export interface HttpResponse {
/** Writes the HTTP status message such as "200 OK".
* This has to be called first in any response, otherwise
* it will be called automatically with "200 OK".
- *
+ *
* If you want to send custom headers in a WebSocket
* upgrade response, you have to call writeStatus with
* "101 Switching Protocols" before you call writeHeader,
* otherwise your first call to writeHeader will call
* writeStatus with "200 OK" and the upgrade will fail.
- *
+ *
* As you can imagine, we format outgoing responses in a linear
* buffer, not in a hash table. You can read about this in
* the user manual under "corking".
*/
writeStatus(status: RecognizedString) : HttpResponse;
- /** Writes key and value to HTTP response.
+ /** Writes key and value to HTTP response.
* See writeStatus and corking.
*/
writeHeader(key: RecognizedString, value: RecognizedString) : HttpResponse;
@@ -240,9 +243,9 @@ export interface WebSocketBehavior {
/** 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. */
close?: (ws: WebSocket, code: number, message: ArrayBuffer) => void;
/** Handler for received ping control message. You do not need to handle this, pong messages are automatically sent as per the standard. */
- ping?: (ws: WebSocket) => void;
+ ping?: (ws: WebSocket, message: ArrayBuffer) => void;
/** Handler for received pong control message. */
- pong?: (ws: WebSocket) => void;
+ pong?: (ws: WebSocket, message: ArrayBuffer) => void;
}
/** Options used when constructing an app. Especially for SSLApp.
@@ -293,7 +296,9 @@ export interface TemplatedApp {
/** Registers a handler matching specified URL pattern where WebSocket upgrade requests are caught. */
ws(pattern: RecognizedString, behavior: WebSocketBehavior) : TemplatedApp;
/** Publishes a message under topic, for all WebSockets under this app. See WebSocket.publish. */
- publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean) : TemplatedApp;
+ publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean) : boolean;
+ /** Returns number of subscribers for this topic. */
+ numSubscribers(topic: RecognizedString) : number;
}
/** Constructs a non-SSL app. An app is your starting point where you attach behavior to URL routes.