Current section
Files
Jump to
Current section
Files
doc/cloudi_ip_address.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module cloudi_ip_address</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module cloudi_ip_address</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="CloudI_IP_Address_Parsing">CloudI IP Address Parsing</a></h3>.
<p>Copyright © 2013-2021 Michael Truog</p>
<p><b>Version:</b> 2.0.3 Oct 26 2023 12:17:28
------------------------------------------------------------------------</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog at protonmail dot com"><tt>mjtruog at protonmail dot com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="CloudI_IP_Address_Parsing">CloudI IP Address Parsing</a></h3>
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-cidr_string">cidr_string()</a></h3>
<p><tt>cidr_string() = [48..57 | 46 | 97..102 | 58 | 47, ...]</tt></p>
<h3 class="typedecl"><a name="type-format_binary">format_binary()</a></h3>
<p><tt>format_binary() = <<_:8, _:_*8>></tt></p>
<p> IPv4 dotted decimal address (no octal or hex)
IPv6 lowercase hex with colons</p>
<h3 class="typedecl"><a name="type-format_string">format_string()</a></h3>
<p><tt>format_string() = [48..57 | 46 | 97..102 | 58 | 37, ...]</tt></p>
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#from_binary-1">from_binary/1</a></td><td>
<h4><a name="Parse_a_binary_string_representation.">Parse a binary string representation.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#from_string-1">from_string/1</a></td><td>
<h4><a name="Parse_a_binary_string_representation.">Parse a binary string representation.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#patterns-1">patterns/1</a></td><td>
<h4><a name="Create_service_name_pattern_strings_that_represent_a_CIDR_(Classless_Inter-Domain_Routing)_notation_string.">Create service name pattern strings that represent a CIDR (Classless Inter-Domain Routing) notation string.</a></h4>
Usage of the resulting patterns requires at least 1 suffix letter
in the service name pattern string created with each pattern
(i.e., each pattern wouldn't be used as a suffix).</td></tr>
<tr><td valign="top"><a href="#to_binary-1">to_binary/1</a></td><td>
<h4><a name="Create_a_binary_string_representation.">Create a binary string representation.</a></h4>
IPv6 doesn't shorten a group of zeroes so more exact pattern matches
are possible in service names.</td></tr>
<tr><td valign="top"><a href="#to_string-1">to_string/1</a></td><td>
<h4><a name="Create_a_list_string_representation.">Create a list string representation.</a></h4>
IPv6 doesn't shorten a group of zeroes so more exact pattern matches
are possible in service names.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="from_binary-1">from_binary/1</a></h3>
<div class="spec">
<p><tt>from_binary(BinaryIP::<a href="#type-format_binary">format_binary()</a>) -> <a href="/home/george/organized/work/financial_helper_apps/mc2_all-patterns/intraday_system/cloudi_org/kernel/doc/inet.html#type-ip_address">inet:ip_address()</a></tt><br></p>
<p> </p>
</div><p>
<h4><a name="Parse_a_binary_string_representation.">Parse a binary string representation.</a></h4>
</p>
<h3 class="function"><a name="from_string-1">from_string/1</a></h3>
<div class="spec">
<p><tt>from_string(StringIP::<a href="#type-format_string">format_string()</a>) -> <a href="/home/george/organized/work/financial_helper_apps/mc2_all-patterns/intraday_system/cloudi_org/kernel/doc/inet.html#type-ip_address">inet:ip_address()</a></tt><br></p>
<p> </p>
</div><p>
<h4><a name="Parse_a_binary_string_representation.">Parse a binary string representation.</a></h4>
</p>
<h3 class="function"><a name="patterns-1">patterns/1</a></h3>
<div class="spec">
<p><tt>patterns(CIDR::<a href="#type-cidr_string">cidr_string()</a>) -> [<a href="doc/cloudi.html#type-service_name_pattern">cloudi:service_name_pattern()</a>, ...]</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Create_service_name_pattern_strings_that_represent_a_CIDR_(Classless_Inter-Domain_Routing)_notation_string.">Create service name pattern strings that represent a CIDR (Classless Inter-Domain Routing) notation string.</a></h4>
Usage of the resulting patterns requires at least 1 suffix letter
in the service name pattern string created with each pattern
(i.e., each pattern wouldn't be used as a suffix).</p>
<h3 class="function"><a name="to_binary-1">to_binary/1</a></h3>
<div class="spec">
<p><tt>to_binary(IP::<a href="/home/george/organized/work/financial_helper_apps/mc2_all-patterns/intraday_system/cloudi_org/kernel/doc/inet.html#type-ip_address">inet:ip_address()</a>) -> <a href="#type-format_binary">format_binary()</a></tt><br></p>
<p> </p>
</div><p>
<h4><a name="Create_a_binary_string_representation.">Create a binary string representation.</a></h4>
IPv6 doesn't shorten a group of zeroes so more exact pattern matches
are possible in service names.</p>
<h3 class="function"><a name="to_string-1">to_string/1</a></h3>
<div class="spec">
<p><tt>to_string(X1::<a href="/home/george/organized/work/financial_helper_apps/mc2_all-patterns/intraday_system/cloudi_org/kernel/doc/inet.html#type-ip_address">inet:ip_address()</a>) -> <a href="#type-format_string">format_string()</a></tt><br></p>
<p> </p>
</div><p>
<h4><a name="Create_a_list_string_representation.">Create a list string representation.</a></h4>
IPv6 doesn't shorten a group of zeroes so more exact pattern matches
are possible in service names.</p>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc</i></p>
</body>
</html>