Current section
Files
Jump to
Current section
Files
doc/cloudi_service_http_client.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_client</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_client</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_Client_Service">CloudI HTTP Client Service</a></h3>.
<p>Copyright © 2014 Michael Truog</p>
<p><b>Version:</b> 1.3.3 Sep 30 2014 14:20:10
------------------------------------------------------------------------</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] gmail (dot) com"><tt>mjtruog [at] gmail (dot) com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="CloudI_HTTP_Client_Service">CloudI HTTP Client Service</a></h3>
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-dispatcher">dispatcher()</a></h3>
<p><tt>dispatcher() = <a href="deps/cloudi_core/doc/cloudi.html#type-context">cloudi:context()</a> | <a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a></tt></p>
<h3 class="typedecl"><a name="type-headers">headers()</a></h3>
<p><tt>headers() = [{binary(), binary()}]</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-3">cloudi_service_init/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#cloudi_service_terminate-2">cloudi_service_terminate/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#delete-4">delete/4</a></td><td>
<h4><a name="A_HTTP_DELETE_request.">A HTTP DELETE request.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#delete-5">delete/5</a></td><td>
<h4><a name="A_HTTP_DELETE_request_with_a_timeout.">A HTTP DELETE request with a timeout.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#get-4">get/4</a></td><td>
<h4><a name="A_HTTP_GET_request.">A HTTP GET request.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#get-5">get/5</a></td><td>
<h4><a name="A_HTTP_GET_request_with_a_timeout.">A HTTP GET request with a timeout.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#head-4">head/4</a></td><td>
<h4><a name="A_HTTP_HEAD_request.">A HTTP HEAD request.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#head-5">head/5</a></td><td>
<h4><a name="A_HTTP_HEAD_request_with_a_timeout.">A HTTP HEAD request with a timeout.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#options-4">options/4</a></td><td>
<h4><a name="A_HTTP_OPTIONS_request.">A HTTP OPTIONS request.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#options-5">options/5</a></td><td>
<h4><a name="A_HTTP_OPTIONS_request_with_a_timeout.">A HTTP OPTIONS request with a timeout.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#post-4">post/4</a></td><td>
<h4><a name="A_HTTP_POST_request.">A HTTP POST request.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#post-5">post/5</a></td><td>
<h4><a name="A_HTTP_POST_request_with_a_timeout.">A HTTP POST request with a timeout.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#put-4">put/4</a></td><td>
<h4><a name="A_HTTP_PUT_request.">A HTTP PUT request.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#put-5">put/5</a></td><td>
<h4><a name="A_HTTP_PUT_request_with_a_timeout.">A HTTP PUT request with a timeout.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#trace-4">trace/4</a></td><td>
<h4><a name="A_HTTP_TRACE_request.">A HTTP TRACE request.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#trace-5">trace/5</a></td><td>
<h4><a name="A_HTTP_TRACE_request_with_a_timeout.">A HTTP TRACE request with a timeout.</a></h4>.</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-3">cloudi_service_init/3</a></h3>
<div class="spec">
<p><tt>cloudi_service_init(Args, Prefix, Dispatcher) -> any()</tt></p>
</div>
<h3 class="function"><a name="cloudi_service_terminate-2">cloudi_service_terminate/2</a></h3>
<div class="spec">
<p><tt>cloudi_service_terminate(Reason, State) -> any()</tt></p>
</div>
<h3 class="function"><a name="delete-4">delete/4</a></h3>
<div class="spec">
<p><tt>delete(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary()) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_DELETE_request.">A HTTP DELETE request.</a></h4>
</p>
<h3 class="function"><a name="delete-5">delete/5</a></h3>
<div class="spec">
<p><tt>delete(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_DELETE_request_with_a_timeout.">A HTTP DELETE request with a timeout.</a></h4>
</p>
<h3 class="function"><a name="get-4">get/4</a></h3>
<div class="spec">
<p><tt>get(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary()) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_GET_request.">A HTTP GET request.</a></h4>
</p>
<h3 class="function"><a name="get-5">get/5</a></h3>
<div class="spec">
<p><tt>get(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_GET_request_with_a_timeout.">A HTTP GET request with a timeout.</a></h4>
</p>
<h3 class="function"><a name="head-4">head/4</a></h3>
<div class="spec">
<p><tt>head(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary()) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_HEAD_request.">A HTTP HEAD request.</a></h4>
</p>
<h3 class="function"><a name="head-5">head/5</a></h3>
<div class="spec">
<p><tt>head(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_HEAD_request_with_a_timeout.">A HTTP HEAD request with a timeout.</a></h4>
</p>
<h3 class="function"><a name="options-4">options/4</a></h3>
<div class="spec">
<p><tt>options(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary()) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_OPTIONS_request.">A HTTP OPTIONS request.</a></h4>
</p>
<h3 class="function"><a name="options-5">options/5</a></h3>
<div class="spec">
<p><tt>options(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_OPTIONS_request_with_a_timeout.">A HTTP OPTIONS request with a timeout.</a></h4>
</p>
<h3 class="function"><a name="post-4">post/4</a></h3>
<div class="spec">
<p><tt>post(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary()) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_POST_request.">A HTTP POST request.</a></h4>
</p>
<h3 class="function"><a name="post-5">post/5</a></h3>
<div class="spec">
<p><tt>post(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_POST_request_with_a_timeout.">A HTTP POST request with a timeout.</a></h4>
</p>
<h3 class="function"><a name="put-4">put/4</a></h3>
<div class="spec">
<p><tt>put(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary()) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_PUT_request.">A HTTP PUT request.</a></h4>
</p>
<h3 class="function"><a name="put-5">put/5</a></h3>
<div class="spec">
<p><tt>put(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_PUT_request_with_a_timeout.">A HTTP PUT request with a timeout.</a></h4>
</p>
<h3 class="function"><a name="trace-4">trace/4</a></h3>
<div class="spec">
<p><tt>trace(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary()) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_TRACE_request.">A HTTP TRACE request.</a></h4>
</p>
<h3 class="function"><a name="trace-5">trace/5</a></h3>
<div class="spec">
<p><tt>trace(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Prefix::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, RequestInfo::<a href="#type-headers">headers()</a>, Request::binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, <a href="#type-headers">headers()</a>, binary()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="A_HTTP_TRACE_request_with_a_timeout.">A HTTP TRACE request with a timeout.</a></h4>
</p>
<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, Sep 30 2014, 14:20:10.</i></p>
</body>
</html>