Current section
Files
Jump to
Current section
Files
doc/cloudi_request.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_request</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_request</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_Request">CloudI Request</a></h3>
Request format transform.
<p>Copyright © 2013-2016 Michael Truog</p>
<p><b>Version:</b> 1.5.2 Jan 10 2017 17:27:59
------------------------------------------------------------------------</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_Request">CloudI Request</a></h3>
Request format transform.
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-external_format">external_format()</a></h3>
<p><tt>external_format() = erlang_string | erlang_term | msgpack</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="#external_format-2">external_format/2</a></td><td>
<h4><a name="Decode_incoming_external_request_data.">Decode incoming external request data.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#http_qs_parse-1">http_qs_parse/1</a></td><td>
<h4><a name="Parse_HTTP_Request_query_string_data.">Parse HTTP Request query string data.</a></h4>
Only for GET query string data (when either cloudi_service_http_cowboy
or cloudi_service_http_elli is configured with query_get_format
equal to 'text_pairs').</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="external_format-2">external_format/2</a></h3>
<div class="spec">
<p><tt>external_format(Request::binary(), Format::<a href="#type-external_format">external_format()</a>) -> any()</tt><br></p>
</div><p>
<h4><a name="Decode_incoming_external_request_data.">Decode incoming external request data.</a></h4>
</p>
<h3 class="function"><a name="http_qs_parse-1">http_qs_parse/1</a></h3>
<div class="spec">
<p><tt>http_qs_parse(Request::binary() | <a href="cloudi_key_value.html#type-key_values">cloudi_key_value:key_values()</a>) -> Result::<a href="dict.html#type-dict">dict:dict</a>(<a href="cloudi_key_value.html#type-key">cloudi_key_value:key()</a>, <a href="cloudi_key_value.html#type-value">cloudi_key_value:value()</a>)</tt><br></p>
</div><p>
<h4><a name="Parse_HTTP_Request_query_string_data.">Parse HTTP Request query string data.</a></h4>
Only for GET query string data (when either cloudi_service_http_cowboy
or cloudi_service_http_elli is configured with query_get_format
equal to 'text_pairs'). POST request data that provides parameters
(or GET query strings when query_get_format is equal to 'raw'
(the default)) can be parsed with cow_qs:parse_qs/1 from cowlib.</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, Jan 10 2017, 17:27:59.</i></p>
</body>
</html>