summaryrefslogtreecommitdiff
path: root/lib/kernel/doc/src/inet.xml
diff options
context:
space:
mode:
authorMaria Scott <maria-12648430@hnc-agency.org>2022-02-11 14:42:43 +0100
committerMaria Scott <maria-12648430@hnc-agency.org>2022-02-11 14:42:43 +0100
commita6d6a63af979ebafb95a716375e7300af94dd9f9 (patch)
treecc32a43ee140885310f6c68b107941cf6f0e8b4e /lib/kernel/doc/src/inet.xml
parent60dc3e73dce99659996cf5e74dc256abbb96ef21 (diff)
downloaderlang-a6d6a63af979ebafb95a716375e7300af94dd9f9.tar.gz
Add IP checking functions
Diffstat (limited to 'lib/kernel/doc/src/inet.xml')
-rw-r--r--lib/kernel/doc/src/inet.xml30
1 files changed, 30 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index e1edf3e657..81b9ca8301 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -783,6 +783,36 @@ get_tcpi_sacked(Sock) ->
</func>
<func>
+ <name name="is_ip_address" arity="1" since="OTP @OTP-17923@"/>
+ <fsummary>Tests if <c>IPAddress</c> is an IPv4 or IPv6 address tuple.</fsummary>
+ <desc>
+ <p>Tests if <c>IPAddress</c> is an
+ <seetype marker="#ip_address"><c>ip_address()</c></seetype>
+ and returns <c>true</c> if so, otherwise <c>false</c>.</p>
+ </desc>
+ </func>
+
+ <func>
+ <name name="is_ipv4_address" arity="1" since="OTP @OTP-17923@"/>
+ <fsummary>Tests if <c>IPAddress</c> is an IPv4 address tuple.</fsummary>
+ <desc>
+ <p>Tests if <c>IPAddress</c> is an
+ <seetype marker="#ip4_address"><c>ip4_address()</c></seetype>
+ and returns <c>true</c> if so, otherwise <c>false</c>.</p>
+ </desc>
+ </func>
+
+ <func>
+ <name name="is_ipv6_address" arity="1" since="OTP @OTP-17923@"/>
+ <fsummary>Tests if <c>IPAddress</c> is an IPv6 address tuple.</fsummary>
+ <desc>
+ <p>Tests if <c>IPAddress</c> is an
+ <seetype marker="#ip6_address"><c>ip6_address()</c></seetype>
+ and returns <c>true</c> if so, otherwise <c>false</c>.</p>
+ </desc>
+ </func>
+
+ <func>
<name name="ntoa" arity="1" since="OTP R16B02"/>
<fsummary>Convert IPv6/IPV4 address to ASCII.</fsummary>
<desc>