Current section
Files
Jump to
Current section
Files
doc/cloudi_service_http_rest.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_http_rest</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_http_rest</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_HTTP_REST_Integration">CloudI HTTP REST Integration</a></h3>
Provide an easy way of connecting CloudI service requests to
Erlang function calls for a HTTP REST API, with service configuration
arguments.
<p>Copyright © 2015-2018 Michael Truog</p>
<p><b>Version:</b> 1.7.5 Dec 17 2018 21:06:00
------------------------------------------------------------------------</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_HTTP_REST_Integration">CloudI HTTP REST Integration</a></h3>
Provide an easy way of connecting CloudI service requests to
Erlang function calls for a HTTP REST API, with service configuration
arguments.
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-handler_f_11">handler_f_11()</a></h3>
<p><tt>handler_f_11() = fun((Method::<a href="#type-method">method()</a>, Path::<a href="deps/cloudi_core/doc/cloudi.html#type-service_name_pattern">cloudi:service_name_pattern()</a>, Parameters::[string()], Format::atom(), RequestInfo::any(), Request::any(), Timeout::<a href="deps/cloudi_core/doc/cloudi.html#type-timeout_value_milliseconds">cloudi:timeout_value_milliseconds()</a>, Priority::<a href="deps/cloudi_core/doc/cloudi.html#type-priority_value">cloudi:priority_value()</a>, TransId::<a href="deps/cloudi_core/doc/cloudi.html#type-trans_id">cloudi:trans_id()</a>, State::any(), Dispatcher::<a href="deps/cloudi_core/doc/cloudi.html#type-dispatcher">cloudi:dispatcher()</a>) -> {reply, Response::any(), NewState::any()} | {reply, ResponseInfo::any(), Response::any(), NewState::any()} | {forward, NextName::<a href="deps/cloudi_core/doc/cloudi.html#type-service_name">cloudi:service_name()</a>, NextRequestInfo::any(), NextRequest::any(), NewState::any()} | {forward, NextName::<a href="deps/cloudi_core/doc/cloudi.html#type-service_name">cloudi:service_name()</a>, NextRequestInfo::any(), NextRequest::any(), NextTimeout::<a href="deps/cloudi_core/doc/cloudi.html#type-timeout_value_milliseconds">cloudi:timeout_value_milliseconds()</a>, NextPriority::<a href="deps/cloudi_core/doc/cloudi.html#type-priority_value">cloudi:priority_value()</a>, NewState::any()} | {noreply, NewState::any()} | {stop, Reason::any(), NewState::any()})</tt></p>
<h3 class="typedecl"><a name="type-info_f">info_f()</a></h3>
<p><tt>info_f() = fun((Request::any(), State::any(), Dispatcher::<a href="deps/cloudi_core/doc/cloudi.html#type-dispatcher">cloudi:dispatcher()</a>) -> {noreply, NewState::any()} | {stop, Reason::any(), NewState::any()})</tt></p>
<h3 class="typedecl"><a name="type-initialize_f">initialize_f()</a></h3>
<p><tt>initialize_f() = fun((Args::list(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service_api.html#type-timeout_initialize_value_milliseconds">cloudi_service_api:timeout_initialize_value_milliseconds()</a>, Dispatcher::<a href="deps/cloudi_core/doc/cloudi.html#type-dispatcher">cloudi:dispatcher()</a>) -> {ok, State::any()} | {stop, Reason::any()} | {stop, Reason::any(), State::any()})</tt></p>
<h3 class="typedecl"><a name="type-method">method()</a></h3>
<p><tt>method() = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'TRACE' | 'CONNECT'</tt></p>
<h3 class="typedecl"><a name="type-terminate_f">terminate_f()</a></h3>
<p><tt>terminate_f() = fun((Reason::any(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service_api.html#type-timeout_terminate_value_milliseconds">cloudi_service_api:timeout_terminate_value_milliseconds()</a>, State::any()) -> ok)</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>
</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(Request, State, Dispatcher) -> any()</tt></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(Type, Name, Pattern, RequestInfo, Request, Timeout, Priority, TransId, Pid, State, Dispatcher) -> any()</tt></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>
</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>
</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>