File: C:/Ruby27-x64/share/doc/ruby/html/IPSocket.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class IPSocket - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "./";
var index_rel_prefix = "./";
</script>
<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>
<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="./index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="./table_of_contents.html#pages">Pages</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="BasicSocket.html">BasicSocket</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-getaddress">::getaddress</a>
<li ><a href="#method-c-getaddress_orig">::getaddress_orig</a>
<li ><a href="#method-c-valid_v6-3F">::valid_v6?</a>
<li ><a href="#method-i-addr">#addr</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-peeraddr">#peeraddr</a>
<li ><a href="#method-i-recvfrom">#recvfrom</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-IPSocket">
<h1 id="class-IPSocket" class="class">
class IPSocket
</h1>
<section class="description">
<p><a href="IPSocket.html"><code>IPSocket</code></a> is the super class of <a href="TCPSocket.html"><code>TCPSocket</code></a> and <a href="UDPSocket.html"><code>UDPSocket</code></a>.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-getaddress" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
getaddress(host) → ipaddress
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Lookups the IP address of <em>host</em>.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'socket'</span>
<span class="ruby-constant">IPSocket</span>.<span class="ruby-identifier">getaddress</span>(<span class="ruby-string">"localhost"</span>) <span class="ruby-comment">#=> "127.0.0.1"</span>
<span class="ruby-constant">IPSocket</span>.<span class="ruby-identifier">getaddress</span>(<span class="ruby-string">"ip6-localhost"</span>) <span class="ruby-comment">#=> "::1"</span>
</pre>
<div class="method-source-code" id="getaddress-source">
<pre>static VALUE
ip_s_getaddress(VALUE obj, VALUE host)
{
union_sockaddr addr;
struct rb_addrinfo *res = rsock_addrinfo(host, Qnil, AF_UNSPEC, SOCK_STREAM, 0);
socklen_t len = res->ai->ai_addrlen;
/* just take the first one */
memcpy(&addr, res->ai->ai_addr, len);
rb_freeaddrinfo(res);
return rsock_make_ipaddr(&addr.addr, len);
}</pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="IPSocket.html#method-c-getaddress_orig">getaddress_orig</a>
</div>
</div>
</section>
<section id="private-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Class Methods</h3>
</header>
<div id="method-c-getaddress_orig" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">getaddress_orig</span><span
class="method-args">(p1)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="IPSocket.html#method-c-getaddress">getaddress</a>
</div>
</div>
<div id="method-c-valid_v6-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">valid_v6?</span><span
class="method-args">(addr)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="valid_v6-3F-source">
<pre><span class="ruby-comment"># File lib/ipaddr.rb, line 712</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">valid_v6?</span>(<span class="ruby-identifier">addr</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">addr</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">IPAddr</span><span class="ruby-operator">::</span><span class="ruby-constant">RE_IPV6ADDRLIKE_FULL</span>
<span class="ruby-keyword">if</span> <span class="ruby-node">$2</span>
<span class="ruby-identifier">$~</span>[<span class="ruby-value">2</span>,<span class="ruby-value">4</span>].<span class="ruby-identifier">all?</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">256</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">IPAddr</span><span class="ruby-operator">::</span><span class="ruby-constant">RE_IPV6ADDRLIKE_COMPRESSED</span>
<span class="ruby-keyword">if</span> <span class="ruby-node">$4</span>
<span class="ruby-identifier">addr</span>.<span class="ruby-identifier">count</span>(<span class="ruby-string">':'</span>) <span class="ruby-operator"><=</span> <span class="ruby-value">6</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">$~</span>[<span class="ruby-value">4</span>,<span class="ruby-value">4</span>].<span class="ruby-identifier">all?</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">256</span>}
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">addr</span>.<span class="ruby-identifier">count</span>(<span class="ruby-string">':'</span>) <span class="ruby-operator"><=</span> <span class="ruby-value">7</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-addr" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
addr([reverse_lookup]) → [address_family, port, hostname, numeric_address]
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the local address as an array which contains address_family, port, hostname and numeric_address.</p>
<p>If <code>reverse_lookup</code> is <code>true</code> or <code>:hostname</code>, hostname is obtained from numeric_address using reverse lookup. Or if it is <code>false</code>, or <code>:numeric</code>, hostname is same as numeric_address. Or if it is <code>nil</code> or omitted, obeys to <code>ipsocket.do_not_reverse_lookup</code>. See <code>Socket.getaddrinfo</code> also.</p>
<pre class="ruby"><span class="ruby-constant">TCPSocket</span>.<span class="ruby-identifier">open</span>(<span class="ruby-string">"www.ruby-lang.org"</span>, <span class="ruby-value">80</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">sock</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">addr</span> <span class="ruby-comment">#=> ["AF_INET", 49429, "hal", "192.168.0.128"]</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">addr</span>(<span class="ruby-keyword">true</span>) <span class="ruby-comment">#=> ["AF_INET", 49429, "hal", "192.168.0.128"]</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">addr</span>(<span class="ruby-keyword">false</span>) <span class="ruby-comment">#=> ["AF_INET", 49429, "192.168.0.128", "192.168.0.128"]</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">addr</span>(<span class="ruby-value">:hostname</span>) <span class="ruby-comment">#=> ["AF_INET", 49429, "hal", "192.168.0.128"]</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">addr</span>(<span class="ruby-value">:numeric</span>) <span class="ruby-comment">#=> ["AF_INET", 49429, "192.168.0.128", "192.168.0.128"]</span>
}
</pre>
<div class="method-source-code" id="addr-source">
<pre>static VALUE
ip_addr(int argc, VALUE *argv, VALUE sock)
{
rb_io_t *fptr;
union_sockaddr addr;
socklen_t len = (socklen_t)sizeof addr;
int norevlookup;
GetOpenFile(sock, fptr);
if (argc < 1 || !rsock_revlookup_flag(argv[0], &norevlookup))
norevlookup = fptr->mode & FMODE_NOREVLOOKUP;
if (getsockname(fptr->fd, &addr.addr, &len) < 0)
rb_sys_fail("getsockname(2)");
return rsock_ipaddr(&addr.addr, len, norevlookup);
}</pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
inspect → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return a string describing this <a href="IPSocket.html"><code>IPSocket</code></a> object.</p>
<div class="method-source-code" id="inspect-source">
<pre>static VALUE
ip_inspect(VALUE sock)
{
VALUE str = rb_call_super(0, 0);
rb_io_t *fptr = RFILE(sock)->fptr;
union_sockaddr addr;
socklen_t len = (socklen_t)sizeof addr;
ID id;
if (fptr && fptr->fd >= 0 &&
getsockname(fptr->fd, &addr.addr, &len) >= 0 &&
(id = rsock_intern_family(addr.addr.sa_family)) != 0) {
VALUE family = rb_id2str(id);
char hbuf[1024], pbuf[1024];
long slen = RSTRING_LEN(str);
const char last = (slen > 1 && RSTRING_PTR(str)[slen - 1] == '>') ?
(--slen, '>') : 0;
str = rb_str_subseq(str, 0, slen);
rb_str_cat_cstr(str, ", ");
rb_str_append(str, family);
if (!rb_getnameinfo(&addr.addr, len, hbuf, sizeof(hbuf),
pbuf, sizeof(pbuf), NI_NUMERICHOST | NI_NUMERICSERV)) {
rb_str_cat_cstr(str, ", ");
rb_str_cat_cstr(str, hbuf);
rb_str_cat_cstr(str, ", ");
rb_str_cat_cstr(str, pbuf);
}
if (last) rb_str_cat(str, &last, 1);
}
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-peeraddr" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
peeraddr([reverse_lookup]) → [address_family, port, hostname, numeric_address]
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the remote address as an array which contains address_family, port, hostname and numeric_address. It is defined for connection oriented socket such as <a href="TCPSocket.html"><code>TCPSocket</code></a>.</p>
<p>If <code>reverse_lookup</code> is <code>true</code> or <code>:hostname</code>, hostname is obtained from numeric_address using reverse lookup. Or if it is <code>false</code>, or <code>:numeric</code>, hostname is same as numeric_address. Or if it is <code>nil</code> or omitted, obeys to <code>ipsocket.do_not_reverse_lookup</code>. See <code>Socket.getaddrinfo</code> also.</p>
<pre class="ruby"><span class="ruby-constant">TCPSocket</span>.<span class="ruby-identifier">open</span>(<span class="ruby-string">"www.ruby-lang.org"</span>, <span class="ruby-value">80</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">sock</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">peeraddr</span> <span class="ruby-comment">#=> ["AF_INET", 80, "carbon.ruby-lang.org", "221.186.184.68"]</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">peeraddr</span>(<span class="ruby-keyword">true</span>) <span class="ruby-comment">#=> ["AF_INET", 80, "carbon.ruby-lang.org", "221.186.184.68"]</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">peeraddr</span>(<span class="ruby-keyword">false</span>) <span class="ruby-comment">#=> ["AF_INET", 80, "221.186.184.68", "221.186.184.68"]</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">peeraddr</span>(<span class="ruby-value">:hostname</span>) <span class="ruby-comment">#=> ["AF_INET", 80, "carbon.ruby-lang.org", "221.186.184.68"]</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">peeraddr</span>(<span class="ruby-value">:numeric</span>) <span class="ruby-comment">#=> ["AF_INET", 80, "221.186.184.68", "221.186.184.68"]</span>
}
</pre>
<div class="method-source-code" id="peeraddr-source">
<pre>static VALUE
ip_peeraddr(int argc, VALUE *argv, VALUE sock)
{
rb_io_t *fptr;
union_sockaddr addr;
socklen_t len = (socklen_t)sizeof addr;
int norevlookup;
GetOpenFile(sock, fptr);
if (argc < 1 || !rsock_revlookup_flag(argv[0], &norevlookup))
norevlookup = fptr->mode & FMODE_NOREVLOOKUP;
if (getpeername(fptr->fd, &addr.addr, &len) < 0)
rb_sys_fail("getpeername(2)");
return rsock_ipaddr(&addr.addr, len, norevlookup);
}</pre>
</div>
</div>
</div>
<div id="method-i-recvfrom" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
recvfrom(maxlen) → [mesg, ipaddr]
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
recvfrom(maxlen, flags) → [mesg, ipaddr]
</span>
</div>
<div class="method-description">
<p>Receives a message and return the message as a string and an address which the message come from.</p>
<p><em>maxlen</em> is the maximum number of bytes to receive.</p>
<p><em>flags</em> should be a bitwise OR of Socket::MSG_* constants.</p>
<p>ipaddr is same as IPSocket#{peeraddr,addr}.</p>
<pre class="ruby"><span class="ruby-identifier">u1</span> = <span class="ruby-constant">UDPSocket</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">u1</span>.<span class="ruby-identifier">bind</span>(<span class="ruby-string">"127.0.0.1"</span>, <span class="ruby-value">4913</span>)
<span class="ruby-identifier">u2</span> = <span class="ruby-constant">UDPSocket</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">u2</span>.<span class="ruby-identifier">send</span> <span class="ruby-string">"uuuu"</span>, <span class="ruby-value">0</span>, <span class="ruby-string">"127.0.0.1"</span>, <span class="ruby-value">4913</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">u1</span>.<span class="ruby-identifier">recvfrom</span>(<span class="ruby-value">10</span>) <span class="ruby-comment">#=> ["uuuu", ["AF_INET", 33230, "localhost", "127.0.0.1"]]</span>
</pre>
<div class="method-source-code" id="recvfrom-source">
<pre>static VALUE
ip_recvfrom(int argc, VALUE *argv, VALUE sock)
{
return rsock_s_recvfrom(sock, argc, argv, RECV_IP);
}</pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>