-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathconnect.html
More file actions
473 lines (376 loc) · 19 KB
/
connect.html
File metadata and controls
473 lines (376 loc) · 19 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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width">
<title>connect - XAG Ledger Dev Portal</title>
<!-- favicon -->
<link rel="apple-touch-icon" sizes="180x180" href="assets/favicons/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="16x16" href="assets/favicons/favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="assets/favicons/favicon-32x32.png">
<link rel="manifest" href="assets/favicons/site.webmanifest">
<link rel="shortcut icon" href="favicon.ico">
<meta name="msapplication-TileColor" content="#25A768">
<meta name="msapplication-config" content="assets/favicons/browserconfig.xml">
<meta name="theme-color" content="#25A768">
<!-- jQuery -->
<script src="assets/vendor/jquery-1.11.1.min.js"></script>
<!-- Stylesheet -->
<link href="assets/css/devportal.css" rel="stylesheet" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
<!-- syntax highlighting -->
<link rel="stylesheet" href="assets/vendor/docco.min.css" />
<script src="assets/vendor/highlight.min.js"></script>
<!-- expandable code samples -->
<script src="assets/js/expandcode.js"></script>
<!-- multi-code selection tabs -->
<script src="assets/js/multicodetab.js"></script>
<script>
$(document).ready(function() {
$(".multicode").minitabs();
hljs.initHighlighting();
make_code_expandable();
});
</script>
</head>
<body class="xrp-ledger-dev-portal sidebar-primary lang-en ">
<nav class="navbar fixed-top navbar-expand-lg navbar-light bg-white">
<a href="index.html" class="navbar-brand"><img src="assets/img/logo.png" class="logo" height="44" alt="XAG Ledger Dev Portal" /></a>
<button class="navbar-toggler" type="button" data-toggle="slide-collapse" data-target="#navbarHolder" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse justify-content-end" id="navbarHolder">
<ul class="nav navbar-nav">
<li class="nav-item">
<a class="nav-link" href="dev-tools.html">Dev Tools</a>
</li>
<li class="nav-item">
<a class="nav-link" href="http://xagfans.com/" target="blank">BBS</a>
</li>
</ul><!-- /.navbar-nav -->
<div class="github-edit-wrap">
<a href="https://github.com/xagfans/docs/references/rippled-api/admin-rippled-methods/peer-management-methods/connect.md" target="_blank" class="github-edit">Edit</a>
</div><!-- /.github-edit -->
<div class="nav navbar-nav language-selector">
<div class="dropdown">
<button class="btn btn-outline-secondary dropdown-toggle" type="button" id="language_selector_header_btn" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
English
</button>
<div class="dropdown-menu" aria-labelledby="language_selector_header_btn">
<a class="dropdown-item" href="/connect.html">English</a>
<a class="dropdown-item" href="/cn/connect.html">中文</a>
</div><!--/.dropdown-menu-->
</div><!--/.dropdown-->
</div><!--/.language-selector-->
</div><!--/#navbarHolder-->
<div class="menu-overlay"></div>
</nav>
<div class="container-fluid" role="document" id="main_content_wrapper">
<div class="row">
<!-- Right sidebar first so it's at the beginning for mobile layouts -->
<aside class="right-sidebar col-lg-3 order-lg-4 p-0" role="complementary">
<div class="card" id="page-toc-wrapper">
<div class="card-header">
<h4>In this document</h4>
</div>
<ul class="card-body">
<li class="level-1"><a href="#connect">connect</a></li>
<li class="level-3"><a href="#request-format">Request Format</a></li>
<li class="level-3"><a href="#response-format">Response Format</a></li>
<li class="level-3"><a href="#possible-errors">Possible Errors</a></li>
</ul>
</div>
</aside>
<!-- main column -->
<main class="main col-md-7 col-lg-6 order-md-3 " role="main" id="main_content_body">
<nav class="breadcrumbs-wrap p-0 p-md-3" aria-label="breadcrumb">
<ul class="breadcrumb bg-white">
<li class="breadcrumb-item"><a href="index.html">Home</a></li>
<li class="active breadcrumb-item"><a href="docs.html">Docs</a></li>
<li class="active breadcrumb-item"><a href="references.html">References</a></li>
<li class="active breadcrumb-item"><a href="rippled-api.html">rippled API Reference</a></li>
<li class="active breadcrumb-item">connect</li>
</ul>
</nav><!--/.breadcrumbs-wrap--> <article class="pt-3 p-md-3">
<div class="content">
<h1 id="connect">connect</h1>
<p><a class="external-link" href="https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/Connect.cpp" target="_blank" title="Source">[Source] <i aria-hidden="true" class="fa fa-external-link"></i></a></p>
<p>The <code>connect</code> command forces the <code>rippled</code> server to connect to a specific peer <code>rippled</code> server.</p>
<p><em>The <code>connect</code> method is an <a href="admin-rippled-methods.html">admin method</a> that cannot be run by unprivileged users!</em></p>
<h3 id="request-format">Request Format</h3>
<p>An example of the request format:</p>
<div class="multicode" id="code-0"><ul class="codetabs"><li><a href="#code-0-0">WebSocket</a></li><li><a href="#code-0-1">JSON-RPC</a></li><li><a href="#code-0-2">Commandline</a></li></ul>
<div class="code_sample" id="code-0-0" style="position: static;"><pre><code>{
"command": "connect",
"ip": "192.170.145.88",
"port": 51235
}
</code></pre></div>
<div class="code_sample" id="code-0-1" style="position: static;"><pre><code>{
"method": "connect",
"params": [
{
"ip": "192.170.145.88",
"port": 51235
}
]
}
</code></pre></div>
<div class="code_sample" id="code-0-2" style="position: static;"><pre><code>#Syntax: connect ip [port]
rippled connect 192.170.145.88 51235
</code></pre></div>
</div>
<p>The request includes the following parameters:</p>
<table>
<thead>
<tr>
<th align="left"><code>Field</code></th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>ip</code></td>
<td align="left">String</td>
<td align="left">IP address of the server to connect to</td>
</tr>
<tr>
<td align="left"><code>port</code></td>
<td align="left">Number</td>
<td align="left"><em>(Optional)</em> Port number to use when connecting. Defaults to 6561.</td>
</tr>
</tbody>
</table>
<h3 id="response-format">Response Format</h3>
<p>An example of a successful response:</p>
<div class="multicode" id="code-1"><ul class="codetabs"><li><a href="#code-1-0">JSON-RPC</a></li><li><a href="#code-1-1">Commandline</a></li></ul>
<div class="code_sample" id="code-1-0" style="position: static;"><pre><code>{
"result" : {
"message" : "connecting",
"status" : "success"
}
}
</code></pre></div>
<div class="code_sample" id="code-1-1" style="position: static;"><pre><code>Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
{
"result" : {
"message" : "connecting",
"status" : "success"
}
}
</code></pre></div>
</div>
<p>The response follows the <a href="response-formatting.html">standard format</a>, with a successful result containing the following fields:</p>
<table>
<thead>
<tr>
<th align="left"><code>Field</code></th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>message</code></td>
<td align="left">String</td>
<td align="left">The value <code>connecting</code>, if the command was successful.</td>
</tr>
</tbody>
</table>
<h3 id="possible-errors">Possible Errors</h3>
<ul>
<li>Any of the <a href="error-formatting.html#universal-errors">universal error types</a>.</li>
<li><code>invalidParams</code> - One or more fields are specified incorrectly, or one or more required fields are missing.</li>
<li>Cannot connect in standalone mode - Network-related commands are disabled in stand-alone mode.</li>
</ul>
<!-- -->
<!-- -->
<!-- API object types -->
<!-- -->
<!-- -->
<!-- -->
<!-- rippled release notes links -->
</div>
</article>
</main>
<!-- Left sidebar last so it's at the end for mobile -->
<aside class="sidebar col-md-5 col-lg-3 p-0 order-md-1" role="complementary">
<div class="tree_nav">
<!---->
<div class="sidenav_parent">
<a href="rippled-api.html"> rippled API Reference</a>
</div>
<!---->
<!---->
<div id="sidenav" role="tablist" aria-multiselectable="true">
<div class="card">
<div class="card-header" role="tab" id="sidenav_cat_head_14">
<a class="collapsed sidenav_cat_toggler" role="button" data-toggle="collapse" href="#sidenav_collapse_14" aria-expanded="true" aria-controls="sidenav_collapse_14"></a>
<h5 class="card-title">
<a class="sidenav_cat_title" href="api-conventions.html">API Conventions</a>
</h5>
</div><!-- /.card-header -->
<div id="sidenav_collapse_14" class="collapse" role="tabpanel" aria-labelledby="sidenav_cat_head_14">
<div class="card-body">
<ul class="sidebar_pagelist">
<li><a class="nosubcat-page" href="basic-data-types.html">Basic Data Types</a></li>
<li><a class="nosubcat-page" href="base58-encodings.html">base58 Encodings</a></li>
<li><a class="nosubcat-page" href="currency-formats.html">Currency Formats</a></li>
<li><a class="nosubcat-page" href="error-formatting.html">Error Formatting</a></li>
<li><a class="nosubcat-page" href="markers-and-pagination.html">Markers and Pagination</a></li>
<li><a class="nosubcat-page" href="modifying-the-ledger.html">Modifying the Ledger</a></li>
<li><a class="nosubcat-page" href="rate-limiting.html">Rate Limiting</a></li>
<li><a class="nosubcat-page" href="request-formatting.html">Request Formatting</a></li>
<li><a class="nosubcat-page" href="response-formatting.html">Response Formatting</a></li>
<li><a class="nosubcat-page" href="rippled-server-states.html">rippled Server States</a></li>
<li><a class="nosubcat-page" href="serialization.html">Serialization Format</a></li>
</ul>
</div><!-- /.card-body -->
</div><!-- /#sidenav_collapse14 -->
</div><!-- /.panel -->
<div class="card">
<div class="card-header" role="tab" id="sidenav_cat_head_15">
<a class="collapsed sidenav_cat_toggler" role="button" data-toggle="collapse" href="#sidenav_collapse_15" aria-expanded="true" aria-controls="sidenav_collapse_15"></a>
<h5 class="card-title">
<a class="sidenav_cat_title" href="public-rippled-methods.html">Public rippled Methods</a>
</h5>
</div><!-- /.card-header -->
<div id="sidenav_collapse_15" class="collapse" role="tabpanel" aria-labelledby="sidenav_cat_head_15">
<div class="card-body">
<ul class="sidebar_pagelist">
<li><a class="subcat-title" href="account-methods.html">Account Methods</a></li>
<li><a class="subpage" href="account_currencies.html">account_currencies</a></li>
<li><a class="subpage" href="account_info.html">account_info</a></li>
<li><a class="subpage" href="account_lines.html">account_lines</a></li>
<li><a class="subpage" href="account_objects.html">account_objects</a></li>
<li><a class="subpage" href="account_offers.html">account_offers</a></li>
<li><a class="subpage" href="account_tx.html">account_tx</a></li>
<li><a class="subpage" href="gateway_balances.html">gateway_balances</a></li>
<li><a class="subpage" href="noripple_check.html">noripple_check</a></li>
<li><a class="subcat-title" href="ledger-methods.html">Ledger Methods</a></li>
<li><a class="subpage" href="ledger.html">ledger</a></li>
<li><a class="subpage" href="ledger_closed.html">ledger_closed</a></li>
<li><a class="subpage" href="ledger_current.html">ledger_current</a></li>
<li><a class="subpage" href="ledger_data.html">ledger_data</a></li>
<li><a class="subpage" href="ledger_entry.html">ledger_entry</a></li>
<li><a class="subcat-title" href="transaction-methods.html">Transaction Methods</a></li>
<li><a class="subpage" href="sign.html">sign</a></li>
<li><a class="subpage" href="sign_for.html">sign_for</a></li>
<li><a class="subpage" href="submit.html">submit</a></li>
<li><a class="subpage" href="submit_multisigned.html">submit_multisigned</a></li>
<li><a class="subpage" href="transaction_entry.html">transaction_entry</a></li>
<li><a class="subpage" href="tx.html">tx</a></li>
<li><a class="subpage" href="tx_history.html">tx_history</a></li>
<li><a class="subcat-title" href="path-and-order-book-methods.html">Path and Order Book Methods</a></li>
<li><a class="subpage" href="book_offers.html">book_offers</a></li>
<li><a class="subpage" href="deposit_authorized.html">deposit_authorized</a></li>
<li><a class="subpage" href="path_find.html">path_find</a></li>
<li><a class="subpage" href="ripple_path_find.html">ripple_path_find</a></li>
<li><a class="subcat-title" href="subscription-methods.html">Subscription Methods</a></li>
<li><a class="subpage" href="subscribe.html">subscribe</a></li>
<li><a class="subpage" href="unsubscribe.html">unsubscribe</a></li>
</ul>
</div><!-- /.card-body -->
</div><!-- /#sidenav_collapse15 -->
</div><!-- /.panel -->
</div><!-- /#sidenav -->
</div><!-- /.tree_nav --> </aside>
</div><!--/.row (main layout)-->
</div>
<footer class="xrpl-footer" role="contentinfo">
<section class="container-fluid card-grid card-grid-Nx1">
<div class="card">
<div class="card-header">
<h5><a href="docs.html">Docs</a></h5>
</div><!--/.card-header-->
<div class="card-body">
<div class="children-display">
<ul>
<li class="level-1"><a href="concepts.html">Concepts</a></li>
<li class="level-1"><a href="tutorials.html">Tutorials</a></li>
<li class="level-1"><a href="references.html">References</a></li>
</ul>
</div> </div><!--/.card-body-->
<div class="flag-vertical">01</div>
</div><!--/.card -->
<div class="card">
<div class="card-header">
<h5><a href="use-cases.html">Use Cases</a></h5>
</div><!--/.card-header-->
<div class="card-body">
<div class="children-display">
<ul>
<li class="level-1"><a href="run-a-rippled-validator.html">Run a rippled Validator</a></li>
<li class="level-1"><a href="list-xrp-in-your-exchange.html">List XAG in Your Exchange</a></li>
<li class="level-1"><a href="contribute-code-to-rippled.html">Contribute Code to rippled</a></li>
<li class="level-1"><a href="contribute-code-to-ripple-lib.html">Contribute Code to ripple-lib</a></li>
</ul>
</div> </div><!--/.card-body-->
<div class="flag-vertical">02</div>
</div><!--/.card -->
<div class="card">
<div class="card-header">
<h5><a href="dev-tools.html">Dev Tools</a></h5>
</div><!--/.card-header-->
<div class="card-body">
<div class="children-display">
<ul>
<li class="level-1"><a href="xag-ledger-rpc-tool.html">RPC Tool</a></li>
<li class="level-1"><a href="websocket-api-tool.html">WebSocket API Tool</a></li>
<li class="level-1"><a target="_blank" href="https://scan.xrpgen.com/">XAG Ledger Explorer</a> <i class="fa fa-external-link"></i></li>
</ul>
</div> </div><!--/.card-body-->
<div class="flag-vertical">03</div>
</div><!--/.card -->
<div class="card">
<div class="card-header">
<h5><a href="https://xrpgen.com/" target="_blank">Xrpalike Gene<i class="fa fa-external-link"></i></a></h5>
</div><!--/.card-header-->
<!--/.card-body-->
<div class="flag-vertical">04</div>
</div><!--/.card -->
</section>
<section class="container-fluid p-5 pl-sm-0">
<nav role="navigation" class="d-flex mb-3 language-selector">
<img class="language_selector_icon" src="assets/img/icon-language-selector.svg" width="32" height="40" alt="language selection icon" />
<ul class="nav">
<li class="nav-item">
<a class="nav-link active" href="/connect.html"><i class="fa fa-check-circle"></i> English</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/cn/connect.html">中文</a>
</li>
</ul>
</nav>
<div class="absolute_bottom_footer">
<span>© XAG Ledger Project 2020</span>
<span><a href="">License</a></span>
</div><!-- /.absolute_bottom_footer -->
</section>
</footer>
<!-- Jump to top button -->
<a href="#main_content_wrapper" class="jump-to-top btn btn-primary btn-lg" role="button" title="Jump to top of page">Top</a>
<script type="text/javascript" src="assets/js/jump-to-top.js"></script>
<!-- Non-blocking resources -->
<!-- Bootstrap JS -->
<script src="assets/vendor/bootstrap.min.js"></script>
<!-- fontawesome icons -->
<link rel="stylesheet" href="assets/vendor/fontawesome/css/font-awesome.min.css" />
<!-- Algolia DocSearch -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script type="text/javascript"> docsearch({
apiKey: '70de5b9b8ef95460f3c6e04054b325b2',
indexName: 'xrpl',
inputSelector: '#topsearchbar',
algoliaOptions: { 'facetFilters': ["lang:en"] },
debug: false
});
</script>
<script type="application/javascript">
gtag('set', {'content_group1': 'Content Docs'});
</script>
</body>
</html>