Module cloudi_args_type

CloudI Service Configuration Arguments Type Checking

Functions to simplify validation done during service initialization.

Copyright © 2015-2023 Michael Truog

Version: 2.0.7 Oct 26 2023 12:17:22 ------------------------------------------------------------------------

Authors: Michael Truog (mjtruog at protonmail dot com).

Description

CloudI Service Configuration Arguments Type Checking

Functions to simplify validation done during service initialization.

Data Types

period()

period() = non_neg_integer() | limit_min | limit_max | {pos_integer(), seconds | second} | {pos_integer(), minutes | minute} | {pos_integer(), hours | hour} | {pos_integer(), days | day}

Function Index

function_optional/2
function_optional_pick/2
function_optional_pick_any/2
function_required/2
function_required_pick/2
period_to_milliseconds/3
period_to_milliseconds/4
period_to_seconds/2
priority/1
service_name/1
service_name_pattern/1
service_name_pattern_suffix/2
service_name_suffix/2
timeout_milliseconds/1
timeout_period/1
timeout_period_to_milliseconds/1

Function Details

function_optional/2

function_optional(Function::undefined | function() | {module(), atom()} | {{module(), atom()}} | {{module(), atom(), list()}}, Arity::non_neg_integer()) -> undefined | function()

function_optional_pick/2

function_optional_pick(Function::undefined | function() | {module(), atom()} | {{module(), atom()}} | {{module(), atom(), list()}}, ArityOrder::[non_neg_integer(), ...]) -> undefined | {function(), Arity::non_neg_integer()}

function_optional_pick_any/2

function_optional_pick_any(Function::undefined | function() | {module(), atom()} | {{module(), atom()}} | {{module(), atom(), list()}}, ArityOrder::[non_neg_integer(), ...]) -> undefined | function()

function_required/2

function_required(Function::function() | {module(), atom()} | {{module(), atom()}} | {{module(), atom(), list()}}, Arity::non_neg_integer()) -> function()

function_required_pick/2

function_required_pick(Function::function() | {module(), atom()} | {{module(), atom()}} | {{module(), atom(), list()}}, ArityOrder::[non_neg_integer(), ...]) -> {function(), Arity::non_neg_integer()}

period_to_milliseconds/3

period_to_milliseconds(Value::period(), Min::non_neg_integer(), Max::pos_integer()) -> non_neg_integer()

period_to_milliseconds/4

period_to_milliseconds(Value::period() | undefined, Min::non_neg_integer(), Max::pos_integer(), Default::period()) -> non_neg_integer()

period_to_seconds/2

period_to_seconds(Value::cloudi_service_api:period_gte(), Min::non_neg_integer()) -> cloudi_service_api:seconds()

priority/1

priority(Priority::cloudi:priority()) -> true

service_name/1

service_name(Name::cloudi:service_name()) -> true

service_name_pattern/1

service_name_pattern(Pattern::cloudi:service_name_pattern()) -> true

service_name_pattern_suffix/2

service_name_pattern_suffix(Prefix::cloudi:service_name_pattern(), Pattern::cloudi:service_name_pattern()) -> cloudi:service_name_pattern_suffix()

service_name_suffix/2

service_name_suffix(Prefix::cloudi:service_name_pattern(), Name::cloudi:service_name()) -> string()

timeout_milliseconds/1

timeout_milliseconds(Timeout::cloudi:timeout_milliseconds()) -> true

timeout_period/1

timeout_period(Timeout::cloudi:timeout_period()) -> true

timeout_period_to_milliseconds/1

timeout_period_to_milliseconds(Timeout::cloudi:timeout_period()) -> cloudi:timeout_milliseconds()


Generated by EDoc