185 lines
11 KiB
HTML
185 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<!-- This manual documents Guile version 3.0.10.
|
|
|
|
Copyright (C) 1996-1997, 2000-2005, 2009-2023 Free Software Foundation,
|
|
Inc.
|
|
|
|
Copyright (C) 2021 Maxime Devos
|
|
|
|
Copyright (C) 2024 Tomas Volf
|
|
|
|
|
|
Permission is granted to copy, distribute and/or modify this document
|
|
under the terms of the GNU Free Documentation License, Version 1.3 or
|
|
any later version published by the Free Software Foundation; with no
|
|
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
|
|
copy of the license is included in the section entitled "GNU Free
|
|
Documentation License." -->
|
|
<title>Network Address Conversion (Guile Reference Manual)</title>
|
|
|
|
<meta name="description" content="Network Address Conversion (Guile Reference Manual)">
|
|
<meta name="keywords" content="Network Address Conversion (Guile Reference Manual)">
|
|
<meta name="resource-type" content="document">
|
|
<meta name="distribution" content="global">
|
|
<meta name="Generator" content=".texi2any-real">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<link href="index.html" rel="start" title="Top">
|
|
<link href="Concept-Index.html" rel="index" title="Concept Index">
|
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
|
<link href="Networking.html" rel="up" title="Networking">
|
|
<link href="Network-Databases.html" rel="next" title="Network Databases">
|
|
<style type="text/css">
|
|
<!--
|
|
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
|
|
div.example {margin-left: 3.2em}
|
|
span:hover a.copiable-link {visibility: visible}
|
|
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
|
|
-->
|
|
</style>
|
|
<link rel="stylesheet" type="text/css" href="https://www.gnu.org/software/gnulib/manual.css">
|
|
|
|
|
|
</head>
|
|
|
|
<body lang="en">
|
|
<div class="subsubsection-level-extent" id="Network-Address-Conversion">
|
|
<div class="nav-panel">
|
|
<p>
|
|
Next: <a href="Network-Databases.html" accesskey="n" rel="next">Network Databases</a>, Up: <a href="Networking.html" accesskey="u" rel="up">Networking</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<hr>
|
|
<h4 class="subsubsection" id="Network-Address-Conversion-1"><span>7.2.11.1 Network Address Conversion<a class="copiable-link" href="#Network-Address-Conversion-1"> ¶</a></span></h4>
|
|
<a class="index-entry-id" id="index-network-address"></a>
|
|
|
|
<p>This section describes procedures which convert internet addresses
|
|
between numeric and string formats.
|
|
</p>
|
|
<h4 class="subsubheading" id="IPv4-Address-Conversion"><span>IPv4 Address Conversion<a class="copiable-link" href="#IPv4-Address-Conversion"> ¶</a></span></h4>
|
|
<a class="index-entry-id" id="index-IPv4"></a>
|
|
|
|
<p>An IPv4 Internet address is a 4-byte value, represented in Guile as an
|
|
integer in host byte order, so that say “0.0.0.1” is 1, or
|
|
“1.0.0.0” is 16777216.
|
|
</p>
|
|
<p>Some underlying C functions use network byte order for addresses,
|
|
Guile converts as necessary so that at the Scheme level its host byte
|
|
order everywhere.
|
|
</p>
|
|
<dl class="first-defvr first-defvar-alias-first-defvr">
|
|
<dt class="defvr defvar-alias-defvr" id="index-INADDR_005fANY"><span class="category-def">Variable: </span><span><strong class="def-name">INADDR_ANY</strong><a class="copiable-link" href="#index-INADDR_005fANY"> ¶</a></span></dt>
|
|
<dd><p>For a server, this can be used with <code class="code">bind</code> (see <a class="pxref" href="Network-Sockets-and-Communication.html">Network Sockets and Communication</a>) to allow connections from any interface on
|
|
the machine.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-defvr first-defvar-alias-first-defvr">
|
|
<dt class="defvr defvar-alias-defvr" id="index-INADDR_005fBROADCAST"><span class="category-def">Variable: </span><span><strong class="def-name">INADDR_BROADCAST</strong><a class="copiable-link" href="#index-INADDR_005fBROADCAST"> ¶</a></span></dt>
|
|
<dd><p>The broadcast address on the local network.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-defvr first-defvar-alias-first-defvr">
|
|
<dt class="defvr defvar-alias-defvr" id="index-INADDR_005fLOOPBACK"><span class="category-def">Variable: </span><span><strong class="def-name">INADDR_LOOPBACK</strong><a class="copiable-link" href="#index-INADDR_005fLOOPBACK"> ¶</a></span></dt>
|
|
<dd><p>The address of the local host using the loopback device, ie.
|
|
‘<samp class="samp">127.0.0.1</samp>’.
|
|
</p></dd></dl>
|
|
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-inet_002dnetof"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">inet-netof</strong> <var class="def-var-arguments">address</var><a class="copiable-link" href="#index-inet_002dnetof"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-scm_005finet_005fnetof"><span class="category-def">C Function: </span><span><strong class="def-name">scm_inet_netof</strong> <var class="def-var-arguments">(address)</var><a class="copiable-link" href="#index-scm_005finet_005fnetof"> ¶</a></span></dt>
|
|
<dd><p>Return the network number part of the given IPv4
|
|
Internet address. E.g.,
|
|
</p>
|
|
<div class="example lisp">
|
|
<pre class="lisp-preformatted">(inet-netof 2130706433) ⇒ 127
|
|
</pre></div>
|
|
</dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-inet_002dlnaof"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">inet-lnaof</strong> <var class="def-var-arguments">address</var><a class="copiable-link" href="#index-inet_002dlnaof"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-scm_005flnaof"><span class="category-def">C Function: </span><span><strong class="def-name">scm_lnaof</strong> <var class="def-var-arguments">(address)</var><a class="copiable-link" href="#index-scm_005flnaof"> ¶</a></span></dt>
|
|
<dd><p>Return the local-address-with-network part of the given
|
|
IPv4 Internet address, using the obsolete class A/B/C system.
|
|
E.g.,
|
|
</p>
|
|
<div class="example lisp">
|
|
<pre class="lisp-preformatted">(inet-lnaof 2130706433) ⇒ 1
|
|
</pre></div>
|
|
</dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-inet_002dmakeaddr"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">inet-makeaddr</strong> <var class="def-var-arguments">net lna</var><a class="copiable-link" href="#index-inet_002dmakeaddr"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-scm_005finet_005fmakeaddr"><span class="category-def">C Function: </span><span><strong class="def-name">scm_inet_makeaddr</strong> <var class="def-var-arguments">(net, lna)</var><a class="copiable-link" href="#index-scm_005finet_005fmakeaddr"> ¶</a></span></dt>
|
|
<dd><p>Make an IPv4 Internet address by combining the network number
|
|
<var class="var">net</var> with the local-address-within-network number
|
|
<var class="var">lna</var>. E.g.,
|
|
</p>
|
|
<div class="example lisp">
|
|
<pre class="lisp-preformatted">(inet-makeaddr 127 1) ⇒ 2130706433
|
|
</pre></div>
|
|
</dd></dl>
|
|
|
|
<h4 class="subsubheading" id="IPv6-Address-Conversion"><span>IPv6 Address Conversion<a class="copiable-link" href="#IPv6-Address-Conversion"> ¶</a></span></h4>
|
|
<a class="index-entry-id" id="index-IPv6"></a>
|
|
|
|
<p>An IPv6 Internet address is a 16-byte value, represented in Guile as
|
|
an integer in host byte order, so that say “::1” is 1. The following
|
|
constants are defined for convenience.
|
|
</p>
|
|
<dl class="first-defvr first-defvar-alias-first-defvr">
|
|
<dt class="defvr defvar-alias-defvr" id="index-IN6ADDR_005fANY"><span class="category-def">Variable: </span><span><strong class="def-name">IN6ADDR_ANY</strong><a class="copiable-link" href="#index-IN6ADDR_005fANY"> ¶</a></span></dt>
|
|
<dd><p>For a server, this can be used with <code class="code">bind</code> (see <a class="pxref" href="Network-Sockets-and-Communication.html">Network Sockets and Communication</a>) to allow connections from any IPv6 interface on the
|
|
machine.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-defvr first-defvar-alias-first-defvr">
|
|
<dt class="defvr defvar-alias-defvr" id="index-IN6ADDR_005fLOOPBACK"><span class="category-def">Variable: </span><span><strong class="def-name">IN6ADDR_LOOPBACK</strong><a class="copiable-link" href="#index-IN6ADDR_005fLOOPBACK"> ¶</a></span></dt>
|
|
<dd><p>The address of the local host using the loopback device, ie.
|
|
‘<samp class="samp">::1</samp>’.
|
|
</p></dd></dl>
|
|
|
|
<p>The procedures below convert an IPv6 <em class="emph">or</em> an IPv4 address to and
|
|
from its textual representation.
|
|
</p>
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-inet_002dntop"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">inet-ntop</strong> <var class="def-var-arguments">family address</var><a class="copiable-link" href="#index-inet_002dntop"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-scm_005finet_005fntop"><span class="category-def">C Function: </span><span><strong class="def-name">scm_inet_ntop</strong> <var class="def-var-arguments">(family, address)</var><a class="copiable-link" href="#index-scm_005finet_005fntop"> ¶</a></span></dt>
|
|
<dd><p>Convert a network address from an integer to a printable string.
|
|
<var class="var">family</var> can be <code class="code">AF_INET</code> or <code class="code">AF_INET6</code>. E.g.,
|
|
</p>
|
|
<div class="example lisp">
|
|
<pre class="lisp-preformatted">(inet-ntop AF_INET 2130706433) ⇒ "127.0.0.1"
|
|
(inet-ntop AF_INET6 (- (expt 2 128) 1))
|
|
⇒ "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"
|
|
</pre></div>
|
|
</dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-inet_002dpton"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">inet-pton</strong> <var class="def-var-arguments">family address</var><a class="copiable-link" href="#index-inet_002dpton"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-scm_005finet_005fpton"><span class="category-def">C Function: </span><span><strong class="def-name">scm_inet_pton</strong> <var class="def-var-arguments">(family, address)</var><a class="copiable-link" href="#index-scm_005finet_005fpton"> ¶</a></span></dt>
|
|
<dd><p>Convert a string containing a printable network address to an integer
|
|
address. <var class="var">family</var> can be <code class="code">AF_INET</code> or <code class="code">AF_INET6</code>.
|
|
E.g.,
|
|
</p>
|
|
<div class="example lisp">
|
|
<pre class="lisp-preformatted">(inet-pton AF_INET "127.0.0.1") ⇒ 2130706433
|
|
(inet-pton AF_INET6 "::1") ⇒ 1
|
|
</pre></div>
|
|
</dd></dl>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
<div class="nav-panel">
|
|
<p>
|
|
Next: <a href="Network-Databases.html">Network Databases</a>, Up: <a href="Networking.html">Networking</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|