diff options
| author | Loïc Hoguin <[email protected]> | 2025-04-11 14:34:51 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2025-04-11 14:34:51 +0200 |
| commit | eb808a3f8bbd97d2a2ea0114b43b708a17b44066 (patch) | |
| tree | fc142e5b11792af4f84d8634d9a8809f32344634 /docs/en/gun/2.2/manual/gun.ping/index.html | |
| parent | 25e93c91878b7f8536764b06d2cb72020031acd1 (diff) | |
| download | ninenines.eu-master.tar.gz ninenines.eu-master.tar.bz2 ninenines.eu-master.zip | |
Diffstat (limited to 'docs/en/gun/2.2/manual/gun.ping/index.html')
| -rw-r--r-- | docs/en/gun/2.2/manual/gun.ping/index.html | 208 |
1 files changed, 208 insertions, 0 deletions
diff --git a/docs/en/gun/2.2/manual/gun.ping/index.html b/docs/en/gun/2.2/manual/gun.ping/index.html new file mode 100644 index 00000000..ade04d2b --- /dev/null +++ b/docs/en/gun/2.2/manual/gun.ping/index.html @@ -0,0 +1,208 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:ping(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=7" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + </head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:ping(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:ping - Check the health or RTT of the connection</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ping</font></b>(<font color="#009900">ConnPid</font>) + <font color="#990000">-></font> <b><font color="#000000">ping</font></b>(<font color="#009900">ConnPid</font>, #{}) + +<b><font color="#000000">ping</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">PingRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">PingRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Check the health or round-trip time of the connection.</p> +<p>On protocols that support it, Gun will send a PING frame and wait for its corresponding acknowledgement. When it receives that acknowledgement the user process gets notified via a <code>gun_notify</code> message.</p> +<p>As this happens asynchronously and multiple pings can be sent concurrently, Gun returns a unique reference to the caller that can be used to identify the related acknowledgement.</p> +<p>The following protocols implement PING mechanisms and are supported by this function: HTTP/2.</p> +<p>The following protocols implement PING mechanisms but are not yet supported by this function: HTTP/3 and Websocket. Note that in the case of Websocket, the user can set <code>silence_pings</code> to <code>false</code> and send and receive PING frames.</p> +<p>The following protocols do not implement PING mechanisms: HTTP/1.1, raw and SOCKS5.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options. Only the <code>reply_to</code> and <code>tunnel</code> options are relevant.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the ping is returned. This reference is included in the notification received when a ping ack is received from the server.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.2</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Send a ping and receive an ack</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PingRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:ping</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font> +{<font color="#FF6600">notify</font>, <font color="#FF6600">ping_ack</font>, <font color="#009900">PingRef</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#000080">undefined</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun_notify">gun_notify(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + |