-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex_8js.html
More file actions
438 lines (416 loc) · 19.2 KB
/
Copy pathindex_8js.html
File metadata and controls
438 lines (416 loc) · 19.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FastLink: index.js File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">FastLink<span id="projectnumber"> 2.3.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">index.js File Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html">Player</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a460b7a84f6e8cb4b678c7e20aa59d063"><td class="memItemLeft" align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="index_8js.html#a460b7a84f6e8cb4b678c7e20aa59d063">connectNodes</a> (nodes, config)</td></tr>
<tr class="separator:a460b7a84f6e8cb4b678c7e20aa59d063"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b7234db7474a22cbb4d639eaf29f7bb"><td class="memItemLeft" align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="index_8js.html#a3b7234db7474a22cbb4d639eaf29f7bb">anyNodeAvailable</a> ()</td></tr>
<tr class="separator:a3b7234db7474a22cbb4d639eaf29f7bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb228d004aa0d7808bcee0cbeaed9842"><td class="memItemLeft" align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="index_8js.html#acb228d004aa0d7808bcee0cbeaed9842">getPlayers</a> (node)</td></tr>
<tr class="separator:acb228d004aa0d7808bcee0cbeaed9842"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a437bfea988bc2e852122dfa0be017930"><td class="memItemLeft" align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="index_8js.html#a437bfea988bc2e852122dfa0be017930">getInfo</a> (node)</td></tr>
<tr class="separator:a437bfea988bc2e852122dfa0be017930"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6973c88f71b1e2560f2a0c4115bd41ba"><td class="memItemLeft" align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="index_8js.html#a6973c88f71b1e2560f2a0c4115bd41ba">getStats</a> (node)</td></tr>
<tr class="separator:a6973c88f71b1e2560f2a0c4115bd41ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43dbe0751a6d683e27fbf17a6280f05a"><td class="memItemLeft" align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="index_8js.html#a43dbe0751a6d683e27fbf17a6280f05a">getVersion</a> (node)</td></tr>
<tr class="separator:a43dbe0751a6d683e27fbf17a6280f05a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86e7fd52889bf697cc3f6f81c8669aec"><td class="memItemLeft" align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="index_8js.html#a86e7fd52889bf697cc3f6f81c8669aec">getRouterPlannerStatus</a> (node)</td></tr>
<tr class="separator:a86e7fd52889bf697cc3f6f81c8669aec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab978b6c377ce1dd00b3b7914db2b9295"><td class="memItemLeft" align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="index_8js.html#ab978b6c377ce1dd00b3b7914db2b9295">unmarkFailedAddress</a> (node, address)</td></tr>
<tr class="separator:ab978b6c377ce1dd00b3b7914db2b9295"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a716eb30212d6531fdb6c2d671a41a565"><td class="memItemLeft" align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="index_8js.html#a716eb30212d6531fdb6c2d671a41a565">unmarkAllFailedAddresses</a> (node)</td></tr>
<tr class="separator:a716eb30212d6531fdb6c2d671a41a565"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2cf99e827e15b86bc79f2cb19011dcee"><td class="memItemLeft" align="right" valign="top">function </td><td class="memItemRight" valign="bottom"><a class="el" href="index_8js.html#a2cf99e827e15b86bc79f2cb19011dcee">handleRaw</a> (data)</td></tr>
<tr class="separator:a2cf99e827e15b86bc79f2cb19011dcee"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>PerformanC <a href="#" onclick="location.href='mai'+'lto:'+'per'+'fo'+'rma'+'nc'+'org'+'@g'+'mai'+'l.'+'com'; return false;">perfo<span class="obfuscator">.nosp@m.</span>rman<span class="obfuscator">.nosp@m.</span>corg@<span class="obfuscator">.nosp@m.</span>gmai<span class="obfuscator">.nosp@m.</span>l.com</a> </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a3b7234db7474a22cbb4d639eaf29f7bb" name="a3b7234db7474a22cbb4d639eaf29f7bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b7234db7474a22cbb4d639eaf29f7bb">◆ </a></span>anyNodeAvailable()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">function anyNodeAvailable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Checks if any node is connected.</p>
<dl class="section return"><dt>Returns</dt><dd>The boolean if any node is connected or not. </dd></dl>
</div>
</div>
<a id="a460b7a84f6e8cb4b678c7e20aa59d063" name="a460b7a84f6e8cb4b678c7e20aa59d063"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a460b7a84f6e8cb4b678c7e20aa59d063">◆ </a></span>connectNodes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">function connectNodes </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>nodes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Connects node's WebSocket server for communication.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">nodes</td><td>An array of node objects containing connection details. </td></tr>
<tr><td class="paramname">config</td><td>Configuration object containing botId, shards, queue, and debug options. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If nodes or config is not provided or not in the expected format. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Event emitter for listening to LavaLink events. </dd></dl>
</div>
</div>
<a id="a437bfea988bc2e852122dfa0be017930" name="a437bfea988bc2e852122dfa0be017930"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a437bfea988bc2e852122dfa0be017930">◆ </a></span>getInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">function getInfo </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieves the info for a given node.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>The node to retrieve info from. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If no node is provided or if node is not a string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Promise that resolves to the retrieved info data. </dd></dl>
</div>
</div>
<a id="acb228d004aa0d7808bcee0cbeaed9842" name="acb228d004aa0d7808bcee0cbeaed9842"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb228d004aa0d7808bcee0cbeaed9842">◆ </a></span>getPlayers()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">function getPlayers </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieves the players for a given node.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>The node to retrieve players from. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If no node is provided or if node is not a string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Promise that resolves to the retrieved player data. </dd></dl>
</div>
</div>
<a id="a86e7fd52889bf697cc3f6f81c8669aec" name="a86e7fd52889bf697cc3f6f81c8669aec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86e7fd52889bf697cc3f6f81c8669aec">◆ </a></span>getRouterPlannerStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">function getRouterPlannerStatus </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieves the router planner status for a given node.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>The node to retrieve router planner status from. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If no node is provided or if node is not a string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Promise that resolves to the retrieved router planner status data. </dd></dl>
</div>
</div>
<a id="a6973c88f71b1e2560f2a0c4115bd41ba" name="a6973c88f71b1e2560f2a0c4115bd41ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6973c88f71b1e2560f2a0c4115bd41ba">◆ </a></span>getStats()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">function getStats </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieves the stats for a given node.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>The node to retrieve stats from. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If no node is provided or if node is not a string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Promise that resolves to the retrieved stats data. </dd></dl>
</div>
</div>
<a id="a43dbe0751a6d683e27fbf17a6280f05a" name="a43dbe0751a6d683e27fbf17a6280f05a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43dbe0751a6d683e27fbf17a6280f05a">◆ </a></span>getVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">function getVersion </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieves the version for a given node.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>The node to retrieve version from. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If no node is provided or if node is not a string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Promise that resolves to the retrieved version data. </dd></dl>
</div>
</div>
<a id="a2cf99e827e15b86bc79f2cb19011dcee" name="a2cf99e827e15b86bc79f2cb19011dcee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cf99e827e15b86bc79f2cb19011dcee">◆ </a></span>handleRaw()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">function handleRaw </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Handles raw data received from an external source.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The raw data from Discord to handle. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If data is not provided or if data is not an object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a716eb30212d6531fdb6c2d671a41a565" name="a716eb30212d6531fdb6c2d671a41a565"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a716eb30212d6531fdb6c2d671a41a565">◆ </a></span>unmarkAllFailedAddresses()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">function unmarkAllFailedAddresses </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Unmarks all failed addresses for a given node.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>The node to unmark failed addresses from. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If no node is provided or if node is not a string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Promise that resolves when the request is complete. </dd></dl>
</div>
</div>
<a id="ab978b6c377ce1dd00b3b7914db2b9295" name="ab978b6c377ce1dd00b3b7914db2b9295"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab978b6c377ce1dd00b3b7914db2b9295">◆ </a></span>unmarkFailedAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">function unmarkFailedAddress </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>address</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Unmarks a failed address for a given node.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>The node to unmark failed address from. </td></tr>
<tr><td class="paramname">address</td><td>The address to unmark. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If no node is provided or if node is not a string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Promise that resolves when the request is complete. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>