summaryrefslogblamecommitdiffstats
path: root/docs/en/cowboy/2.10/manual/cowboy_req.push/index.html
blob: f835d94e4e1a4c707d3c72e5c7298ffb79543f2b (plain) (tree)
1
2
3
4
5
6
7
8
9








                                                                                           


                                                                                                                      
                                                   





                                                                                                      
               










































                                                                                                                                                                                   
                        
                                                      
                                      
                                                                                         


                                            















                                                                                                                                                                                                                                                                           
                                                                                                                                                              
                                                                                                          
                                  

                                            
     

                                
                                                              

            
                          
     

                                                                                   
     
     
                                        
                                                                             
                                  
                                                  
     
     
                                
                                                                  
                                                               


                                            




                                                                                                                                                                                                                                                                        
                                                               


                                            



                                                                                                                                                                                                                                                                        
                                

                                                                                                                                                                                                                                     











                           
            





                          
                                                                            

        
                                                                                     










                                 

                                                                       

                                                                       

                                                                       

                                                                     

                                                                     

                                                                     

                                                                     

     











                                                                                                                                                                   
                                                                                                                                                                                                                                  


 





























                                                                                                                                                                                                                           
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="">
    <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">

    <title>Nine Nines: cowboy_req:push(3)</title>

    <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
    <link href="/css/99s.css?r=7" rel="stylesheet">

    <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">

	</head>


<body class="">
  <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">
            
            <div id="side-header">
              <nav>
                <ul>
                  <li><a title="Hear my thoughts" href="/articles">Articles</a></li>
  				  <li><a title="Watch my talks" href="/talks">Talks</a></li>
  				  <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
  				  <li><a title="Request my services" href="/services">Consulting & Training</a></li>
                </ul>
              </nav> 
              <ul id="social">
                <li>
                  <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
                </li>
                    <li>
						<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></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>cowboy_req:push(3)</span></h1>

<h2 id="_name">Name</h2>
<p>cowboy_req:push - Push a resource to the client</p>
<h2 id="_description">Description</h2>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">push</font></b>(<font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>())
    <font color="#990000">-&gt;</font> <b><font color="#000000">push</font></b>(<font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font>, #{})

<b><font color="#000000">push</font></b>(<font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>(), <font color="#009900">Opts</font>)
    <font color="#990000">-&gt;</font> <font color="#FF6600">ok</font>

<font color="#009900">Path</font>    <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()                <i><font color="#9A1900">%% case sensitive</font></i>
<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_headers</font></b>()
<font color="#009900">Opts</font>    <font color="#990000">::</font> <b><font color="#000000">cowboy_req:push_opts</font></b>()</tt></pre>
</div></div>
<p>Push a resource to the client.</p>
<p>Cowboy handles push requests the same way as if they came from the client, including the creation of a request handling process, routing and middlewares and so on.</p>
<p>This function does nothing when the HTTP/1.1 protocol is used. You may call it safely without first checking whether the connection uses HTTP/2.</p>
<p>The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p>
<p>Note that the headers must be the headers the client is expected to send if it were to perform the request. They are therefore request headers, and not response headers.</p>
<p>By default, Cowboy will use the GET method, an empty query string, and take the scheme, host and port directly from the current request&apos;s URI. You can override them by passing options.</p>
<p>Note that clients may cancel the push or ignore it entirely. For example browsers may ignore the resource when the connection is not considered secure.</p>
<p>It is not possible to push resources after sending a response. Any attempt will result in an error.</p>
<h2 id="_arguments">Arguments</h2>
<dl><dt>Path</dt>
<dd><p>The status code for the response.</p>
</dd>
<dt>Headers</dt>
<dd><p>The response headers.</p>
<p>Header names must be given as lowercase binary strings.</p>
</dd>
<dt>Req</dt>
<dd><p>The Req object.</p>
</dd>
<dt>Opts</dt>
<dd><p>Customize the HTTP method or the URI scheme, host, port or query string.</p>
</dd>
</dl>
<h2 id="_return_value">Return value</h2>
<p>The atom <code>ok</code> is always returned. It can be safely ignored.</p>
<h2 id="_changelog">Changelog</h2>
<ul><li><strong>2.0</strong>: Function introduced.
</li>
</ul>
<h2 id="_examples">Examples</h2>
<div class="listingblock"><div class="title">Push a resource</div>
<div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">cowboy_req:push</font></b>(<font color="#FF0000">"/static/style.css"</font>, #{
    <font color="#990000">&lt;&lt;</font><font color="#FF0000">"accept"</font><font color="#990000">&gt;&gt;</font> <font color="#990000">=&gt;</font> <font color="#990000">&lt;&lt;</font><font color="#FF0000">"text/css"</font><font color="#990000">&gt;&gt;</font>
}, <font color="#009900">Req</font>),</tt></pre>
</div></div>
<div class="listingblock"><div class="title">Push a resource with a custom host</div>
<div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">cowboy_req:push</font></b>(<font color="#FF0000">"/static/style.css"</font>, #{
    <font color="#990000">&lt;&lt;</font><font color="#FF0000">"accept"</font><font color="#990000">&gt;&gt;</font> <font color="#990000">=&gt;</font> <font color="#990000">&lt;&lt;</font><font color="#FF0000">"text/css"</font><font color="#990000">&gt;&gt;</font>
}, #{<font color="#0000FF">host</font> <font color="#990000">=&gt;</font> <font color="#990000">&lt;&lt;</font><font color="#FF0000">"cdn.example.org"</font><font color="#990000">&gt;&gt;</font>}, <font color="#009900">Req</font>),</tt></pre>
</div></div>
<h2 id="_see_also">See also</h2>
<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.inform">cowboy_req:inform(3)</a>, <a href="../cowboy_req.reply">cowboy_req:reply(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a></p>






</div>

<div class="span3 sidecol">


<h3>
	Cowboy
	2.10
	Function Reference
	
</h3>

<ul>
	
		<li><a href="/docs/en/cowboy/2.10/guide">User Guide</a></li>
	
	
		<li><a href="/docs/en/cowboy/2.10/manual">Function Reference</a></li>
	
	
</ul>

<h4 id="docs-nav">Navigation</h4>

<h4>Version select</h4>
<ul>
	
	
	
		<li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li>
	
		<li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li>
	
		<li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li>
	
		<li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li>
	
		<li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li>
	
		<li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li>
	
		<li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li>
	
</ul>

<h3 id="_like_my_work__donate">Like my work? Donate!</h3>
<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline">
<input type="hidden" name="cmd" value="_donations">
<input type="hidden" name="business" value="[email protected]">
<input type="hidden" name="lc" value="FR">
<input type="hidden" name="item_name" value="Loic Hoguin">
<input type="hidden" name="item_number" value="99s">
<input type="hidden" name="currency_code" value="EUR">
<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1">
</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p>



</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 &copy; Loïc Hoguin 2012-2018</p>
            </div>
          </div>
        </div>
      </footer>

    
    <script src="/js/custom.js"></script>
  </body>
</html>