2019-02-21 19:03:43 +00:00
|
|
|
<!doctype html>
|
|
|
|
|
<html class="default no-js">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
2019-03-03 07:15:48 +00:00
|
|
|
<title>CompressOptions | uWebSockets.js v15.6.0 documentation</title>
|
2019-02-21 19:03:43 +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>
|
2019-03-03 07:15:48 +00:00
|
|
|
<a href="../index.html" class="title">uWebSockets.js v15.6.0 documentation</a>
|
2019-02-21 19:03:43 +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="compressoptions.html">CompressOptions</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h1>Enumeration CompressOptions</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>WebSocket compression options</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
|
|
|
<h2>Index</h2>
|
|
|
|
|
<section class="tsd-panel tsd-index-panel">
|
|
|
|
|
<div class="tsd-index-content">
|
|
|
|
|
<section class="tsd-index-section ">
|
|
|
|
|
<h3>Enumeration members</h3>
|
|
|
|
|
<ul class="tsd-index-list">
|
|
|
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="compressoptions.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a></li>
|
|
|
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="compressoptions.html#disabled" class="tsd-kind-icon">DISABLED</a></li>
|
|
|
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="compressoptions.html#shared_compressor" class="tsd-kind-icon">SHARED_<wbr>COMPRESSOR</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
|
|
<h2>Enumeration members</h2>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
|
|
|
|
<a name="dedicated_compressor" class="tsd-anchor"></a>
|
|
|
|
|
<h3>DEDICATED_<wbr>COMPRESSOR</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> </div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-03-10 13:13:06 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/ae32259/docs/index.d.ts#L172">index.d.ts:172</a></li>
|
2019-02-21 19:03:43 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Sliding dedicated compress window, requires lots of memory per socket</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
|
|
|
|
<a name="disabled" class="tsd-anchor"></a>
|
|
|
|
|
<h3>DISABLED</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">DISABLED<span class="tsd-signature-symbol">:</span> </div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-03-10 13:13:06 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/ae32259/docs/index.d.ts#L168">index.d.ts:168</a></li>
|
2019-02-21 19:03:43 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>No compression (always a good idea)</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
|
|
|
|
<a name="shared_compressor" class="tsd-anchor"></a>
|
|
|
|
|
<h3>SHARED_<wbr>COMPRESSOR</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">SHARED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> </div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-03-10 13:13:06 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/ae32259/docs/index.d.ts#L170">index.d.ts:170</a></li>
|
2019-02-21 19:03:43 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Zero memory overhead compression (recommended)</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
</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">
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="current">
|
|
|
|
|
<li class="current tsd-kind-enum">
|
|
|
|
|
<a href="compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
|
|
|
|
|
<a href="compressoptions.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
|
|
|
|
|
<a href="compressoptions.html#disabled" class="tsd-kind-icon">DISABLED</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
|
|
|
|
|
<a href="compressoptions.html#shared_compressor" class="tsd-kind-icon">SHARED_<wbr>COMPRESSOR</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="after-current">
|
|
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="../interfaces/appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="../interfaces/httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="../interfaces/httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="../interfaces/templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="../interfaces/websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="../interfaces/websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="../interfaces/us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
|
|
|
|
</li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
|
|
|
|
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
|
|
|
|
</li>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li class=" tsd-kind-function">
|
|
|
|
|
<a href="../index.html#app" class="tsd-kind-icon">App</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-function">
|
|
|
|
|
<a href="../index.html#sslapp" class="tsd-kind-icon">SSLApp</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-function">
|
|
|
|
|
<a href="../index.html#us_listen_socket_close" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket_<wbr>close</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</nav>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<footer class="with-border-bottom">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<h2>Legend</h2>
|
|
|
|
|
<div class="tsd-legend-group">
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
|
|
|
|
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
|
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
|
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
|
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
|
|
|
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
|
|
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
|
|
|
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
|
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
|
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
|
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
|
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
|
|
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
|
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
|
|
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
|
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
|
|
|
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</footer>
|
|
|
|
|
<div class="container tsd-generator">
|
|
|
|
|
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
|
|
|
</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>
|
