Current section
Files
Jump to
Current section
Files
doc/cloudi_service_api_batch.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_api_batch</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_api_batch</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_Service_API_Batch">CloudI Service API Batch</a></h3> A service that provides batch execution of CloudI services.<p>Copyright © 2019-2023 Michael Truog</p><p><b>Version:</b> 2.0.7 Oct 26 2023 13:27:38 ------------------------------------------------------------------------</p><p><b>Behaviours:</b> <a href="deps/cloudi_core/doc/cloudi_service.html"><tt>cloudi_service</tt></a>.</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_API_Batch">CloudI Service API Batch</a></h3> A service that provides batch execution of CloudI services.<h2><a name="types">Data Types</a></h2><h3 class="typedecl"><a name="type-agent">agent()</a></h3><p><tt>agent() = <a href="deps/cloudi_core/doc/cloudi.html#type-agent">cloudi:agent()</a></tt></p><h3 class="typedecl"><a name="type-module_response">module_response()</a></h3><p><tt>module_response(Result) = {{ok, Result}, NewAgent::<a href="#type-agent">agent()</a>} | {{error, <a href="deps/cloudi_core/doc/cloudi.html#type-error_reason">cloudi:error_reason()</a>}, NewAgent::<a href="#type-agent">agent()</a>}</tt></p><h3 class="typedecl"><a name="type-service_configuration">service_configuration()</a></h3><p><tt>service_configuration() = <a href="deps/cloudi_core/doc/cloudi_service_api.html#type-service_internal">cloudi_service_api:service_internal()</a> | <a href="deps/cloudi_core/doc/cloudi_service_api.html#type-service_external">cloudi_service_api:service_external()</a> | <a href="deps/cloudi_core/doc/cloudi_service_api.html#type-service_proplist">cloudi_service_api:service_proplist()</a></tt></p><h3 class="typedecl"><a name="type-service_configurations">service_configurations()</a></h3><p><tt>service_configurations() = [<a href="#type-service_configuration">service_configuration()</a>, ...]</tt></p><h3 class="typedecl"><a name="type-service_name">service_name()</a></h3><p><tt>service_name() = <a href="deps/cloudi_core/doc/cloudi.html#type-service_name">cloudi:service_name()</a></tt></p><h3 class="typedecl"><a name="type-timeout_period">timeout_period()</a></h3><p><tt>timeout_period() = <a href="deps/cloudi_core/doc/cloudi.html#type-timeout_period">cloudi:timeout_period()</a></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="#cloudi_service_handle_info-3">cloudi_service_handle_info/3</a></td><td></td></tr><tr><td valign="top"><a href="#cloudi_service_handle_request-11">cloudi_service_handle_request/11</a></td><td></td></tr><tr><td valign="top"><a href="#cloudi_service_init-4">cloudi_service_init/4</a></td><td></td></tr><tr><td valign="top"><a href="#cloudi_service_terminate-3">cloudi_service_terminate/3</a></td><td></td></tr><tr><td valign="top"><a href="#queue-3">queue/3</a></td><td></td></tr><tr><td valign="top"><a href="#queue-4">queue/4</a></td><td></td></tr><tr><td valign="top"><a href="#queue_clear-3">queue_clear/3</a></td><td></td></tr><tr><td valign="top"><a href="#queue_clear-4">queue_clear/4</a></td><td></td></tr><tr><td valign="top"><a href="#queue_resume-3">queue_resume/3</a></td><td></td></tr><tr><td valign="top"><a href="#queue_resume-4">queue_resume/4</a></td><td></td></tr><tr><td valign="top"><a href="#queue_suspend-3">queue_suspend/3</a></td><td></td></tr><tr><td valign="top"><a href="#queue_suspend-4">queue_suspend/4</a></td><td></td></tr><tr><td valign="top"><a href="#services_add-4">services_add/4</a></td><td></td></tr><tr><td valign="top"><a href="#services_add-5">services_add/5</a></td><td></td></tr><tr><td valign="top"><a href="#services_remove-3">services_remove/3</a></td><td></td></tr><tr><td valign="top"><a href="#services_remove-4">services_remove/4</a></td><td></td></tr><tr><td valign="top"><a href="#services_restart-3">services_restart/3</a></td><td></td></tr><tr><td valign="top"><a href="#services_restart-4">services_restart/4</a></td><td></td></tr></table><h2><a name="functions">Function Details</a></h2><h3 class="function"><a name="cloudi_service_handle_info-3">cloudi_service_handle_info/3</a></h3><div class="spec"><p><tt>cloudi_service_handle_info(X1, State, Dispatcher) -> any()</tt></p><p> </p></div><h3 class="function"><a name="cloudi_service_handle_request-11">cloudi_service_handle_request/11</a></h3><div class="spec"><p><tt>cloudi_service_handle_request(RequestType, Name, Pattern, RequestInfo, Request, Timeout, Priority, TransId, Source, State, Dispatcher) -> any()</tt></p><p> </p></div><h3 class="function"><a name="cloudi_service_init-4">cloudi_service_init/4</a></h3><div class="spec"><p><tt>cloudi_service_init(Args, Prefix, Timeout, Dispatcher) -> any()</tt></p><p> </p></div><h3 class="function"><a name="cloudi_service_terminate-3">cloudi_service_terminate/3</a></h3><div class="spec"><p><tt>cloudi_service_terminate(Reason, Timeout, State) -> any()</tt></p><p> </p></div><h3 class="function"><a name="queue-3">queue/3</a></h3><div class="spec"><p><tt>queue(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string()) -> <a href="#type-module_response">module_response</a>({ok, [<a href="#type-service_configuration">service_configuration()</a>]} | {error, not_found})</tt><br></p><p> </p></div><h3 class="function"><a name="queue-4">queue/4</a></h3><div class="spec"><p><tt>queue(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string(), Timeout::<a href="#type-timeout_period">timeout_period()</a>) -> <a href="#type-module_response">module_response</a>({ok, [<a href="#type-service_configuration">service_configuration()</a>]} | {error, not_found})</tt><br></p><p> </p></div><h3 class="function"><a name="queue_clear-3">queue_clear/3</a></h3><div class="spec"><p><tt>queue_clear(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string()) -> <a href="#type-module_response">module_response</a>(ok | {error, not_found})</tt><br></p><p> </p></div><h3 class="function"><a name="queue_clear-4">queue_clear/4</a></h3><div class="spec"><p><tt>queue_clear(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string(), Timeout::<a href="#type-timeout_period">timeout_period()</a>) -> <a href="#type-module_response">module_response</a>(ok | {error, not_found})</tt><br></p><p> </p></div><h3 class="function"><a name="queue_resume-3">queue_resume/3</a></h3><div class="spec"><p><tt>queue_resume(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string()) -> <a href="#type-module_response">module_response</a>(ok | {error, not_found})</tt><br></p><p> </p></div><h3 class="function"><a name="queue_resume-4">queue_resume/4</a></h3><div class="spec"><p><tt>queue_resume(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string(), Timeout::<a href="#type-timeout_period">timeout_period()</a>) -> <a href="#type-module_response">module_response</a>(ok | {error, not_found})</tt><br></p><p> </p></div><h3 class="function"><a name="queue_suspend-3">queue_suspend/3</a></h3><div class="spec"><p><tt>queue_suspend(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string()) -> <a href="#type-module_response">module_response</a>(ok | {error, not_found})</tt><br></p><p> </p></div><h3 class="function"><a name="queue_suspend-4">queue_suspend/4</a></h3><div class="spec"><p><tt>queue_suspend(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string(), Timeout::<a href="#type-timeout_period">timeout_period()</a>) -> <a href="#type-module_response">module_response</a>(ok | {error, not_found})</tt><br></p><p> </p></div><h3 class="function"><a name="services_add-4">services_add/4</a></h3><div class="spec"><p><tt>services_add(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string(), Configs::<a href="#type-service_configurations">service_configurations()</a>) -> <a href="#type-module_response">module_response</a>(CountQueued::non_neg_integer() | {error, purged})</tt><br></p><p> </p></div><h3 class="function"><a name="services_add-5">services_add/5</a></h3><div class="spec"><p><tt>services_add(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string(), Configs::<a href="#type-service_configurations">service_configurations()</a>, Timeout::<a href="#type-timeout_period">timeout_period()</a>) -> <a href="#type-module_response">module_response</a>(CountQueued::non_neg_integer() | {error, purged})</tt><br></p><p> </p></div><h3 class="function"><a name="services_remove-3">services_remove/3</a></h3><div class="spec"><p><tt>services_remove(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string()) -> <a href="#type-module_response">module_response</a>(ok | {error, not_found})</tt><br></p><p> </p></div><h3 class="function"><a name="services_remove-4">services_remove/4</a></h3><div class="spec"><p><tt>services_remove(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string(), Timeout::<a href="#type-timeout_period">timeout_period()</a>) -> <a href="#type-module_response">module_response</a>(ok | {error, not_found})</tt><br></p><p> </p></div><h3 class="function"><a name="services_restart-3">services_restart/3</a></h3><div class="spec"><p><tt>services_restart(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string()) -> <a href="#type-module_response">module_response</a>(ok | {error, not_found | not_running})</tt><br></p><p> </p></div><h3 class="function"><a name="services_restart-4">services_restart/4</a></h3><div class="spec"><p><tt>services_restart(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, QueueName::nonempty_string(), Timeout::<a href="#type-timeout_period">timeout_period()</a>) -> <a href="#type-module_response">module_response</a>(ok | {error, not_found | not_running})</tt><br></p><p> </p></div><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>