mirror of
https://github.com/Rucknium/xmrpeers.git
synced 2024-12-23 03:59:25 +00:00
105 lines
6.1 KiB
HTML
105 lines
6.1 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Ping peer nodes for latency measurement — ping.peers • xmrpeers</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Ping peer nodes for latency measurement — ping.peers"><meta name="description" content="Ping peer nodes for latency measurement"><meta property="og:description" content="Ping peer nodes for latency measurement"></head><body>
|
||
|
|
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
||
|
|
|
||
|
|
|
||
|
|
<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
|
||
|
|
|
||
|
|
<a class="navbar-brand me-2" href="../index.html">xmrpeers</a>
|
||
|
|
|
||
|
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.0</small>
|
||
|
|
|
||
|
|
|
||
|
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||
|
|
<span class="navbar-toggler-icon"></span>
|
||
|
|
</button>
|
||
|
|
|
||
|
|
<div id="navbar" class="collapse navbar-collapse ms-3">
|
||
|
|
<ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
|
||
|
|
</ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
|
||
|
|
<input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
|
||
|
|
</ul></div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</nav><div class="container template-reference-topic">
|
||
|
|
<div class="row">
|
||
|
|
<main id="main" class="col-md-9"><div class="page-header">
|
||
|
|
|
||
|
|
<h1>Ping peer nodes for latency measurement</h1>
|
||
|
|
|
||
|
|
<div class="d-none name"><code>ping.peers.Rd</code></div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="ref-description section level2">
|
||
|
|
<p>Ping peer nodes for latency measurement</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="section level2">
|
||
|
|
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
||
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">ping.peers</span><span class="op">(</span></span>
|
||
|
|
<span> bitmonero.dir <span class="op">=</span> <span class="st">"~/.bitmonero"</span>,</span>
|
||
|
|
<span> output.file <span class="op">=</span> <span class="st">"monero_peer_pings.csv"</span>,</span>
|
||
|
|
<span> sleep <span class="op">=</span> <span class="fl">10</span>,</span>
|
||
|
|
<span> ping.count <span class="op">=</span> <span class="fl">5</span>,</span>
|
||
|
|
<span> threads <span class="op">=</span> <span class="cn">NULL</span></span>
|
||
|
|
<span><span class="op">)</span></span></code></pre></div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="section level2">
|
||
|
|
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
||
|
|
|
||
|
|
|
||
|
|
<dl><dt id="arg-bitmonero-dir">bitmonero.dir<a class="anchor" aria-label="anchor" href="#arg-bitmonero-dir"></a></dt>
|
||
|
|
<dd><p>.bitmonero directory where the monero.log file is.</p></dd>
|
||
|
|
|
||
|
|
|
||
|
|
<dt id="arg-output-file">output.file<a class="anchor" aria-label="anchor" href="#arg-output-file"></a></dt>
|
||
|
|
<dd><p>Name of the output file. The file will be created in <code>bitmonero.dir</code>.</p></dd>
|
||
|
|
|
||
|
|
|
||
|
|
<dt id="arg-sleep">sleep<a class="anchor" aria-label="anchor" href="#arg-sleep"></a></dt>
|
||
|
|
<dd><p>Number of seconds to sleep between each round of collecting new peer IPs.</p></dd>
|
||
|
|
|
||
|
|
|
||
|
|
<dt id="arg-ping-count">ping.count<a class="anchor" aria-label="anchor" href="#arg-ping-count"></a></dt>
|
||
|
|
<dd><p>Number of times to ping each peer.</p></dd>
|
||
|
|
|
||
|
|
|
||
|
|
<dt id="arg-threads">threads<a class="anchor" aria-label="anchor" href="#arg-threads"></a></dt>
|
||
|
|
<dd><p>Override default number of threads for sending pings.</p></dd>
|
||
|
|
|
||
|
|
</dl></div>
|
||
|
|
<div class="section level2">
|
||
|
|
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
||
|
|
<p>No return value. Executes in a loop until interrupted.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="section level2">
|
||
|
|
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
|
||
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span></span>
|
||
|
|
<span class="r-in"><span><span class="fu">ping.peers</span><span class="op">(</span><span class="op">)</span></span></span>
|
||
|
|
<span class="r-in"><span><span class="op">}</span> <span class="co"># }</span></span></span>
|
||
|
|
</code></pre></div>
|
||
|
|
</div>
|
||
|
|
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
|
||
|
|
</nav></aside></div>
|
||
|
|
|
||
|
|
|
||
|
|
<footer><div class="pkgdown-footer-left">
|
||
|
|
<p>Developed by Rucknium.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="pkgdown-footer-right">
|
||
|
|
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</footer></div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</body></html>
|
||
|
|
|