# Module cloudi_service_name

- Description
- Function Index
- Function Details

### CloudI Service Name Creation and Parsing

.

Copyright © 2014-2016 Michael Truog

Version: 1.5.2 Mar 28 2017 19:21:40 ------------------------------------------------------------------------

Authors: Michael Truog (`mjtruog [at] gmail (dot) com`).

## Description

### CloudI Service Name Creation and Parsing

## Function Index

new/2 | #### Transform a service name pattern with parameters into an exact service name. The pattern input can contain consecutive * wildcard characters because they are only used for a template.
new/4 | #### Transform a service name pattern with parameters into an exact service name. The pattern input can contain consecutive * wildcard characters because they are only used for a template.
parse/2 | #### Parse a service name pattern to return parameters. .
parse_with_suffix/2 | #### Parse a service name pattern and return the common suffix. .
suffix/2 | #### Provide the suffix of the service name or service pattern based on the service's configured prefix. .

## Function Details

### new/2

`new(Pattern::string(), Parameters::[string()]) -> {ok, string()} | {error, parameters_ignored | parameter_missing}`

#### Transform a service name pattern with parameters into an exact service name.

The pattern input can contain consecutive * wildcard characters because they are only used for a template.

### new/4

`new(Pattern::string(), Parameters::[string()], ParametersSelected::[pos_integer()], ParametersStrictMatching::boolean()) -> {ok, string()} | {error, parameters_ignored | parameter_missing | parameters_selected_empty | {parameters_selected_ignored, [pos_integer()]} | {parameters_selected_missing, pos_integer()}}`

#### Transform a service name pattern with parameters into an exact service name.

The pattern input can contain consecutive * wildcard characters because they are only used for a template.

### parse/2

`parse(Name::string(), Pattern::string()) -> [string()] | error`

#### Parse a service name pattern to return parameters.

### parse_with_suffix/2

`parse_with_suffix(Name::string(), Pattern::string()) -> {[string()], string()} | error`

#### Parse a service name pattern and return the common suffix.

### suffix/2

`suffix(Prefix::string(), NameOrPattern::string()) -> string()`

#### Provide the suffix of the service name or service pattern based on the service's configured prefix.

Generated by EDoc, Mar 28 2017, 19:21:40.