Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

_frontend_.rpcsocket.html 35KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649
  1. <!doctype html>
  2. <html class="default no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <title>RPCSocket | rpclibrary</title>
  7. <meta name="description" content="">
  8. <meta name="viewport" content="width=device-width, initial-scale=1">
  9. <link rel="stylesheet" href="../assets/css/main.css">
  10. </head>
  11. <body>
  12. <header>
  13. <div class="tsd-page-toolbar">
  14. <div class="container">
  15. <div class="table-wrap">
  16. <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
  17. <div class="field">
  18. <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  19. <input id="tsd-search-field" type="text" />
  20. </div>
  21. <ul class="results">
  22. <li class="state loading">Preparing search index...</li>
  23. <li class="state failure">The search index is not available</li>
  24. </ul>
  25. <a href="../index.html" class="title">rpclibrary</a>
  26. </div>
  27. <div class="table-cell" id="tsd-widgets">
  28. <div id="tsd-filter">
  29. <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  30. <div class="tsd-filter-group">
  31. <div class="tsd-select" id="tsd-filter-visibility">
  32. <span class="tsd-select-label">All</span>
  33. <ul class="tsd-select-list">
  34. <li data-value="public">Public</li>
  35. <li data-value="protected">Public/Protected</li>
  36. <li data-value="private" class="selected">All</li>
  37. </ul>
  38. </div>
  39. <input type="checkbox" id="tsd-filter-inherited" checked />
  40. <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  41. <input type="checkbox" id="tsd-filter-externals" checked />
  42. <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  43. <input type="checkbox" id="tsd-filter-only-exported" />
  44. <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
  45. </div>
  46. </div>
  47. <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  48. </div>
  49. </div>
  50. </div>
  51. </div>
  52. <div class="tsd-page-title">
  53. <div class="container">
  54. <ul class="tsd-breadcrumb">
  55. <li>
  56. <a href="../index.html">Globals</a>
  57. </li>
  58. <li>
  59. <a href="../modules/_frontend_.html">&quot;Frontend&quot;</a>
  60. </li>
  61. <li>
  62. <a href="_frontend_.rpcsocket.html">RPCSocket</a>
  63. </li>
  64. </ul>
  65. <h1>Class RPCSocket</h1>
  66. </div>
  67. </div>
  68. </header>
  69. <div class="container container-main">
  70. <div class="row">
  71. <div class="col-8 col-content">
  72. <section class="tsd-panel tsd-hierarchy">
  73. <h3>Hierarchy</h3>
  74. <ul class="tsd-hierarchy">
  75. <li>
  76. <span class="target">RPCSocket</span>
  77. </li>
  78. </ul>
  79. </section>
  80. <section class="tsd-panel">
  81. <h3>Implements</h3>
  82. <ul class="tsd-hierarchy">
  83. <li><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
  84. </ul>
  85. </section>
  86. <section class="tsd-panel-group tsd-index-group">
  87. <h2>Index</h2>
  88. <section class="tsd-panel tsd-index-panel">
  89. <div class="tsd-index-content">
  90. <section class="tsd-index-section ">
  91. <h3>Constructors</h3>
  92. <ul class="tsd-index-list">
  93. <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#constructor" class="tsd-kind-icon">constructor</a></li>
  94. </ul>
  95. </section>
  96. <section class="tsd-index-section ">
  97. <h3>Properties</h3>
  98. <ul class="tsd-index-list">
  99. <li class="tsd-kind-property tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#port" class="tsd-kind-icon">port</a></li>
  100. <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>
  101. <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>
  102. <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>
  103. </ul>
  104. </section>
  105. <section class="tsd-index-section ">
  106. <h3>Methods</h3>
  107. <ul class="tsd-index-list">
  108. <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#call" class="tsd-kind-icon">call</a></li>
  109. <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>
  110. <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#close" class="tsd-kind-icon">close</a></li>
  111. <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#connect" class="tsd-kind-icon">connect</a></li>
  112. <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#destroy" class="tsd-kind-icon">destroy</a></li>
  113. <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#fire" class="tsd-kind-icon">fire</a></li>
  114. <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#hook" class="tsd-kind-icon">hook</a></li>
  115. <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>
  116. <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#info" class="tsd-kind-icon">info</a></li>
  117. <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#on" class="tsd-kind-icon">on</a></li>
  118. <li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#unhook" class="tsd-kind-icon">unhook</a></li>
  119. </ul>
  120. </section>
  121. </div>
  122. </section>
  123. </section>
  124. <section class="tsd-panel-group tsd-member-group ">
  125. <h2>Constructors</h2>
  126. <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
  127. <a name="constructor" class="tsd-anchor"></a>
  128. <h3>constructor</h3>
  129. <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
  130. <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>
  131. </ul>
  132. <ul class="tsd-descriptions">
  133. <li class="tsd-description">
  134. <aside class="tsd-sources">
  135. <ul>
  136. <li>Defined in Frontend.ts:15</li>
  137. </ul>
  138. </aside>
  139. <h4 class="tsd-parameters-title">Parameters</h4>
  140. <ul class="tsd-parameters">
  141. <li>
  142. <h5>port: <span class="tsd-signature-type">number</span></h5>
  143. </li>
  144. <li>
  145. <h5>server: <span class="tsd-signature-type">string</span></h5>
  146. </li>
  147. <li>
  148. <h5><span class="tsd-flag ts-flagDefault value">Default value</span> tls: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></h5>
  149. </li>
  150. </ul>
  151. <h4 class="tsd-returns-title">Returns <a href="_frontend_.rpcsocket.html" class="tsd-signature-type">RPCSocket</a></h4>
  152. </li>
  153. </ul>
  154. </section>
  155. </section>
  156. <section class="tsd-panel-group tsd-member-group ">
  157. <h2>Properties</h2>
  158. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
  159. <a name="port" class="tsd-anchor"></a>
  160. <h3>port</h3>
  161. <div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
  162. <aside class="tsd-sources">
  163. <p>Implementation of <a href="../interfaces/_interfaces_.socket.html">Socket</a>.<a href="../interfaces/_interfaces_.socket.html#port">port</a></p>
  164. <ul>
  165. <li>Defined in Frontend.ts:16</li>
  166. </ul>
  167. </aside>
  168. </section>
  169. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
  170. <a name="server" class="tsd-anchor"></a>
  171. <h3><span class="tsd-flag ts-flagPrivate">Private</span> server</h3>
  172. <div class="tsd-signature tsd-kind-icon">server<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  173. <aside class="tsd-sources">
  174. <ul>
  175. <li>Defined in Frontend.ts:16</li>
  176. </ul>
  177. </aside>
  178. </section>
  179. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
  180. <a name="socket" class="tsd-anchor"></a>
  181. <h3><span class="tsd-flag ts-flagPrivate">Private</span> socket</h3>
  182. <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>
  183. <aside class="tsd-sources">
  184. <ul>
  185. <li>Defined in Frontend.ts:15</li>
  186. </ul>
  187. </aside>
  188. </section>
  189. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
  190. <a name="tls" class="tsd-anchor"></a>
  191. <h3><span class="tsd-flag ts-flagPrivate">Private</span> tls</h3>
  192. <div class="tsd-signature tsd-kind-icon">tls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
  193. <aside class="tsd-sources">
  194. <ul>
  195. <li>Defined in Frontend.ts:16</li>
  196. </ul>
  197. </aside>
  198. </section>
  199. </section>
  200. <section class="tsd-panel-group tsd-member-group ">
  201. <h2>Methods</h2>
  202. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  203. <a name="call" class="tsd-anchor"></a>
  204. <h3>call</h3>
  205. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  206. <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">&lt;</span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">&gt;</span></li>
  207. </ul>
  208. <ul class="tsd-descriptions">
  209. <li class="tsd-description">
  210. <aside class="tsd-sources">
  211. <ul>
  212. <li>Defined in Frontend.ts:40</li>
  213. </ul>
  214. </aside>
  215. <h4 class="tsd-parameters-title">Parameters</h4>
  216. <ul class="tsd-parameters">
  217. <li>
  218. <h5>rpcname: <span class="tsd-signature-type">T.Name</span></h5>
  219. </li>
  220. <li>
  221. <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>
  222. </li>
  223. </ul>
  224. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  225. </li>
  226. </ul>
  227. </section>
  228. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
  229. <a name="callgenerator" class="tsd-anchor"></a>
  230. <h3><span class="tsd-flag ts-flagPrivate">Private</span> call<wbr>Generator</h3>
  231. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
  232. <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>
  233. </ul>
  234. <ul class="tsd-descriptions">
  235. <li class="tsd-description">
  236. <aside class="tsd-sources">
  237. <ul>
  238. <li>Defined in Frontend.ts:73</li>
  239. </ul>
  240. </aside>
  241. <h4 class="tsd-parameters-title">Parameters</h4>
  242. <ul class="tsd-parameters">
  243. <li>
  244. <h5>fnName: <span class="tsd-signature-type">T.Name</span></h5>
  245. </li>
  246. <li>
  247. <h5>fnArgs: <span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span></h5>
  248. </li>
  249. </ul>
  250. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.AsyncFunction</span></h4>
  251. </li>
  252. </ul>
  253. </section>
  254. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  255. <a name="close" class="tsd-anchor"></a>
  256. <h3>close</h3>
  257. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  258. <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>
  259. </ul>
  260. <ul class="tsd-descriptions">
  261. <li class="tsd-description">
  262. <aside class="tsd-sources">
  263. <p>Implementation of <a href="../interfaces/_interfaces_.socket.html">Socket</a>.<a href="../interfaces/_interfaces_.socket.html#close">close</a></p>
  264. <ul>
  265. <li>Defined in Frontend.ts:36</li>
  266. </ul>
  267. </aside>
  268. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  269. </li>
  270. </ul>
  271. </section>
  272. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  273. <a name="connect" class="tsd-anchor"></a>
  274. <h3>connect</h3>
  275. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  276. <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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
  277. </ul>
  278. <ul class="tsd-descriptions">
  279. <li class="tsd-description">
  280. <aside class="tsd-sources">
  281. <ul>
  282. <li>Defined in Frontend.ts:48</li>
  283. </ul>
  284. </aside>
  285. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
  286. </li>
  287. </ul>
  288. </section>
  289. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  290. <a name="destroy" class="tsd-anchor"></a>
  291. <h3>destroy</h3>
  292. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  293. <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>
  294. </ul>
  295. <ul class="tsd-descriptions">
  296. <li class="tsd-description">
  297. <aside class="tsd-sources">
  298. <p>Implementation of <a href="../interfaces/_interfaces_.socket.html">Socket</a>.<a href="../interfaces/_interfaces_.socket.html#destroy">destroy</a></p>
  299. <ul>
  300. <li>Defined in Frontend.ts:32</li>
  301. </ul>
  302. </aside>
  303. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  304. </li>
  305. </ul>
  306. </section>
  307. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  308. <a name="fire" class="tsd-anchor"></a>
  309. <h3>fire</h3>
  310. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  311. <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">&lt;</span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">&gt;</span></li>
  312. </ul>
  313. <ul class="tsd-descriptions">
  314. <li class="tsd-description">
  315. <aside class="tsd-sources">
  316. <ul>
  317. <li>Defined in Frontend.ts:44</li>
  318. </ul>
  319. </aside>
  320. <h4 class="tsd-parameters-title">Parameters</h4>
  321. <ul class="tsd-parameters">
  322. <li>
  323. <h5>rpcname: <span class="tsd-signature-type">T.Name</span></h5>
  324. </li>
  325. <li>
  326. <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>
  327. </li>
  328. </ul>
  329. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  330. </li>
  331. </ul>
  332. </section>
  333. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  334. <a name="hook" class="tsd-anchor"></a>
  335. <h3>hook</h3>
  336. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  337. <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>
  338. </ul>
  339. <ul class="tsd-descriptions">
  340. <li class="tsd-description">
  341. <aside class="tsd-sources">
  342. <ul>
  343. <li>Defined in Frontend.ts:20</li>
  344. </ul>
  345. </aside>
  346. <h4 class="tsd-parameters-title">Parameters</h4>
  347. <ul class="tsd-parameters">
  348. <li>
  349. <h5>name: <span class="tsd-signature-type">T.Name</span></h5>
  350. </li>
  351. <li>
  352. <h5>handler: <span class="tsd-signature-type">function</span></h5>
  353. <ul class="tsd-parameters">
  354. <li class="tsd-parameter-siganture">
  355. <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
  356. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  357. </ul>
  358. <ul class="tsd-descriptions">
  359. <li class="tsd-description">
  360. <h4 class="tsd-parameters-title">Parameters</h4>
  361. <ul class="tsd-parameters">
  362. <li>
  363. <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>
  364. </li>
  365. </ul>
  366. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span>
  367. <span class="tsd-signature-symbol"> | </span>
  368. <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span>
  369. </h4>
  370. </li>
  371. </ul>
  372. </li>
  373. </ul>
  374. </li>
  375. </ul>
  376. <h4 class="tsd-returns-title">Returns <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
  377. </li>
  378. </ul>
  379. </section>
  380. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
  381. <a name="hookgenerator" class="tsd-anchor"></a>
  382. <h3><span class="tsd-flag ts-flagPrivate">Private</span> hook<wbr>Generator</h3>
  383. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
  384. <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>
  385. </ul>
  386. <ul class="tsd-descriptions">
  387. <li class="tsd-description">
  388. <aside class="tsd-sources">
  389. <ul>
  390. <li>Defined in Frontend.ts:79</li>
  391. </ul>
  392. </aside>
  393. <h4 class="tsd-parameters-title">Parameters</h4>
  394. <ul class="tsd-parameters">
  395. <li>
  396. <h5>fnName: <span class="tsd-signature-type">T.Name</span></h5>
  397. </li>
  398. <li>
  399. <h5>fnArgs: <span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span></h5>
  400. </li>
  401. </ul>
  402. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.HookFunction</span></h4>
  403. </li>
  404. </ul>
  405. </section>
  406. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  407. <a name="info" class="tsd-anchor"></a>
  408. <h3>info</h3>
  409. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  410. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  411. </ul>
  412. <ul class="tsd-descriptions">
  413. <li class="tsd-description">
  414. <aside class="tsd-sources">
  415. <ul>
  416. <li>Defined in Frontend.ts:69</li>
  417. </ul>
  418. </aside>
  419. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  420. </li>
  421. </ul>
  422. </section>
  423. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  424. <a name="on" class="tsd-anchor"></a>
  425. <h3>on</h3>
  426. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  427. <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>
  428. </ul>
  429. <ul class="tsd-descriptions">
  430. <li class="tsd-description">
  431. <aside class="tsd-sources">
  432. <ul>
  433. <li>Defined in Frontend.ts:28</li>
  434. </ul>
  435. </aside>
  436. <h4 class="tsd-parameters-title">Parameters</h4>
  437. <ul class="tsd-parameters">
  438. <li>
  439. <h5>type: <span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"close"</span></h5>
  440. </li>
  441. <li>
  442. <h5>f: <span class="tsd-signature-type">function</span></h5>
  443. <ul class="tsd-parameters">
  444. <li class="tsd-parameter-siganture">
  445. <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
  446. <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>
  447. </ul>
  448. <ul class="tsd-descriptions">
  449. <li class="tsd-description">
  450. <h4 class="tsd-parameters-title">Parameters</h4>
  451. <ul class="tsd-parameters">
  452. <li>
  453. <h5><span class="tsd-flag ts-flagOptional">Optional</span> e: <span class="tsd-signature-type">any</span></h5>
  454. </li>
  455. </ul>
  456. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  457. </li>
  458. </ul>
  459. </li>
  460. </ul>
  461. </li>
  462. </ul>
  463. <h4 class="tsd-returns-title">Returns <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
  464. </li>
  465. </ul>
  466. </section>
  467. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  468. <a name="unhook" class="tsd-anchor"></a>
  469. <h3>unhook</h3>
  470. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  471. <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>
  472. </ul>
  473. <ul class="tsd-descriptions">
  474. <li class="tsd-description">
  475. <aside class="tsd-sources">
  476. <ul>
  477. <li>Defined in Frontend.ts:24</li>
  478. </ul>
  479. </aside>
  480. <h4 class="tsd-parameters-title">Parameters</h4>
  481. <ul class="tsd-parameters">
  482. <li>
  483. <h5>name: <span class="tsd-signature-type">T.Name</span></h5>
  484. </li>
  485. </ul>
  486. <h4 class="tsd-returns-title">Returns <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
  487. </li>
  488. </ul>
  489. </section>
  490. </section>
  491. </div>
  492. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  493. <nav class="tsd-navigation primary">
  494. <ul>
  495. <li class="globals ">
  496. <a href="../index.html"><em>Globals</em></a>
  497. </li>
  498. <li class=" tsd-kind-external-module">
  499. <a href="../modules/_backend_.html">"<wbr>Backend"</a>
  500. </li>
  501. <li class="current tsd-kind-external-module">
  502. <a href="../modules/_frontend_.html">"<wbr>Frontend"</a>
  503. </li>
  504. <li class=" tsd-kind-external-module">
  505. <a href="../modules/_interfaces_.html">"<wbr>Interfaces"</a>
  506. </li>
  507. <li class=" tsd-kind-external-module">
  508. <a href="../modules/_types_.html">"<wbr>Types"</a>
  509. </li>
  510. <li class=" tsd-kind-external-module">
  511. <a href="../modules/_utils_.html">"<wbr>Utils"</a>
  512. </li>
  513. </ul>
  514. </nav>
  515. <nav class="tsd-navigation secondary menu-sticky">
  516. <ul class="before-current">
  517. </ul>
  518. <ul class="current">
  519. <li class="current tsd-kind-class tsd-parent-kind-external-module">
  520. <a href="_frontend_.rpcsocket.html" class="tsd-kind-icon">RPCSocket</a>
  521. <ul>
  522. <li class=" tsd-kind-constructor tsd-parent-kind-class">
  523. <a href="_frontend_.rpcsocket.html#constructor" class="tsd-kind-icon">constructor</a>
  524. </li>
  525. <li class=" tsd-kind-property tsd-parent-kind-class">
  526. <a href="_frontend_.rpcsocket.html#port" class="tsd-kind-icon">port</a>
  527. </li>
  528. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
  529. <a href="_frontend_.rpcsocket.html#server" class="tsd-kind-icon">server</a>
  530. </li>
  531. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
  532. <a href="_frontend_.rpcsocket.html#socket" class="tsd-kind-icon">socket</a>
  533. </li>
  534. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
  535. <a href="_frontend_.rpcsocket.html#tls" class="tsd-kind-icon">tls</a>
  536. </li>
  537. <li class=" tsd-kind-method tsd-parent-kind-class">
  538. <a href="_frontend_.rpcsocket.html#call" class="tsd-kind-icon">call</a>
  539. </li>
  540. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
  541. <a href="_frontend_.rpcsocket.html#callgenerator" class="tsd-kind-icon">call<wbr>Generator</a>
  542. </li>
  543. <li class=" tsd-kind-method tsd-parent-kind-class">
  544. <a href="_frontend_.rpcsocket.html#close" class="tsd-kind-icon">close</a>
  545. </li>
  546. <li class=" tsd-kind-method tsd-parent-kind-class">
  547. <a href="_frontend_.rpcsocket.html#connect" class="tsd-kind-icon">connect</a>
  548. </li>
  549. <li class=" tsd-kind-method tsd-parent-kind-class">
  550. <a href="_frontend_.rpcsocket.html#destroy" class="tsd-kind-icon">destroy</a>
  551. </li>
  552. <li class=" tsd-kind-method tsd-parent-kind-class">
  553. <a href="_frontend_.rpcsocket.html#fire" class="tsd-kind-icon">fire</a>
  554. </li>
  555. <li class=" tsd-kind-method tsd-parent-kind-class">
  556. <a href="_frontend_.rpcsocket.html#hook" class="tsd-kind-icon">hook</a>
  557. </li>
  558. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
  559. <a href="_frontend_.rpcsocket.html#hookgenerator" class="tsd-kind-icon">hook<wbr>Generator</a>
  560. </li>
  561. <li class=" tsd-kind-method tsd-parent-kind-class">
  562. <a href="_frontend_.rpcsocket.html#info" class="tsd-kind-icon">info</a>
  563. </li>
  564. <li class=" tsd-kind-method tsd-parent-kind-class">
  565. <a href="_frontend_.rpcsocket.html#on" class="tsd-kind-icon">on</a>
  566. </li>
  567. <li class=" tsd-kind-method tsd-parent-kind-class">
  568. <a href="_frontend_.rpcsocket.html#unhook" class="tsd-kind-icon">unhook</a>
  569. </li>
  570. </ul>
  571. </li>
  572. </ul>
  573. <ul class="after-current">
  574. <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
  575. <a href="../modules/_frontend_.html#stripafterequals" class="tsd-kind-icon">strip<wbr>After<wbr>Equals</a>
  576. </li>
  577. </ul>
  578. </nav>
  579. </div>
  580. </div>
  581. </div>
  582. <footer class="with-border-bottom">
  583. <div class="container">
  584. <h2>Legend</h2>
  585. <div class="tsd-legend-group">
  586. <ul class="tsd-legend">
  587. <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
  588. <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
  589. <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
  590. <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
  591. <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
  592. <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
  593. <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
  594. <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
  595. </ul>
  596. <ul class="tsd-legend">
  597. <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
  598. <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
  599. <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
  600. <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
  601. </ul>
  602. <ul class="tsd-legend">
  603. <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
  604. <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
  605. <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
  606. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  607. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  608. <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
  609. </ul>
  610. <ul class="tsd-legend">
  611. <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
  612. <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
  613. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  614. <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
  615. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  616. <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
  617. <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
  618. </ul>
  619. <ul class="tsd-legend">
  620. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  621. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  622. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  623. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
  624. </ul>
  625. <ul class="tsd-legend">
  626. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  627. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  628. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
  629. </ul>
  630. <ul class="tsd-legend">
  631. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  632. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  633. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
  634. </ul>
  635. <ul class="tsd-legend">
  636. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
  637. <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
  638. </ul>
  639. </div>
  640. </div>
  641. </footer>
  642. <div class="container tsd-generator">
  643. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  644. </div>
  645. <div class="overlay"></div>
  646. <script src="../assets/js/main.js"></script>
  647. <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
  648. </body>
  649. </html>