Home Explore Help
Sign In
SoftwareDesign
/
csu3_am335x
8
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: d7a5bbbc4f
Branches Tags
csu3_am335x
/
EVSE
/
GPL
/
libwebsockets-v2.1-stable
/
doc
/
html
/
group__client.html

group__client.html 20 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.11"/>
    7. 

  7. <title>libwebsockets: Client</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    12. 

  12. <script type="text/javascript" src="resize.js"></script>
    13. 

  13. <script type="text/javascript" src="navtreedata.js"></script>
    14. 

  14. <script type="text/javascript" src="navtree.js"></script>
    15. 

  15. <script type="text/javascript">
    16. 

  16.   $(document).ready(initResizable);
    17. 

  17.   $(window).load(resizeHeight);
    18. 

  18. </script>
    19. 

  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    20. 

  20. </head>
    21. 

  21. <body>
    22. 

  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    23. 

  23. <div id="titlearea">
    24. 

  24. <table cellspacing="0" cellpadding="0">
    25. 

  25.  <tbody>
    26. 

  26.  <tr style="height: 56px;">
    27. 

  27.   <td id="projectlogo"><img alt="Logo" src="libwebsockets.org-logo.png"/></td>
    28. 

  28.   <td id="projectalign" style="padding-left: 0.5em;">
    29. 

  29.    <div id="projectname">libwebsockets
    30. 

  30.    </div>
    31. 

  31.    <div id="projectbrief">Lightweight C library for HTML5 websockets</div>
    32. 

  32.   </td>
    33. 

  33.  </tr>
    34. 

  34.  </tbody>
    35. 

  35. </table>
    36. 

  36. </div>
    37. 

  37. <!-- end header part -->
    38. 

  38. <!-- Generated by Doxygen 1.8.11 -->
    39. 

  39.   <div id="navrow1" class="tabs">
    40. 

  40.     <ul class="tablist">
    41. 

  41.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    42. 

  42.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    43. 

  43.       <li class="current"><a href="modules.html"><span>Modules</span></a></li>
    44. 

  44.       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    45. 

  45.       <li><a href="files.html"><span>Files</span></a></li>
    46. 

  46.     </ul>
    47. 

  47.   </div>
    48. 

  48. </div><!-- top -->
    49. 

  49. <div id="side-nav" class="ui-resizable side-nav-resizable">
    50. 

  50.   <div id="nav-tree">
    51. 

  51.     <div id="nav-tree-contents">
    52. 

  52.       <div id="nav-sync" class="sync"></div>
    53. 

  53.     </div>
    54. 

  54.   </div>
    55. 

  55.   <div id="splitbar" style="-moz-user-select:none;" 
    56. 

  56.        class="ui-resizable-handle">
    57. 

  57.   </div>
    58. 

  58. </div>
    59. 

  59. <script type="text/javascript">
    60. 

  60. $(document).ready(function(){initNavTree('group__client.html','');});
    61. 

  61. </script>
    62. 

  62. <div id="doc-content">
    63. 

  63. <div class="header">
    64. 

  64.   <div class="summary">
    65. 

  65. <a href="#nested-classes">Data Structures</a> &#124;
    66. 

  66. <a href="#enum-members">Enumerations</a> &#124;
    67. 

  67. <a href="#func-members">Functions</a>  </div>
    68. 

  68.   <div class="headertitle">
    69. 

  69. <div class="title">Client</div>  </div>
    70. 

  70. </div><!--header-->
    71. 

  71. <div class="contents">
    72. 

  72. <table class="memberdecls">
    73. 

  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
    74. 

  74. Data Structures</h2></td></tr>
    75. 

  75. <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>
    76. 

  76. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
    77. 

  77. </table><table class="memberdecls">
    78. 

  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
    79. 

  79. Enumerations</h2></td></tr>
    80. 

  80. <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), 
    81. 

  81. <b>LCCSCF_ALLOW_SELFSIGNED</b> = (1 &lt;&lt; 1), 
    82. 

  82. <b>LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK</b> = (1 &lt;&lt; 2)
    83. 

  83.  }</td></tr>
    84. 

  84. <tr class="separator:ga96f3dbad54b2853969cfa933d66871ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
    85. 

  85. </table><table class="memberdecls">
    86. 

  86. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    87. 

  87. Functions</h2></td></tr>
    88. 

  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. 

  89. <tr class="separator:ga0c966136905f467816307cfba6deb5fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
    90. 

  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. 

  91. <tr class="separator:ga4af0a20108a95e8b6d94dd4d80055ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    92. 

  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. 

  93. <tr class="separator:gac6a8558b4410961a880241c2ac1271e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    94. 

  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. 

  95. <tr class="separator:ga4f44b8230e6732816ca5cd8d1aaaf340"><td class="memSeparator" colspan="2">&#160;</td></tr>
    96. 

  96. <tr class="memitem:ga4450c34200bf9dab3beb90ef23221870"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4450c34200bf9dab3beb90ef23221870"></a>
    97. 

  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. 

  98. <tr class="separator:ga4450c34200bf9dab3beb90ef23221870"><td class="memSeparator" colspan="2">&#160;</td></tr>
    99. 

  99. <tr class="memitem:ga26588fb345083076c14169dd5859f57a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga26588fb345083076c14169dd5859f57a"></a>
    100. 

  100. 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>
    101. 

  101. <tr class="separator:ga26588fb345083076c14169dd5859f57a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    102. 

  102. </table>
    103. 

  103. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    104. 

  104. <h2>Client releated functions</h2>
    105. 

  105. <h2 class="groupheader">Enumeration Type Documentation</h2>
    106. 

  106. <a class="anchor" id="ga96f3dbad54b2853969cfa933d66871ce"></a>
    107. 

  107. <div class="memitem">
    108. 

  108. <div class="memproto">
    109. 

  109.       <table class="memname">
    110. 

  110.         <tr>
    111. 

  111.           <td class="memname">enum <a class="el" href="group__client.html#ga96f3dbad54b2853969cfa933d66871ce">lws_client_connect_ssl_connection_flags</a></td>
    112. 

  112.         </tr>
    113. 

  113.       </table>
    114. 

  114. </div><div class="memdoc">
    115. 

  115. 

  116. <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
    117. 

  117. <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>
    118. 

  118. <div class="fragment"><div class="line"><a name="l01975"></a><span class="lineno"> 1975</span>&#160;                                             {</div><div class="line"><a name="l01976"></a><span class="lineno"> 1976</span>&#160;        LCCSCF_USE_SSL                          = (1 &lt;&lt; 0),</div><div class="line"><a name="l01977"></a><span class="lineno"> 1977</span>&#160;        LCCSCF_ALLOW_SELFSIGNED                 = (1 &lt;&lt; 1),</div><div class="line"><a name="l01978"></a><span class="lineno"> 1978</span>&#160;        LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK  = (1 &lt;&lt; 2)</div><div class="line"><a name="l01979"></a><span class="lineno"> 1979</span>&#160;};</div></div><!-- fragment -->
    119. 

  119. </div>
    120. 

  120. </div>
    121. 

  121. <h2 class="groupheader">Function Documentation</h2>
    122. 

  122. <a class="anchor" id="ga4af0a20108a95e8b6d94dd4d80055ff3"></a>
    123. 

  123. <div class="memitem">
    124. 

  124. <div class="memproto">
    125. 

  125.       <table class="memname">
    126. 

  126.         <tr>
    127. 

  127.           <td class="memname">LWS_VISIBLE LWS_EXTERN struct lws* LWS_WARN_UNUSED_RESULT lws_client_connect </td>
    128. 

  128.           <td>(</td>
    129. 

  129.           <td class="paramtype">struct lws_context *&#160;</td>
    130. 

  130.           <td class="paramname"><em>clients</em>, </td>
    131. 

  131.         </tr>
    132. 

  132.         <tr>
    133. 

  133.           <td class="paramkey"></td>
    134. 

  134.           <td></td>
    135. 

  135.           <td class="paramtype">const char *&#160;</td>
    136. 

  136.           <td class="paramname"><em>address</em>, </td>
    137. 

  137.         </tr>
    138. 

  138.         <tr>
    139. 

  139.           <td class="paramkey"></td>
    140. 

  140.           <td></td>
    141. 

  141.           <td class="paramtype">int&#160;</td>
    142. 

  142.           <td class="paramname"><em>port</em>, </td>
    143. 

  143.         </tr>
    144. 

  144.         <tr>
    145. 

  145.           <td class="paramkey"></td>
    146. 

  146.           <td></td>
    147. 

  147.           <td class="paramtype">int&#160;</td>
    148. 

  148.           <td class="paramname"><em>ssl_connection</em>, </td>
    149. 

  149.         </tr>
    150. 

  150.         <tr>
    151. 

  151.           <td class="paramkey"></td>
    152. 

  152.           <td></td>
    153. 

  153.           <td class="paramtype">const char *&#160;</td>
    154. 

  154.           <td class="paramname"><em>path</em>, </td>
    155. 

  155.         </tr>
    156. 

  156.         <tr>
    157. 

  157.           <td class="paramkey"></td>
    158. 

  158.           <td></td>
    159. 

  159.           <td class="paramtype">const char *&#160;</td>
    160. 

  160.           <td class="paramname"><em>host</em>, </td>
    161. 

  161.         </tr>
    162. 

  162.         <tr>
    163. 

  163.           <td class="paramkey"></td>
    164. 

  164.           <td></td>
    165. 

  165.           <td class="paramtype">const char *&#160;</td>
    166. 

  166.           <td class="paramname"><em>origin</em>, </td>
    167. 

  167.         </tr>
    168. 

  168.         <tr>
    169. 

  169.           <td class="paramkey"></td>
    170. 

  170.           <td></td>
    171. 

  171.           <td class="paramtype">const char *&#160;</td>
    172. 

  172.           <td class="paramname"><em>protocol</em>, </td>
    173. 

  173.         </tr>
    174. 

  174.         <tr>
    175. 

  175.           <td class="paramkey"></td>
    176. 

  176.           <td></td>
    177. 

  177.           <td class="paramtype">int&#160;</td>
    178. 

  178.           <td class="paramname"><em>ietf_version_or_minus_one</em>&#160;</td>
    179. 

  179.         </tr>
    180. 

  180.         <tr>
    181. 

  181.           <td></td>
    182. 

  182.           <td>)</td>
    183. 

  183.           <td></td><td></td>
    184. 

  184.         </tr>
    185. 

  185.       </table>
    186. 

  186. </div><div class="memdoc">
    187. 

  187. 

  188. <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
    189. 

  189. <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>
    190. 

  190. <dl class="params"><dt>Parameters</dt><dd>
    191. 

  191.   <table class="params">
    192. 

  192.     <tr><td class="paramname">clients</td><td>Websocket context </td></tr>
    193. 

  193.     <tr><td class="paramname">address</td><td>Remote server address, eg, "myserver.com" </td></tr>
    194. 

  194.     <tr><td class="paramname">port</td><td>Port to connect to on the remote server, eg, 80 </td></tr>
    195. 

  195.     <tr><td class="paramname">ssl_connection</td><td>0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self signed certs </td></tr>
    196. 

  196.     <tr><td class="paramname">path</td><td>Websocket path on server </td></tr>
    197. 

  197.     <tr><td class="paramname">host</td><td>Hostname on server </td></tr>
    198. 

  198.     <tr><td class="paramname">origin</td><td>Socket origin name </td></tr>
    199. 

  199.     <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>
    200. 

  200.     <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>
    201. 

  201.   </table>
    202. 

  202.   </dd>
    203. 

  203. </dl>
    204. 

  204. <p>This function creates a connection to a remote server </p>
    205. 

  205. 

  206. </div>
    207. 

  207. </div>
    208. 

  208. <a class="anchor" id="gac6a8558b4410961a880241c2ac1271e2"></a>
    209. 

  209. <div class="memitem">
    210. 

  210. <div class="memproto">
    211. 

  211.       <table class="memname">
    212. 

  212.         <tr>
    213. 

  213.           <td class="memname">LWS_VISIBLE LWS_EXTERN struct lws* LWS_WARN_UNUSED_RESULT lws_client_connect_extended </td>
    214. 

  214.           <td>(</td>
    215. 

  215.           <td class="paramtype">struct lws_context *&#160;</td>
    216. 

  216.           <td class="paramname"><em>clients</em>, </td>
    217. 

  217.         </tr>
    218. 

  218.         <tr>
    219. 

  219.           <td class="paramkey"></td>
    220. 

  220.           <td></td>
    221. 

  221.           <td class="paramtype">const char *&#160;</td>
    222. 

  222.           <td class="paramname"><em>address</em>, </td>
    223. 

  223.         </tr>
    224. 

  224.         <tr>
    225. 

  225.           <td class="paramkey"></td>
    226. 

  226.           <td></td>
    227. 

  227.           <td class="paramtype">int&#160;</td>
    228. 

  228.           <td class="paramname"><em>port</em>, </td>
    229. 

  229.         </tr>
    230. 

  230.         <tr>
    231. 

  231.           <td class="paramkey"></td>
    232. 

  232.           <td></td>
    233. 

  233.           <td class="paramtype">int&#160;</td>
    234. 

  234.           <td class="paramname"><em>ssl_connection</em>, </td>
    235. 

  235.         </tr>
    236. 

  236.         <tr>
    237. 

  237.           <td class="paramkey"></td>
    238. 

  238.           <td></td>
    239. 

  239.           <td class="paramtype">const char *&#160;</td>
    240. 

  240.           <td class="paramname"><em>path</em>, </td>
    241. 

  241.         </tr>
    242. 

  242.         <tr>
    243. 

  243.           <td class="paramkey"></td>
    244. 

  244.           <td></td>
    245. 

  245.           <td class="paramtype">const char *&#160;</td>
    246. 

  246.           <td class="paramname"><em>host</em>, </td>
    247. 

  247.         </tr>
    248. 

  248.         <tr>
    249. 

  249.           <td class="paramkey"></td>
    250. 

  250.           <td></td>
    251. 

  251.           <td class="paramtype">const char *&#160;</td>
    252. 

  252.           <td class="paramname"><em>origin</em>, </td>
    253. 

  253.         </tr>
    254. 

  254.         <tr>
    255. 

  255.           <td class="paramkey"></td>
    256. 

  256.           <td></td>
    257. 

  257.           <td class="paramtype">const char *&#160;</td>
    258. 

  258.           <td class="paramname"><em>protocol</em>, </td>
    259. 

  259.         </tr>
    260. 

  260.         <tr>
    261. 

  261.           <td class="paramkey"></td>
    262. 

  262.           <td></td>
    263. 

  263.           <td class="paramtype">int&#160;</td>
    264. 

  264.           <td class="paramname"><em>ietf_version_or_minus_one</em>, </td>
    265. 

  265.         </tr>
    266. 

  266.         <tr>
    267. 

  267.           <td class="paramkey"></td>
    268. 

  268.           <td></td>
    269. 

  269.           <td class="paramtype">void *&#160;</td>
    270. 

  270.           <td class="paramname"><em>userdata</em>&#160;</td>
    271. 

  271.         </tr>
    272. 

  272.         <tr>
    273. 

  273.           <td></td>
    274. 

  274.           <td>)</td>
    275. 

  275.           <td></td><td></td>
    276. 

  276.         </tr>
    277. 

  277.       </table>
    278. 

  278. </div><div class="memdoc">
    279. 

  279. 

  280. <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
    281. 

  281. <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>
    282. 

  282. <dl class="params"><dt>Parameters</dt><dd>
    283. 

  283.   <table class="params">
    284. 

  284.     <tr><td class="paramname">clients</td><td>Websocket context </td></tr>
    285. 

  285.     <tr><td class="paramname">address</td><td>Remote server address, eg, "myserver.com" </td></tr>
    286. 

  286.     <tr><td class="paramname">port</td><td>Port to connect to on the remote server, eg, 80 </td></tr>
    287. 

  287.     <tr><td class="paramname">ssl_connection</td><td>0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self signed certs </td></tr>
    288. 

  288.     <tr><td class="paramname">path</td><td>Websocket path on server </td></tr>
    289. 

  289.     <tr><td class="paramname">host</td><td>Hostname on server </td></tr>
    290. 

  290.     <tr><td class="paramname">origin</td><td>Socket origin name </td></tr>
    291. 

  291.     <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>
    292. 

  292.     <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>
    293. 

  293.     <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>
    294. 

  294.   </table>
    295. 

  295.   </dd>
    296. 

  296. </dl>
    297. 

  297. 

  298. </div>
    299. 

  299. </div>
    300. 

  300. <a class="anchor" id="ga0c966136905f467816307cfba6deb5fd"></a>
    301. 

  301. <div class="memitem">
    302. 

  302. <div class="memproto">
    303. 

  303.       <table class="memname">
    304. 

  304.         <tr>
    305. 

  305.           <td class="memname">LWS_VISIBLE LWS_EXTERN struct lws* lws_client_connect_via_info </td>
    306. 

  306.           <td>(</td>
    307. 

  307.           <td class="paramtype">struct <a class="el" href="structlws__client__connect__info.html">lws_client_connect_info</a> *&#160;</td>
    308. 

  308.           <td class="paramname"><em>ccinfo</em></td><td>)</td>
    309. 

  309.           <td></td>
    310. 

  310.         </tr>
    311. 

  311.       </table>
    312. 

  312. </div><div class="memdoc">
    313. 

  313. 

  314. <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
    315. 

  315. <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>
    316. 

  316.   <table class="params">
    317. 

  317.     <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
    318. 

  318.  information provided in ccinfo.</pre> </td></tr>
    319. 

  319.   </table>
    320. 

  320.   </dd>
    321. 

  321. </dl>
    322. 

  322. 

  323. </div>
    324. 

  324. </div>
    325. 

  325. <a class="anchor" id="ga4f44b8230e6732816ca5cd8d1aaaf340"></a>
    326. 

  326. <div class="memitem">
    327. 

  327. <div class="memproto">
    328. 

  328.       <table class="memname">
    329. 

  329.         <tr>
    330. 

  330.           <td class="memname">LWS_VISIBLE LWS_EXTERN int lws_init_vhost_client_ssl </td>
    331. 

  331.           <td>(</td>
    332. 

  332.           <td class="paramtype">const struct <a class="el" href="structlws__context__creation__info.html">lws_context_creation_info</a> *&#160;</td>
    333. 

  333.           <td class="paramname"><em>info</em>, </td>
    334. 

  334.         </tr>
    335. 

  335.         <tr>
    336. 

  336.           <td class="paramkey"></td>
    337. 

  337.           <td></td>
    338. 

  338.           <td class="paramtype">struct lws_vhost *&#160;</td>
    339. 

  339.           <td class="paramname"><em>vhost</em>&#160;</td>
    340. 

  340.         </tr>
    341. 

  341.         <tr>
    342. 

  342.           <td></td>
    343. 

  343.           <td>)</td>
    344. 

  344.           <td></td><td></td>
    345. 

  345.         </tr>
    346. 

  346.       </table>
    347. 

  347. </div><div class="memdoc">
    348. 

  348. 

  349. <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
    350. 

  350. <p><a class="el" href="group__client.html#ga4f44b8230e6732816ca5cd8d1aaaf340">lws_init_vhost_client_ssl()</a> - also enable client SSL on an existing vhost</p>
    351. 

  351. <dl class="params"><dt>Parameters</dt><dd>
    352. 

  352.   <table class="params">
    353. 

  353.     <tr><td class="paramname">info</td><td>client ssl related info </td></tr>
    354. 

  354.     <tr><td class="paramname">vhost</td><td>which vhost to initialize client ssl operations on</td></tr>
    355. 

  355.   </table>
    356. 

  356.   </dd>
    357. 

  357. </dl>
    358. 

  358. <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>
    359. 

  359. <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,
    360. 

  360.       otherwise the call does nothing
    361. 

  361.   - provided_client_ssl_ctx must be NULL to get a generated client
    362. 

  362.       ssl context, otherwise you can pass a prepared one in by setting it
    363. 

  363.   - ssl_cipher_list may be NULL or set to the client valid cipher list
    364. 

  364.   - ssl_ca_filepath may be NULL or client cert filepath
    365. 

  365.   - ssl_cert_filepath may be NULL or client cert filepath
    366. 

  366.   - ssl_private_key_filepath may be NULL or client cert private key
    367. 

  367. </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>
    368. 

  368. 

  369. </div>
    370. 

  370. </div>
    371. 

  371. </div><!-- contents -->
    372. 

  372. </div><!-- doc-content -->
    373. 

  373. <!-- start footer part -->
    374. 

  374. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    375. 

  375.   <ul>
    376. 

  376.     <li class="footer">Generated by
    377. 

  377.     <a href="http://www.doxygen.org/index.html">
    378. 

  378.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
    379. 

  379.   </ul>
    380. 

  380. </div>
    381. 

  381. </body>
    382. 

  382. </html>
    383.