123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649 |
- <!doctype html>
- <html class="default no-js">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <title>RPCSocket | rpclibrary</title>
- <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>
- <a href="../index.html" class="title">rpclibrary</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>
- <input type="checkbox" id="tsd-filter-externals" checked />
- <label class="tsd-widget" for="tsd-filter-externals">Externals</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="../modules/_frontend_.html">"Frontend"</a>
- </li>
- <li>
- <a href="_frontend_.rpcsocket.html">RPCSocket</a>
- </li>
- </ul>
- <h1>Class RPCSocket</h1>
- </div>
- </div>
- </header>
- <div class="container container-main">
- <div class="row">
- <div class="col-8 col-content">
- <section class="tsd-panel tsd-hierarchy">
- <h3>Hierarchy</h3>
- <ul class="tsd-hierarchy">
- <li>
- <span class="target">RPCSocket</span>
- </li>
- </ul>
- </section>
- <section class="tsd-panel">
- <h3>Implements</h3>
- <ul class="tsd-hierarchy">
- <li><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></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>Constructors</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#constructor" class="tsd-kind-icon">constructor</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Properties</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#port" class="tsd-kind-icon">port</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_frontend_.rpcsocket.html#server" class="tsd-kind-icon">server</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_frontend_.rpcsocket.html#socket" class="tsd-kind-icon">socket</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_frontend_.rpcsocket.html#tls" class="tsd-kind-icon">tls</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Methods</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#call" class="tsd-kind-icon">call</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_frontend_.rpcsocket.html#callgenerator" class="tsd-kind-icon">call<wbr>Generator</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#close" class="tsd-kind-icon">close</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#connect" class="tsd-kind-icon">connect</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#destroy" class="tsd-kind-icon">destroy</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#fire" class="tsd-kind-icon">fire</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#hook" class="tsd-kind-icon">hook</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_frontend_.rpcsocket.html#hookgenerator" class="tsd-kind-icon">hook<wbr>Generator</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#info" class="tsd-kind-icon">info</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#on" class="tsd-kind-icon">on</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#unhook" class="tsd-kind-icon">unhook</a></li>
- </ul>
- </section>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Constructors</h2>
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
- <a name="constructor" class="tsd-anchor"></a>
- <h3>constructor</h3>
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
- <li class="tsd-signature tsd-kind-icon">new RPCSocket<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, server<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tls<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="_frontend_.rpcsocket.html" class="tsd-signature-type">RPCSocket</a></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:15</li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>port: <span class="tsd-signature-type">number</span></h5>
- </li>
- <li>
- <h5>server: <span class="tsd-signature-type">string</span></h5>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagDefault value">Default value</span> tls: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <a href="_frontend_.rpcsocket.html" class="tsd-signature-type">RPCSocket</a></h4>
- </li>
- </ul>
- </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-class">
- <a name="port" class="tsd-anchor"></a>
- <h3>port</h3>
- <div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
- <aside class="tsd-sources">
- <p>Implementation of <a href="../interfaces/_interfaces_.socket.html">Socket</a>.<a href="../interfaces/_interfaces_.socket.html#port">port</a></p>
- <ul>
- <li>Defined in Frontend.ts:16</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
- <a name="server" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> server</h3>
- <div class="tsd-signature tsd-kind-icon">server<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:16</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
- <a name="socket" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> socket</h3>
- <div class="tsd-signature tsd-kind-icon">socket<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:15</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
- <a name="tls" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> tls</h3>
- <div class="tsd-signature tsd-kind-icon">tls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:16</li>
- </ul>
- </aside>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Methods</h2>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="call" class="tsd-anchor"></a>
- <h3>call</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <li class="tsd-signature tsd-kind-icon">call<span class="tsd-signature-symbol">(</span>rpcname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:40</li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>rpcname: <span class="tsd-signature-type">T.Name</span></h5>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
- <a name="callgenerator" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> call<wbr>Generator</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
- <li class="tsd-signature tsd-kind-icon">call<wbr>Generator<span class="tsd-signature-symbol">(</span>fnName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, fnArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.AsyncFunction</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:73</li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>fnName: <span class="tsd-signature-type">T.Name</span></h5>
- </li>
- <li>
- <h5>fnArgs: <span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.AsyncFunction</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="close" class="tsd-anchor"></a>
- <h3>close</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <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><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Implementation of <a href="../interfaces/_interfaces_.socket.html">Socket</a>.<a href="../interfaces/_interfaces_.socket.html#close">close</a></p>
- <ul>
- <li>Defined in Frontend.ts:36</li>
- </ul>
- </aside>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="connect" class="tsd-anchor"></a>
- <h3>connect</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:48</li>
- </ul>
- </aside>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="destroy" class="tsd-anchor"></a>
- <h3>destroy</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <li class="tsd-signature tsd-kind-icon">destroy<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">
- <p>Implementation of <a href="../interfaces/_interfaces_.socket.html">Socket</a>.<a href="../interfaces/_interfaces_.socket.html#destroy">destroy</a></p>
- <ul>
- <li>Defined in Frontend.ts:32</li>
- </ul>
- </aside>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="fire" class="tsd-anchor"></a>
- <h3>fire</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <li class="tsd-signature tsd-kind-icon">fire<span class="tsd-signature-symbol">(</span>rpcname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:44</li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>rpcname: <span class="tsd-signature-type">T.Name</span></h5>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="hook" class="tsd-anchor"></a>
- <h3>hook</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <li class="tsd-signature tsd-kind-icon">hook<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, handler<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><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:20</li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>name: <span class="tsd-signature-type">T.Name</span></h5>
- </li>
- <li>
- <h5>handler: <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>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span>
- <span class="tsd-signature-symbol"> | </span>
- <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>
- </h4>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
- <a name="hookgenerator" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> hook<wbr>Generator</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
- <li class="tsd-signature tsd-kind-icon">hook<wbr>Generator<span class="tsd-signature-symbol">(</span>fnName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, fnArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.HookFunction</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:79</li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>fnName: <span class="tsd-signature-type">T.Name</span></h5>
- </li>
- <li>
- <h5>fnArgs: <span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.HookFunction</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="info" class="tsd-anchor"></a>
- <h3>info</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <li class="tsd-signature tsd-kind-icon">info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:69</li>
- </ul>
- </aside>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="on" class="tsd-anchor"></a>
- <h3>on</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"close"</span>, f<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><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:28</li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>type: <span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"close"</span></h5>
- </li>
- <li>
- <h5>f: <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>e<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> e: <span class="tsd-signature-type">any</span></h5>
- </li>
- </ul>
- <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 <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="unhook" class="tsd-anchor"></a>
- <h3>unhook</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <li class="tsd-signature tsd-kind-icon">unhook<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in Frontend.ts:24</li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>name: <span class="tsd-signature-type">T.Name</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
- </li>
- </ul>
- </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>
- <li class=" tsd-kind-external-module">
- <a href="../modules/_backend_.html">"<wbr>Backend"</a>
- </li>
- <li class="current tsd-kind-external-module">
- <a href="../modules/_frontend_.html">"<wbr>Frontend"</a>
- </li>
- <li class=" tsd-kind-external-module">
- <a href="../modules/_interfaces_.html">"<wbr>Interfaces"</a>
- </li>
- <li class=" tsd-kind-external-module">
- <a href="../modules/_types_.html">"<wbr>Types"</a>
- </li>
- <li class=" tsd-kind-external-module">
- <a href="../modules/_utils_.html">"<wbr>Utils"</a>
- </li>
- </ul>
- </nav>
- <nav class="tsd-navigation secondary menu-sticky">
- <ul class="before-current">
- </ul>
- <ul class="current">
- <li class="current tsd-kind-class tsd-parent-kind-external-module">
- <a href="_frontend_.rpcsocket.html" class="tsd-kind-icon">RPCSocket</a>
- <ul>
- <li class=" tsd-kind-constructor tsd-parent-kind-class">
- <a href="_frontend_.rpcsocket.html#constructor" class="tsd-kind-icon">constructor</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class">
- <a href="_frontend_.rpcsocket.html#port" class="tsd-kind-icon">port</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
- <a href="_frontend_.rpcsocket.html#server" class="tsd-kind-icon">server</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
- <a href="_frontend_.rpcsocket.html#socket" class="tsd-kind-icon">socket</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
- <a href="_frontend_.rpcsocket.html#tls" class="tsd-kind-icon">tls</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="_frontend_.rpcsocket.html#call" class="tsd-kind-icon">call</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
- <a href="_frontend_.rpcsocket.html#callgenerator" class="tsd-kind-icon">call<wbr>Generator</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="_frontend_.rpcsocket.html#close" class="tsd-kind-icon">close</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="_frontend_.rpcsocket.html#connect" class="tsd-kind-icon">connect</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="_frontend_.rpcsocket.html#destroy" class="tsd-kind-icon">destroy</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="_frontend_.rpcsocket.html#fire" class="tsd-kind-icon">fire</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="_frontend_.rpcsocket.html#hook" class="tsd-kind-icon">hook</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
- <a href="_frontend_.rpcsocket.html#hookgenerator" class="tsd-kind-icon">hook<wbr>Generator</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="_frontend_.rpcsocket.html#info" class="tsd-kind-icon">info</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="_frontend_.rpcsocket.html#on" class="tsd-kind-icon">on</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="_frontend_.rpcsocket.html#unhook" class="tsd-kind-icon">unhook</a>
- </li>
- </ul>
- </li>
- </ul>
- <ul class="after-current">
- <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
- <a href="../modules/_frontend_.html#stripafterequals" class="tsd-kind-icon">strip<wbr>After<wbr>Equals</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>
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</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="https://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>
|