Current section
Files
Jump to
Current section
Files
doc/cloudi_service_shell.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_shell</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_shell</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_Shell_Service">CloudI Shell Service</a></h3>.
<p>Copyright © 2019-2022 Michael Truog</p>
<p><b>Version:</b> 2.0.5 Oct 12 2022 00:59:33
------------------------------------------------------------------------</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_Shell_Service">CloudI Shell Service</a></h3>
<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}, AgentNew::<a href="#type-agent">agent()</a>} | {{error, <a href="deps/cloudi_core/doc/cloudi.html#type-error_reason">cloudi:error_reason()</a>}, AgentNew::<a href="#type-agent">agent()</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_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="#exec-3">exec/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#exec-4">exec/4</a></td><td></td></tr>
<tr><td valign="top"><a href="#validate_response-2">validate_response/2</a></td><td></td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<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="exec-3">exec/3</a></h3>
<div class="spec">
<p><tt>exec(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, Command::nonempty_string() | binary()) -> <a href="#type-module_response">module_response</a>(binary())</tt><br></p>
<p> </p>
</div>
<h3 class="function"><a name="exec-4">exec/4</a></h3>
<div class="spec">
<p><tt>exec(Agent::<a href="#type-agent">agent()</a>, Prefix::<a href="#type-service_name">service_name()</a>, Command::nonempty_string() | binary(), Timeout::<a href="#type-timeout_period">timeout_period()</a>) -> <a href="#type-module_response">module_response</a>(binary())</tt><br></p>
<p> </p>
</div>
<h3 class="function"><a name="validate_response-2">validate_response/2</a></h3>
<div class="spec">
<p><tt>validate_response(X1::<a href="deps/cloudi_core/doc/cloudi_service.html#type-response_info">cloudi_service:response_info()</a>, Response::<a href="deps/cloudi_core/doc/cloudi_service.html#type-response">cloudi_service:response()</a>) -> boolean()</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>