Current section
Files
Jump to
Current section
Files
doc/cloudi_service_name.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_service_name</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_service_name</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="CloudI_Service_Name_Creation_and_Parsing">CloudI Service Name Creation and Parsing</a></h3>.
<p>Copyright © 2014-2021 Michael Truog</p>
<p><b>Version:</b> 2.0.3 Oct 11 2022 20:13:40
------------------------------------------------------------------------</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_Service_Name_Creation_and_Parsing">CloudI Service Name Creation and Parsing</a></h3>
<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="#new-2">new/2</a></td><td>
<h4><a name="Transform_a_service_name_pattern_with_parameters_into_an_exact_service_name.">Transform a service name pattern with parameters into an exact service name.</a></h4>
The pattern input can contain consecutive * wildcard characters because
they are only used for a template.</td></tr>
<tr><td valign="top"><a href="#new-4">new/4</a></td><td>
<h4><a name="Transform_a_service_name_pattern_with_parameters_into_an_exact_service_name.">Transform a service name pattern with parameters into an exact service name.</a></h4>
The pattern input can contain consecutive * wildcard characters because
they are only used for a template.</td></tr>
<tr><td valign="top"><a href="#parse-2">parse/2</a></td><td>
<h4><a name="Parse_a_service_name_pattern_to_return_parameters.">Parse a service name pattern to return parameters.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#parse_with_suffix-2">parse_with_suffix/2</a></td><td>
<h4><a name="Parse_a_service_name_pattern_and_return_the_common_suffix.">Parse a service name pattern and return the common suffix.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#pattern-1">pattern/1</a></td><td>
<h4><a name="Determine_if_a_service_name_pattern_contains_wildcard_characters.">Determine if a service name pattern contains wildcard characters.</a></h4>
If not, the service name pattern would only be used with a service name
that is an exact match.</td></tr>
<tr><td valign="top"><a href="#suffix-2">suffix/2</a></td><td>
<h4><a name="Provide_the_suffix_of_the_service_name_or_service_pattern_based_on_the_service's_configured_prefix.">Provide the suffix of the service name or service pattern based on the service's configured prefix.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#utf8-1">utf8/1</a></td><td>
<h4><a name="Convert_the_service_name_or_service_pattern_type_for_interpretation_as_UTF8.">Convert the service name or service pattern type for interpretation as UTF8.</a></h4>
Used for io formatting with ~ts.</td></tr>
<tr><td valign="top"><a href="#utf8_forced-1">utf8_forced/1</a></td><td>
<h4><a name="Force_conversion_of_the_service_name_or_service_pattern_type_for_interpretation_as_UTF8.">Force conversion of the service name or service pattern type for interpretation as UTF8.</a></h4>
Used for io formatting with ~ts.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="new-2">new/2</a></h3>
<div class="spec">
<p><tt>new(Pattern::<a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>, Parameters::[<a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>]) -> {ok, <a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>} | {error, parameters_ignored | parameter_missing}</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Transform_a_service_name_pattern_with_parameters_into_an_exact_service_name.">Transform a service name pattern with parameters into an exact service name.</a></h4>
The pattern input can contain consecutive * wildcard characters because
they are only used for a template.</p>
<h3 class="function"><a name="new-4">new/4</a></h3>
<div class="spec">
<p><tt>new(Pattern::<a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>, Parameters::[<a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>], ParametersSelected::[pos_integer()], ParametersStrictMatching::boolean()) -> {ok, <a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>} | {error, parameters_ignored | parameter_missing | parameters_selected_empty | {parameters_selected_ignored, [pos_integer()]} | {parameters_selected_missing, pos_integer()}}</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Transform_a_service_name_pattern_with_parameters_into_an_exact_service_name.">Transform a service name pattern with parameters into an exact service name.</a></h4>
The pattern input can contain consecutive * wildcard characters because
they are only used for a template.</p>
<h3 class="function"><a name="parse-2">parse/2</a></h3>
<div class="spec">
<p><tt>parse(Name::<a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>, Pattern::<a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>) -> [<a href="doc/cloudi.html#type-nonempty_bytestring">cloudi:nonempty_bytestring()</a>] | error</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Parse_a_service_name_pattern_to_return_parameters.">Parse a service name pattern to return parameters.</a></h4>
</p>
<h3 class="function"><a name="parse_with_suffix-2">parse_with_suffix/2</a></h3>
<div class="spec">
<p><tt>parse_with_suffix(Name::<a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>, Pattern::<a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>) -> {[<a href="doc/cloudi.html#type-nonempty_bytestring">cloudi:nonempty_bytestring()</a>], <a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>} | error</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Parse_a_service_name_pattern_and_return_the_common_suffix.">Parse a service name pattern and return the common suffix.</a></h4>
</p>
<h3 class="function"><a name="pattern-1">pattern/1</a></h3>
<div class="spec">
<p><tt>pattern(Pattern::<a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a>) -> boolean()</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Determine_if_a_service_name_pattern_contains_wildcard_characters.">Determine if a service name pattern contains wildcard characters.</a></h4>
If not, the service name pattern would only be used with a service name
that is an exact match.</p>
<h3 class="function"><a name="suffix-2">suffix/2</a></h3>
<div class="spec">
<p><tt>suffix(Prefix::<a href="doc/cloudi.html#type-nonempty_bytestring">cloudi:nonempty_bytestring()</a>, NameOrPattern::<a href="doc/cloudi.html#type-nonempty_bytestring">cloudi:nonempty_bytestring()</a>) -> <a href="doc/cloudi.html#type-bytestring">cloudi:bytestring()</a></tt><br></p>
<p> </p>
</div><p>
<h4><a name="Provide_the_suffix_of_the_service_name_or_service_pattern_based_on_the_service's_configured_prefix.">Provide the suffix of the service name or service pattern based on the service's configured prefix.</a></h4>
</p>
<h3 class="function"><a name="utf8-1">utf8/1</a></h3>
<div class="spec">
<p><tt>utf8(NameOrPattern::<a href="doc/cloudi.html#type-nonempty_bytestring">cloudi:nonempty_bytestring()</a>) -> <<_:_*8>></tt><br></p>
<p> </p>
</div><p>
<h4><a name="Convert_the_service_name_or_service_pattern_type_for_interpretation_as_UTF8.">Convert the service name or service pattern type for interpretation as UTF8.</a></h4>
Used for io formatting with ~ts.</p>
<h3 class="function"><a name="utf8_forced-1">utf8_forced/1</a></h3>
<div class="spec">
<p><tt>utf8_forced(NameOrPattern::<a href="doc/cloudi.html#type-nonempty_bytestring">cloudi:nonempty_bytestring()</a>) -> <<_:_*8>></tt><br></p>
<p> </p>
</div><p>
<h4><a name="Force_conversion_of_the_service_name_or_service_pattern_type_for_interpretation_as_UTF8.">Force conversion of the service name or service pattern type for interpretation as UTF8.</a></h4>
Used for io formatting with ~ts.</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>