6 lines
8.6 KiB
HTML
6 lines
8.6 KiB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AppOptions | uWebSockets.js v20.4.0 documentation</title><meta name="description" content="Documentation for uWebSockets.js v20.4.0 documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">uWebSockets.js v20.4.0 documentation</a></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></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">uWebSockets.js v20.4.0 documentation</a></li><li><a href="AppOptions.html">AppOptions</a></li></ul><h1>Interface AppOptions</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>Options used when constructing an app. Especially for SSLApp.
|
|
These are options passed directly to uSockets, C layer.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">AppOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#cert_file_name" class="tsd-kind-icon">cert_<wbr/>file_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#dh_params_file_name" class="tsd-kind-icon">dh_<wbr/>params_<wbr/>file_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#key_file_name" class="tsd-kind-icon">key_<wbr/>file_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#passphrase" class="tsd-kind-icon">passphrase</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#ssl_prefer_low_memory_usage" class="tsd-kind-icon">ssl_<wbr/>prefer_<wbr/>low_<wbr/>memory_<wbr/>usage</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="cert_file_name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> cert_<wbr/>file_<wbr/>name</h3><div class="tsd-signature tsd-kind-icon">cert_<wbr/>file_<wbr/>name<span class="tsd-signature-symbol">?:</span> <a href="../index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L252">index.d.ts:252</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="dh_params_file_name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> dh_<wbr/>params_<wbr/>file_<wbr/>name</h3><div class="tsd-signature tsd-kind-icon">dh_<wbr/>params_<wbr/>file_<wbr/>name<span class="tsd-signature-symbol">?:</span> <a href="../index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L254">index.d.ts:254</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="key_file_name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> key_<wbr/>file_<wbr/>name</h3><div class="tsd-signature tsd-kind-icon">key_<wbr/>file_<wbr/>name<span class="tsd-signature-symbol">?:</span> <a href="../index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L251">index.d.ts:251</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="passphrase" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> passphrase</h3><div class="tsd-signature tsd-kind-icon">passphrase<span class="tsd-signature-symbol">?:</span> <a href="../index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L253">index.d.ts:253</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ssl_prefer_low_memory_usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ssl_<wbr/>prefer_<wbr/>low_<wbr/>memory_<wbr/>usage</h3><div class="tsd-signature tsd-kind-icon">ssl_<wbr/>prefer_<wbr/>low_<wbr/>memory_<wbr/>usage<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L256">index.d.ts:256</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>This translates to SSL_MODE_RELEASE_BUFFERS</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=""><a href="../index.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AppOptions.html" class="tsd-kind-icon">App<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#cert_file_name" class="tsd-kind-icon">cert_<wbr/>file_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#dh_params_file_name" class="tsd-kind-icon">dh_<wbr/>params_<wbr/>file_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#key_file_name" class="tsd-kind-icon">key_<wbr/>file_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#passphrase" class="tsd-kind-icon">passphrase</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#ssl_prefer_low_memory_usage" class="tsd-kind-icon">ssl_<wbr/>prefer_<wbr/>low_<wbr/>memory_<wbr/>usage</a></li></ul></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-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></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |