diff options
Diffstat (limited to 'docs/en/cowboy/1.0/guide/multipart_req/index.html')
| -rw-r--r-- | docs/en/cowboy/1.0/guide/multipart_req/index.html | 261 |
1 files changed, 0 insertions, 261 deletions
diff --git a/docs/en/cowboy/1.0/guide/multipart_req/index.html b/docs/en/cowboy/1.0/guide/multipart_req/index.html deleted file mode 100644 index d4661cb6..00000000 --- a/docs/en/cowboy/1.0/guide/multipart_req/index.html +++ /dev/null @@ -1,261 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy User Guide</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> - <link href="/css/bootstrap.min.css" rel="stylesheet"> - <link href="/css/99s.css" rel="stylesheet"> -<!-- <link href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <link rel="shortcut icon" href="/img/ico/favicon.ico"> - <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> - <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> - <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <header id="page-head"> - <div id="topbar" class="container"> - <div class="row"> - <div class="span2"> - <h1 id="logo"><a href="/" title="99s">99s</a></h1> - </div> - <div class="span10"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></a> - </li> --> - </ul> - </div> - </div> - </div> - </div> - - - </header> - - -<div id="contents" class="two_col"> -<div class="container"> -<div class="row"> -<div id="docs" class="span9 maincol"> - -<h1 class="lined-header"><span>Multipart requests</span></h1> - -<p>You can read and parse multipart messages using the Req object directly.</p> - -<p>Cowboy defines two functions that allows you to get information about each part and read their contents.</p> - -<h2 id="checking_the_content-type">Checking the content-type</h2> - -<p>While there is a variety of multipart messages, the most common on the Web is <code>multipart/form-data</code>. It's the type of message being sent when an HTML form allows uploading files.</p> - -<p>You can quickly figure out if a multipart message has been sent by parsing the <code>content-type</code> header.</p> - -<script type="syntaxhighlighter" class="brush: erlang"><![CDATA[ -{ok, {<<"multipart">>, <<"form-data">>, _}, Req2} - = cowboy_req:parse_header(<<"content-type">>, Req). -]]></script> - -<h2 id="reading_a_multipart_message">Reading a multipart message</h2> - -<p>To read a message you have to iterate over all its parts. Then, for each part, you can inspect its headers and read its body.</p> - -<script type="syntaxhighlighter" class="brush: erlang"><![CDATA[ -multipart(Req) -> - case cowboy_req:part(Req) of - {ok, _Headers, Req2} -> - {ok, _Body, Req3} = cowboy_req:part_body(Req2), - multipart(Req3); - {done, Req2} -> - Req2 - end. -]]></script> - -<p>Parts do not have a size limit. When a part body is too big, Cowboy will return what it read so far and allow you to continue if you wish to do so.</p> - -<p>The function <code>cow_multipart:form_data/1</code> can be used to quickly obtain information about a part from a <code>multipart/form-data</code> message. This function will tell you if the part is for a normal field or if it is a file being uploaded.</p> - -<p>This can be used for example to allow large part bodies for files but crash when a normal field is too large.</p> - -<script type="syntaxhighlighter" class="brush: erlang"><![CDATA[ -multipart(Req) -> - case cowboy_req:part(Req) of - {ok, Headers, Req2} -> - Req4 = case cow_multipart:form_data(Headers) of - {data, _FieldName} -> - {ok, _Body, Req3} = cowboy_req:part_body(Req2), - Req3; - {file, _FieldName, _Filename, _CType, _CTransferEncoding} -> - stream_file(Req2) - end, - multipart(Req4); - {done, Req2} -> - Req2 - end. - -stream_file(Req) -> - case cowboy_req:part_body(Req) of - {ok, _Body, Req2} -> - Req2; - {more, _Body, Req2} -> - stream_file(Req2) - end. -]]></script> - -<p>By default the body chunk Cowboy will return is limited to 8MB. This can of course be overriden. Both functions can take a second argument, the same list of options that will be passed to <code>cowboy_req:body/2</code> function.</p> - -<h2 id="skipping_unwanted_parts">Skipping unwanted parts</h2> - -<p>If you do not want to read a part's body, you can skip it. Skipping is easy. If you do not call the function to read the part's body, Cowboy will automatically skip it when you request the next part.</p> - -<p>The following snippet reads all part headers and skips all bodies:</p> - -<script type="syntaxhighlighter" class="brush: erlang"><![CDATA[ -multipart(Req) -> - case cowboy_req:part(Req) of - {ok, _Headers, Req2} -> - multipart(Req2); - {done, Req2} -> - Req2 - end. -]]></script> - -<p>Similarly, if you start reading the body and it ends up being too big, you can simply continue with the next part, Cowboy will automatically skip what remains.</p> - -<p>Note that the skipping rate may not be adequate for your application. If you observe poor performance when skipping, you might want to consider manually skipping by calling the <code>cowboy_req:part_body/1</code> function directly.</p> - -<p>And if you started reading the message but decide that you do not need the remaining parts, you can simply stop reading entirely and Cowboy will automatically figure out what to do.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/manual/">Function Reference</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/guide/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/guide/"><strong>HEAD</strong></a></li> - -</ul> - -</div> -</div> -</div> -</div> - - - <footer> - <div class="container"> - <div class="row"> - <div class="span6"> - <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> - <nav> - <ul> - <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> - </ul> - </nav> - </div> - <div class="span6 credits"> - <p><img src="/img/footer_logo.png"></p> - <p>Copyright © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script> - <script src="/js/bootstrap-carousel.js"></script> - <script src="/js/bootstrap-dropdown.js"></script> - <script src="/js/custom.js"></script> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> |