doc/html/group__client.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.12"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>libwebsockets: Client</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="resize.js"></script>
  14 <script type="text/javascript" src="navtreedata.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18 </script>
  19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  20 </head>
  21 <body>
  22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23 <div id="titlearea">
  24 <table cellspacing="0" cellpadding="0">
  25  <tbody>
  26  <tr style="height: 56px;">
  27   <td id="projectlogo"><img alt="Logo" src="libwebsockets.org-logo.png"/></td>
  28   <td id="projectalign" style="padding-left: 0.5em;">
  29    <div id="projectname">libwebsockets
  30    </div>
  31    <div id="projectbrief">Lightweight C library for HTML5 websockets</div>
  32   </td>
  33  </tr>
  34  </tbody>
  35 </table>
  36 </div>
  37 <!-- end header part -->
  38 <!-- Generated by Doxygen 1.8.12 -->
  39 <script type="text/javascript" src="menudata.js"></script>
  40 <script type="text/javascript" src="menu.js"></script>
  41 <script type="text/javascript">
  42 $(function() {
  43   initMenu('',false,false,'search.php','Search');
  44 });
  45 </script>
  46 <div id="main-nav"></div>
  47 </div><!-- top -->
  48 <div id="side-nav" class="ui-resizable side-nav-resizable">
  49   <div id="nav-tree">
  50     <div id="nav-tree-contents">
  51       <div id="nav-sync" class="sync"></div>
  52     </div>
  53   </div>
  54   <div id="splitbar" style="-moz-user-select:none;"
  55        class="ui-resizable-handle">
  56   </div>
  57 </div>
  58 <script type="text/javascript">
  59 $(document).ready(function(){initNavTree('group__client.html','');});
  60 </script>
  61 <div id="doc-content">
  62 <div class="header">
  63   <div class="summary">
  64 <a href="#nested-classes">Data Structures</a> &#124;
  65 <a href="#enum-members">Enumerations</a> &#124;
  66 <a href="#func-members">Functions</a>  </div>
  67   <div class="headertitle">
  68 <div class="title">Client</div>  </div>
  69 </div><!--header-->
  70 <div class="contents">
  71 <table class="memberdecls">
  72 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  73 Data Structures</h2></td></tr>
  74 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__client__connect__info.html">lws_client_connect_info</a></td></tr>
  75 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 </table><table class="memberdecls">
  77 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  78 Enumerations</h2></td></tr>
  79 <tr class="memitem:ga96f3dbad54b2853969cfa933d66871ce"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#ga96f3dbad54b2853969cfa933d66871ce">lws_client_connect_ssl_connection_flags</a> { <b>LCCSCF_USE_SSL</b> = (1 &lt;&lt; 0),
  80 <b>LCCSCF_ALLOW_SELFSIGNED</b> = (1 &lt;&lt; 1),
  81 <b>LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK</b> = (1 &lt;&lt; 2),
  82 <b>LCCSCF_ALLOW_EXPIRED</b> = (1 &lt;&lt; 3)
  83  }</td></tr>
  84 <tr class="separator:ga96f3dbad54b2853969cfa933d66871ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 </table><table class="memberdecls">
  86 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  87 Functions</h2></td></tr>
  88 <tr class="memitem:ga0c966136905f467816307cfba6deb5fd"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN struct lws *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#ga0c966136905f467816307cfba6deb5fd">lws_client_connect_via_info</a> (struct <a class="el" href="structlws__client__connect__info.html">lws_client_connect_info</a> *ccinfo)</td></tr>
  89 <tr class="separator:ga0c966136905f467816307cfba6deb5fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:ga4af0a20108a95e8b6d94dd4d80055ff3"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN struct lws *LWS_WARN_UNUSED_RESULT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#ga4af0a20108a95e8b6d94dd4d80055ff3">lws_client_connect</a> (struct lws_context *clients, const char *address, int port, int ssl_connection, const char *path, const char *host, const char *origin, const char *protocol, int ietf_version_or_minus_one) LWS_WARN_DEPRECATED</td></tr>
  91 <tr class="separator:ga4af0a20108a95e8b6d94dd4d80055ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:gac6a8558b4410961a880241c2ac1271e2"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN struct lws *LWS_WARN_UNUSED_RESULT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#gac6a8558b4410961a880241c2ac1271e2">lws_client_connect_extended</a> (struct lws_context *clients, const char *address, int port, int ssl_connection, const char *path, const char *host, const char *origin, const char *protocol, int ietf_version_or_minus_one, void *userdata) LWS_WARN_DEPRECATED</td></tr>
  93 <tr class="separator:gac6a8558b4410961a880241c2ac1271e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:ga4f44b8230e6732816ca5cd8d1aaaf340"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#ga4f44b8230e6732816ca5cd8d1aaaf340">lws_init_vhost_client_ssl</a> (const struct <a class="el" href="structlws__context__creation__info.html">lws_context_creation_info</a> *info, struct lws_vhost *vhost)</td></tr>
  95 <tr class="separator:ga4f44b8230e6732816ca5cd8d1aaaf340"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 <tr class="memitem:ga4450c34200bf9dab3beb90ef23221870"><td class="memItemLeft" align="right" valign="top"><a id="ga4450c34200bf9dab3beb90ef23221870"></a>
  97 LWS_VISIBLE LWS_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><b>lws_http_client_read</b> (struct lws *wsi, char **buf, int *len)</td></tr>
  98 <tr class="separator:ga4450c34200bf9dab3beb90ef23221870"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99 <tr class="memitem:ga715efffc0c4e8fbf72a4293008eb2187"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#ga715efffc0c4e8fbf72a4293008eb2187">lws_http_client_http_response</a> (struct lws *wsi)</td></tr>
 100 <tr class="separator:ga715efffc0c4e8fbf72a4293008eb2187"><td class="memSeparator" colspan="2">&#160;</td></tr>
 101 <tr class="memitem:ga26588fb345083076c14169dd5859f57a"><td class="memItemLeft" align="right" valign="top"><a id="ga26588fb345083076c14169dd5859f57a"></a>
 102 LWS_VISIBLE LWS_EXTERN void&#160;</td><td class="memItemRight" valign="bottom"><b>lws_client_http_body_pending</b> (struct lws *wsi, int something_left_to_send)</td></tr>
 103 <tr class="separator:ga26588fb345083076c14169dd5859f57a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 104 </table>
 105 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 106 <h2>Client releated functions</h2>
 107 <h2 class="groupheader">Enumeration Type Documentation</h2>
 108 <a id="ga96f3dbad54b2853969cfa933d66871ce"></a>
 109 <h2 class="memtitle"><span class="permalink"><a href="#ga96f3dbad54b2853969cfa933d66871ce">&sect;&nbsp;</a></span>lws_client_connect_ssl_connection_flags</h2>
 110
 111 <div class="memitem">
 112 <div class="memproto">
 113       <table class="memname">
 114         <tr>
 115           <td class="memname">enum <a class="el" href="group__client.html#ga96f3dbad54b2853969cfa933d66871ce">lws_client_connect_ssl_connection_flags</a></td>
 116         </tr>
 117       </table>
 118 </div><div class="memdoc">
 119
 120 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 121 <p>enum lws_client_connect_ssl_connection_flags - flags that may be used with struct <a class="el" href="structlws__client__connect__info.html">lws_client_connect_info</a> ssl_connection member to control if and how SSL checks apply to the client connection being created </p>
 122 <div class="fragment"><div class="line"><a name="l02039"></a><span class="lineno"> 2039</span>&#160;                                             {</div><div class="line"><a name="l02040"></a><span class="lineno"> 2040</span>&#160;        LCCSCF_USE_SSL                          = (1 &lt;&lt; 0),</div><div class="line"><a name="l02041"></a><span class="lineno"> 2041</span>&#160;        LCCSCF_ALLOW_SELFSIGNED                 = (1 &lt;&lt; 1),</div><div class="line"><a name="l02042"></a><span class="lineno"> 2042</span>&#160;        LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK  = (1 &lt;&lt; 2),</div><div class="line"><a name="l02043"></a><span class="lineno"> 2043</span>&#160;        LCCSCF_ALLOW_EXPIRED                    = (1 &lt;&lt; 3)</div><div class="line"><a name="l02044"></a><span class="lineno"> 2044</span>&#160;};</div></div><!-- fragment -->
 123 </div>
 124 </div>
 125 <h2 class="groupheader">Function Documentation</h2>
 126 <a id="ga4af0a20108a95e8b6d94dd4d80055ff3"></a>
 127 <h2 class="memtitle"><span class="permalink"><a href="#ga4af0a20108a95e8b6d94dd4d80055ff3">&sect;&nbsp;</a></span>lws_client_connect()</h2>
 128
 129 <div class="memitem">
 130 <div class="memproto">
 131       <table class="memname">
 132         <tr>
 133           <td class="memname">LWS_VISIBLE LWS_EXTERN struct lws* LWS_WARN_UNUSED_RESULT lws_client_connect </td>
 134           <td>(</td>
 135           <td class="paramtype">struct lws_context *&#160;</td>
 136           <td class="paramname"><em>clients</em>, </td>
 137         </tr>
 138         <tr>
 139           <td class="paramkey"></td>
 140           <td></td>
 141           <td class="paramtype">const char *&#160;</td>
 142           <td class="paramname"><em>address</em>, </td>
 143         </tr>
 144         <tr>
 145           <td class="paramkey"></td>
 146           <td></td>
 147           <td class="paramtype">int&#160;</td>
 148           <td class="paramname"><em>port</em>, </td>
 149         </tr>
 150         <tr>
 151           <td class="paramkey"></td>
 152           <td></td>
 153           <td class="paramtype">int&#160;</td>
 154           <td class="paramname"><em>ssl_connection</em>, </td>
 155         </tr>
 156         <tr>
 157           <td class="paramkey"></td>
 158           <td></td>
 159           <td class="paramtype">const char *&#160;</td>
 160           <td class="paramname"><em>path</em>, </td>
 161         </tr>
 162         <tr>
 163           <td class="paramkey"></td>
 164           <td></td>
 165           <td class="paramtype">const char *&#160;</td>
 166           <td class="paramname"><em>host</em>, </td>
 167         </tr>
 168         <tr>
 169           <td class="paramkey"></td>
 170           <td></td>
 171           <td class="paramtype">const char *&#160;</td>
 172           <td class="paramname"><em>origin</em>, </td>
 173         </tr>
 174         <tr>
 175           <td class="paramkey"></td>
 176           <td></td>
 177           <td class="paramtype">const char *&#160;</td>
 178           <td class="paramname"><em>protocol</em>, </td>
 179         </tr>
 180         <tr>
 181           <td class="paramkey"></td>
 182           <td></td>
 183           <td class="paramtype">int&#160;</td>
 184           <td class="paramname"><em>ietf_version_or_minus_one</em>&#160;</td>
 185         </tr>
 186         <tr>
 187           <td></td>
 188           <td>)</td>
 189           <td></td><td></td>
 190         </tr>
 191       </table>
 192 </div><div class="memdoc">
 193
 194 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 195 <p><a class="el" href="group__client.html#ga4af0a20108a95e8b6d94dd4d80055ff3">lws_client_connect()</a> - Connect to another websocket server </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>DEPRECATED use lws_client_connect_via_info </dd></dl>
 196 <dl class="params"><dt>Parameters</dt><dd>
 197   <table class="params">
 198     <tr><td class="paramname">clients</td><td>Websocket context </td></tr>
 199     <tr><td class="paramname">address</td><td>Remote server address, eg, "myserver.com" </td></tr>
 200     <tr><td class="paramname">port</td><td>Port to connect to on the remote server, eg, 80 </td></tr>
 201     <tr><td class="paramname">ssl_connection</td><td>0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self signed certs </td></tr>
 202     <tr><td class="paramname">path</td><td>Websocket path on server </td></tr>
 203     <tr><td class="paramname">host</td><td>Hostname on server </td></tr>
 204     <tr><td class="paramname">origin</td><td>Socket origin name </td></tr>
 205     <tr><td class="paramname">protocol</td><td>Comma-separated list of protocols being asked for from the server, or just one. The server will pick the one it likes best. If you don't want to specify a protocol, which is legal, use NULL here. </td></tr>
 206     <tr><td class="paramname">ietf_version_or_minus_one</td><td>-1 to ask to connect using the default, latest protocol supported, or the specific protocol ordinal</td></tr>
 207   </table>
 208   </dd>
 209 </dl>
 210 <p>This function creates a connection to a remote server </p>
 211
 212 </div>
 213 </div>
 214 <a id="gac6a8558b4410961a880241c2ac1271e2"></a>
 215 <h2 class="memtitle"><span class="permalink"><a href="#gac6a8558b4410961a880241c2ac1271e2">&sect;&nbsp;</a></span>lws_client_connect_extended()</h2>
 216
 217 <div class="memitem">
 218 <div class="memproto">
 219       <table class="memname">
 220         <tr>
 221           <td class="memname">LWS_VISIBLE LWS_EXTERN struct lws* LWS_WARN_UNUSED_RESULT lws_client_connect_extended </td>
 222           <td>(</td>
 223           <td class="paramtype">struct lws_context *&#160;</td>
 224           <td class="paramname"><em>clients</em>, </td>
 225         </tr>
 226         <tr>
 227           <td class="paramkey"></td>
 228           <td></td>
 229           <td class="paramtype">const char *&#160;</td>
 230           <td class="paramname"><em>address</em>, </td>
 231         </tr>
 232         <tr>
 233           <td class="paramkey"></td>
 234           <td></td>
 235           <td class="paramtype">int&#160;</td>
 236           <td class="paramname"><em>port</em>, </td>
 237         </tr>
 238         <tr>
 239           <td class="paramkey"></td>
 240           <td></td>
 241           <td class="paramtype">int&#160;</td>
 242           <td class="paramname"><em>ssl_connection</em>, </td>
 243         </tr>
 244         <tr>
 245           <td class="paramkey"></td>
 246           <td></td>
 247           <td class="paramtype">const char *&#160;</td>
 248           <td class="paramname"><em>path</em>, </td>
 249         </tr>
 250         <tr>
 251           <td class="paramkey"></td>
 252           <td></td>
 253           <td class="paramtype">const char *&#160;</td>
 254           <td class="paramname"><em>host</em>, </td>
 255         </tr>
 256         <tr>
 257           <td class="paramkey"></td>
 258           <td></td>
 259           <td class="paramtype">const char *&#160;</td>
 260           <td class="paramname"><em>origin</em>, </td>
 261         </tr>
 262         <tr>
 263           <td class="paramkey"></td>
 264           <td></td>
 265           <td class="paramtype">const char *&#160;</td>
 266           <td class="paramname"><em>protocol</em>, </td>
 267         </tr>
 268         <tr>
 269           <td class="paramkey"></td>
 270           <td></td>
 271           <td class="paramtype">int&#160;</td>
 272           <td class="paramname"><em>ietf_version_or_minus_one</em>, </td>
 273         </tr>
 274         <tr>
 275           <td class="paramkey"></td>
 276           <td></td>
 277           <td class="paramtype">void *&#160;</td>
 278           <td class="paramname"><em>userdata</em>&#160;</td>
 279         </tr>
 280         <tr>
 281           <td></td>
 282           <td>)</td>
 283           <td></td><td></td>
 284         </tr>
 285       </table>
 286 </div><div class="memdoc">
 287
 288 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 289 <p><a class="el" href="group__client.html#gac6a8558b4410961a880241c2ac1271e2">lws_client_connect_extended()</a> - Connect to another websocket server </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>DEPRECATED use lws_client_connect_via_info </dd></dl>
 290 <dl class="params"><dt>Parameters</dt><dd>
 291   <table class="params">
 292     <tr><td class="paramname">clients</td><td>Websocket context </td></tr>
 293     <tr><td class="paramname">address</td><td>Remote server address, eg, "myserver.com" </td></tr>
 294     <tr><td class="paramname">port</td><td>Port to connect to on the remote server, eg, 80 </td></tr>
 295     <tr><td class="paramname">ssl_connection</td><td>0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self signed certs </td></tr>
 296     <tr><td class="paramname">path</td><td>Websocket path on server </td></tr>
 297     <tr><td class="paramname">host</td><td>Hostname on server </td></tr>
 298     <tr><td class="paramname">origin</td><td>Socket origin name </td></tr>
 299     <tr><td class="paramname">protocol</td><td>Comma-separated list of protocols being asked for from the server, or just one. The server will pick the one it likes best. </td></tr>
 300     <tr><td class="paramname">ietf_version_or_minus_one</td><td>-1 to ask to connect using the default, latest protocol supported, or the specific protocol ordinal </td></tr>
 301     <tr><td class="paramname">userdata</td><td>Pre-allocated user data <pre class="fragment"> This function creates a connection to a remote server</pre> </td></tr>
 302   </table>
 303   </dd>
 304 </dl>
 305
 306 </div>
 307 </div>
 308 <a id="ga0c966136905f467816307cfba6deb5fd"></a>
 309 <h2 class="memtitle"><span class="permalink"><a href="#ga0c966136905f467816307cfba6deb5fd">&sect;&nbsp;</a></span>lws_client_connect_via_info()</h2>
 310
 311 <div class="memitem">
 312 <div class="memproto">
 313       <table class="memname">
 314         <tr>
 315           <td class="memname">LWS_VISIBLE LWS_EXTERN struct lws* lws_client_connect_via_info </td>
 316           <td>(</td>
 317           <td class="paramtype">struct <a class="el" href="structlws__client__connect__info.html">lws_client_connect_info</a> *&#160;</td>
 318           <td class="paramname"><em>ccinfo</em></td><td>)</td>
 319           <td></td>
 320         </tr>
 321       </table>
 322 </div><div class="memdoc">
 323
 324 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 325 <p><a class="el" href="group__client.html#ga0c966136905f467816307cfba6deb5fd">lws_client_connect_via_info()</a> - Connect to another websocket server </p><dl class="params"><dt>Parameters</dt><dd>
 326   <table class="params">
 327     <tr><td class="paramname">ccinfo</td><td>pointer to <a class="el" href="structlws__client__connect__info.html">lws_client_connect_info</a> struct <pre class="fragment"> This function creates a connection to a remote server using the
 328  information provided in ccinfo.</pre> </td></tr>
 329   </table>
 330   </dd>
 331 </dl>
 332
 333 </div>
 334 </div>
 335 <a id="ga715efffc0c4e8fbf72a4293008eb2187"></a>
 336 <h2 class="memtitle"><span class="permalink"><a href="#ga715efffc0c4e8fbf72a4293008eb2187">&sect;&nbsp;</a></span>lws_http_client_http_response()</h2>
 337
 338 <div class="memitem">
 339 <div class="memproto">
 340       <table class="memname">
 341         <tr>
 342           <td class="memname">LWS_VISIBLE LWS_EXTERN unsigned int lws_http_client_http_response </td>
 343           <td>(</td>
 344           <td class="paramtype">struct lws *&#160;</td>
 345           <td class="paramname"><em>wsi</em></td><td>)</td>
 346           <td></td>
 347         </tr>
 348       </table>
 349 </div><div class="memdoc">
 350
 351 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 352 <p><a class="el" href="group__client.html#ga715efffc0c4e8fbf72a4293008eb2187">lws_http_client_http_response()</a> - get last HTTP response code</p>
 353 <dl class="params"><dt>Parameters</dt><dd>
 354   <table class="params">
 355     <tr><td class="paramname">wsi</td><td>client connection</td></tr>
 356   </table>
 357   </dd>
 358 </dl>
 359 <p>Returns the last server response code, eg, 200 for client http connections. </p>
 360
 361 </div>
 362 </div>
 363 <a id="ga4f44b8230e6732816ca5cd8d1aaaf340"></a>
 364 <h2 class="memtitle"><span class="permalink"><a href="#ga4f44b8230e6732816ca5cd8d1aaaf340">&sect;&nbsp;</a></span>lws_init_vhost_client_ssl()</h2>
 365
 366 <div class="memitem">
 367 <div class="memproto">
 368       <table class="memname">
 369         <tr>
 370           <td class="memname">LWS_VISIBLE LWS_EXTERN int lws_init_vhost_client_ssl </td>
 371           <td>(</td>
 372           <td class="paramtype">const struct <a class="el" href="structlws__context__creation__info.html">lws_context_creation_info</a> *&#160;</td>
 373           <td class="paramname"><em>info</em>, </td>
 374         </tr>
 375         <tr>
 376           <td class="paramkey"></td>
 377           <td></td>
 378           <td class="paramtype">struct lws_vhost *&#160;</td>
 379           <td class="paramname"><em>vhost</em>&#160;</td>
 380         </tr>
 381         <tr>
 382           <td></td>
 383           <td>)</td>
 384           <td></td><td></td>
 385         </tr>
 386       </table>
 387 </div><div class="memdoc">
 388
 389 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 390 <p><a class="el" href="group__client.html#ga4f44b8230e6732816ca5cd8d1aaaf340">lws_init_vhost_client_ssl()</a> - also enable client SSL on an existing vhost</p>
 391 <dl class="params"><dt>Parameters</dt><dd>
 392   <table class="params">
 393     <tr><td class="paramname">info</td><td>client ssl related info </td></tr>
 394     <tr><td class="paramname">vhost</td><td>which vhost to initialize client ssl operations on</td></tr>
 395   </table>
 396   </dd>
 397 </dl>
 398 <p>You only need to call this if you plan on using SSL client connections on the vhost. For non-SSL client connections, it's not necessary to call this.</p>
 399 <p>The following members of info are used during the call </p><pre class="fragment">  - options must have LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT set,
 400       otherwise the call does nothing
 401   - provided_client_ssl_ctx must be NULL to get a generated client
 402       ssl context, otherwise you can pass a prepared one in by setting it
 403   - ssl_cipher_list may be NULL or set to the client valid cipher list
 404   - ssl_ca_filepath may be NULL or client cert filepath
 405   - ssl_cert_filepath may be NULL or client cert filepath
 406   - ssl_private_key_filepath may be NULL or client cert private key
 407 </pre><p>You must create your vhost explicitly if you want to use this, so you have a pointer to the vhost. Create the context first with the option flag LWS_SERVER_OPTION_EXPLICIT_VHOSTS and then call <a class="el" href="group__context-and-vhost.html#ga0c54c667ccd9b8b3dddcd123ca72f87c">lws_create_vhost()</a> with the same info struct. </p>
 408
 409 </div>
 410 </div>
 411 </div><!-- contents -->
 412 </div><!-- doc-content -->
 413 <!-- start footer part -->
 414 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 415   <ul>
 416     <li class="footer">Generated by
 417     <a href="http://www.doxygen.org/index.html">
 418     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
 419   </ul>
 420 </div>
 421 </body>
 422 </html>