Copyright © 2019-2023 Michael Truog
Version: 2.0.7 Oct 26 2023 13:27:38 ------------------------------------------------------------------------
Behaviours: cloudi_service.
Authors: Michael Truog (mjtruog at protonmail dot com).
agent() = cloudi:agent()
module_response(Result) = {{ok, Result}, NewAgent::agent()} | {{error, cloudi:error_reason()}, NewAgent::agent()}
service_configuration() = cloudi_service_api:service_internal() | cloudi_service_api:service_external() | cloudi_service_api:service_proplist()
service_configurations() = [service_configuration(), ...]
service_name() = cloudi:service_name()
timeout_period() = cloudi:timeout_period()
cloudi_service_handle_info(X1, State, Dispatcher) -> any()
cloudi_service_handle_request(RequestType, Name, Pattern, RequestInfo, Request, Timeout, Priority, TransId, Source, State, Dispatcher) -> any()
cloudi_service_init(Args, Prefix, Timeout, Dispatcher) -> any()
cloudi_service_terminate(Reason, Timeout, State) -> any()
queue(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string()) -> module_response({ok, [service_configuration()]} | {error, not_found})
queue(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string(), Timeout::timeout_period()) -> module_response({ok, [service_configuration()]} | {error, not_found})
queue_clear(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string()) -> module_response(ok | {error, not_found})
queue_clear(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string(), Timeout::timeout_period()) -> module_response(ok | {error, not_found})
queue_resume(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string()) -> module_response(ok | {error, not_found})
queue_resume(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string(), Timeout::timeout_period()) -> module_response(ok | {error, not_found})
queue_suspend(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string()) -> module_response(ok | {error, not_found})
queue_suspend(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string(), Timeout::timeout_period()) -> module_response(ok | {error, not_found})
services_add(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string(), Configs::service_configurations()) -> module_response(CountQueued::non_neg_integer() | {error, purged})
services_add(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string(), Configs::service_configurations(), Timeout::timeout_period()) -> module_response(CountQueued::non_neg_integer() | {error, purged})
services_remove(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string()) -> module_response(ok | {error, not_found})
services_remove(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string(), Timeout::timeout_period()) -> module_response(ok | {error, not_found})
services_restart(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string()) -> module_response(ok | {error, not_found | not_running})
services_restart(Agent::agent(), Prefix::service_name(), QueueName::nonempty_string(), Timeout::timeout_period()) -> module_response(ok | {error, not_found | not_running})
Generated by EDoc