| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>lwIP: src/apps/http/altcp_proxyconnect.c File Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| </script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">lwIP |
|  <span id="projectnumber">2.1.2</span> |
| </div> |
| <div id="projectbrief">Lightweight IP stack</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| $(document).ready(function(){initNavTree('altcp__proxyconnect_8c.html','');}); |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#define-members">Macros</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">altcp_proxyconnect.c File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="textblock"><code>#include "<a class="el" href="altcp__proxyconnect_8h.html">lwip/apps/altcp_proxyconnect.h</a>"</code><br /> |
| <code>#include "<a class="el" href="altcp_8h.html">lwip/altcp.h</a>"</code><br /> |
| <code>#include "<a class="el" href="altcp__priv_8h.html">lwip/priv/altcp_priv.h</a>"</code><br /> |
| <code>#include "<a class="el" href="altcp__tcp_8h.html">lwip/altcp_tcp.h</a>"</code><br /> |
| <code>#include "<a class="el" href="altcp__tls_8h.html">lwip/altcp_tls.h</a>"</code><br /> |
| <code>#include "<a class="el" href="mem_8h.html">lwip/mem.h</a>"</code><br /> |
| <code>#include "<a class="el" href="init_8h.html">lwip/init.h</a>"</code><br /> |
| <code>#include <stdio.h></code><br /> |
| </div><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:a344227f22aa1b58f7ed737a2d4f4636f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="altcp__proxyconnect_8c.html#a344227f22aa1b58f7ed737a2d4f4636f">ALTCP_PROXYCONNECT_CLIENT_AGENT</a>   "lwIP/" LWIP_VERSION_STRING " (http://savannah.nongnu.org/projects/lwip)"</td></tr> |
| <tr class="separator:a344227f22aa1b58f7ed737a2d4f4636f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:ae774782064a92d0f58ce07b57a5360d1"><td class="memItemLeft" align="right" valign="top">struct altcp_pcb * </td><td class="memItemRight" valign="bottom"><a class="el" href="altcp__proxyconnect_8c.html#ae774782064a92d0f58ce07b57a5360d1">altcp_proxyconnect_new</a> (struct altcp_proxyconnect_config *config, struct altcp_pcb *inner_pcb)</td></tr> |
| <tr class="separator:ae774782064a92d0f58ce07b57a5360d1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a24e122d2bc2c0b9f86074c1e8d5ccfe4"><td class="memItemLeft" align="right" valign="top">struct altcp_pcb * </td><td class="memItemRight" valign="bottom"><a class="el" href="altcp__proxyconnect_8c.html#a24e122d2bc2c0b9f86074c1e8d5ccfe4">altcp_proxyconnect_new_tcp</a> (struct altcp_proxyconnect_config *config, u8_t ip_type)</td></tr> |
| <tr class="separator:a24e122d2bc2c0b9f86074c1e8d5ccfe4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3d3af45390467ceeaa064b7e28dd43a9"><td class="memItemLeft" align="right" valign="top">struct altcp_pcb * </td><td class="memItemRight" valign="bottom"><a class="el" href="altcp__proxyconnect_8c.html#a3d3af45390467ceeaa064b7e28dd43a9">altcp_proxyconnect_alloc</a> (void *arg, u8_t ip_type)</td></tr> |
| <tr class="separator:a3d3af45390467ceeaa064b7e28dd43a9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5ff49bcd035847a8915f18deef4172a9"><td class="memItemLeft" align="right" valign="top">struct altcp_pcb * </td><td class="memItemRight" valign="bottom"><a class="el" href="altcp__proxyconnect_8c.html#a5ff49bcd035847a8915f18deef4172a9">altcp_proxyconnect_tls_alloc</a> (void *arg, u8_t ip_type)</td></tr> |
| <tr class="separator:a5ff49bcd035847a8915f18deef4172a9"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Application layered TCP connection API that executes a proxy-connect.</p> |
| <p>This file provides a starting layer that executes a proxy-connect e.g. to set up TLS connections through a http proxy. </p> |
| </div><h2 class="groupheader">Macro Definition Documentation</h2> |
| <a id="a344227f22aa1b58f7ed737a2d4f4636f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a344227f22aa1b58f7ed737a2d4f4636f">◆ </a></span>ALTCP_PROXYCONNECT_CLIENT_AGENT</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define ALTCP_PROXYCONNECT_CLIENT_AGENT   "lwIP/" LWIP_VERSION_STRING " (http://savannah.nongnu.org/projects/lwip)"</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>This string is passed in the HTTP header as "User-Agent: " </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="a3d3af45390467ceeaa064b7e28dd43a9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3d3af45390467ceeaa064b7e28dd43a9">◆ </a></span>altcp_proxyconnect_alloc()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">struct altcp_pcb* altcp_proxyconnect_alloc </td> |
| <td>(</td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>arg</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">u8_t </td> |
| <td class="paramname"><em>ip_type</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Allocator function to allocate a proxy connect altcp pcb connecting directly via tcp to the proxy.</p> |
| <p>The returned pcb is a chain: altcp_proxyconnect - altcp_tcp - tcp pcb</p> |
| <p>This function is meant for use with <a class="el" href="group__altcp.html#ga86843287b0ad0099c067817cfb7aa336">altcp_new</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">arg</td><td>struct altcp_proxyconnect_config that contains the proxy settings </td></tr> |
| <tr><td class="paramname">ip_type</td><td>IP type of the connection (<a class="el" href="group__ipaddr.html#gaf2142f0dfdcc938e2db16aa745ed585c">lwip_ip_addr_type</a>) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ae774782064a92d0f58ce07b57a5360d1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae774782064a92d0f58ce07b57a5360d1">◆ </a></span>altcp_proxyconnect_new()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">struct altcp_pcb* altcp_proxyconnect_new </td> |
| <td>(</td> |
| <td class="paramtype">struct altcp_proxyconnect_config * </td> |
| <td class="paramname"><em>config</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">struct altcp_pcb * </td> |
| <td class="paramname"><em>inner_pcb</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Allocate a new altcp layer connecting through a proxy. This function gets the inner pcb passed.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">config</td><td>struct altcp_proxyconnect_config that contains the proxy settings </td></tr> |
| <tr><td class="paramname">inner_pcb</td><td>pcb that makes the connection to the proxy (i.e. tcp pcb) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a24e122d2bc2c0b9f86074c1e8d5ccfe4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a24e122d2bc2c0b9f86074c1e8d5ccfe4">◆ </a></span>altcp_proxyconnect_new_tcp()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">struct altcp_pcb* altcp_proxyconnect_new_tcp </td> |
| <td>(</td> |
| <td class="paramtype">struct altcp_proxyconnect_config * </td> |
| <td class="paramname"><em>config</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">u8_t </td> |
| <td class="paramname"><em>ip_type</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Allocate a new altcp layer connecting through a proxy. This function allocates the inner pcb as tcp pcb, resulting in a direct tcp connection to the proxy.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">config</td><td>struct altcp_proxyconnect_config that contains the proxy settings </td></tr> |
| <tr><td class="paramname">ip_type</td><td>IP type of the connection (<a class="el" href="group__ipaddr.html#gaf2142f0dfdcc938e2db16aa745ed585c">lwip_ip_addr_type</a>) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a5ff49bcd035847a8915f18deef4172a9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5ff49bcd035847a8915f18deef4172a9">◆ </a></span>altcp_proxyconnect_tls_alloc()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">struct altcp_pcb* altcp_proxyconnect_tls_alloc </td> |
| <td>(</td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>arg</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">u8_t </td> |
| <td class="paramname"><em>ip_type</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Allocator function to allocate a TLS connection through a proxy.</p> |
| <p>The returned pcb is a chain: altcp_tls - altcp_proxyconnect - altcp_tcp - tcp pcb</p> |
| <p>This function is meant for use with <a class="el" href="group__altcp.html#ga86843287b0ad0099c067817cfb7aa336">altcp_new</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">arg</td><td>struct altcp_proxyconnect_tls_config that contains the proxy settings and tls settings </td></tr> |
| <tr><td class="paramname">ip_type</td><td>IP type of the connection (<a class="el" href="group__ipaddr.html#gaf2142f0dfdcc938e2db16aa745ed585c">lwip_ip_addr_type</a>) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_53adf0b982dc8545998aae3f283a5a58.html">apps</a></li><li class="navelem"><a class="el" href="dir_34adf996f92d0eef72c45a7167a966e6.html">http</a></li><li class="navelem"><a class="el" href="altcp__proxyconnect_8c.html">altcp_proxyconnect.c</a></li> |
| <li class="footer">Generated by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |