structlws__http__mount.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  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.11"/>
  7. <title>libwebsockets: lws_http_mount Struct Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtreedata.js"></script>
  14. <script type="text/javascript" src="navtree.js"></script>
  15. <script type="text/javascript">
  16. $(document).ready(initResizable);
  17. $(window).load(resizeHeight);
  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.11 -->
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  43. <li><a href="modules.html"><span>Modules</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. </ul>
  47. </div>
  48. <div id="navrow2" class="tabs2">
  49. <ul class="tablist">
  50. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  51. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  52. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  53. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  54. </ul>
  55. </div>
  56. </div><!-- top -->
  57. <div id="side-nav" class="ui-resizable side-nav-resizable">
  58. <div id="nav-tree">
  59. <div id="nav-tree-contents">
  60. <div id="nav-sync" class="sync"></div>
  61. </div>
  62. </div>
  63. <div id="splitbar" style="-moz-user-select:none;"
  64. class="ui-resizable-handle">
  65. </div>
  66. </div>
  67. <script type="text/javascript">
  68. $(document).ready(function(){initNavTree('structlws__http__mount.html','');});
  69. </script>
  70. <div id="doc-content">
  71. <div class="header">
  72. <div class="summary">
  73. <a href="#pub-attribs">Data Fields</a> </div>
  74. <div class="headertitle">
  75. <div class="title">lws_http_mount Struct Reference<div class="ingroups"><a class="el" href="group__context-and-vhost.html">Context-and-vhost</a> &raquo; <a class="el" href="group__vhost-mounts.html">Vhost mounts and options</a></div></div> </div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p><code>#include &lt;<a class="el" href="libwebsockets_8h_source.html">libwebsockets.h</a>&gt;</code></p>
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  81. Data Fields</h2></td></tr>
  82. <tr class="memitem:a0109baf93f23c07c824c997c3533ee44"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structlws__http__mount.html">lws_http_mount</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#a0109baf93f23c07c824c997c3533ee44">mount_next</a></td></tr>
  83. <tr class="separator:a0109baf93f23c07c824c997c3533ee44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:aa2391bfcada0b7a290b3c6651f64586c"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#aa2391bfcada0b7a290b3c6651f64586c">mountpoint</a></td></tr>
  85. <tr class="separator:aa2391bfcada0b7a290b3c6651f64586c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a21d86fd6043ec00e121ababbc29af39a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#a21d86fd6043ec00e121ababbc29af39a">origin</a></td></tr>
  87. <tr class="separator:a21d86fd6043ec00e121ababbc29af39a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ae90d1efe7178199fad39de2926902ee4"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#ae90d1efe7178199fad39de2926902ee4">def</a></td></tr>
  89. <tr class="separator:ae90d1efe7178199fad39de2926902ee4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a05347d92c3d379809564bd4f3eab259b"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#a05347d92c3d379809564bd4f3eab259b">protocol</a></td></tr>
  91. <tr class="separator:a05347d92c3d379809564bd4f3eab259b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ae7b5c0f4c5408061e6ea3a8d281f45af"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structlws__protocol__vhost__options.html">lws_protocol_vhost_options</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#ae7b5c0f4c5408061e6ea3a8d281f45af">cgienv</a></td></tr>
  93. <tr class="separator:ae7b5c0f4c5408061e6ea3a8d281f45af"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a4437423df85ee3dbcae0e15974c89ec7"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structlws__protocol__vhost__options.html">lws_protocol_vhost_options</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#a4437423df85ee3dbcae0e15974c89ec7">extra_mimetypes</a></td></tr>
  95. <tr class="separator:a4437423df85ee3dbcae0e15974c89ec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a11ea62b952710d59733dbcf9794a5773"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structlws__protocol__vhost__options.html">lws_protocol_vhost_options</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#a11ea62b952710d59733dbcf9794a5773">interpret</a></td></tr>
  97. <tr class="separator:a11ea62b952710d59733dbcf9794a5773"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a4a7239d6d4c03986e6e1a72abb6c83aa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#a4a7239d6d4c03986e6e1a72abb6c83aa">cgi_timeout</a></td></tr>
  99. <tr class="separator:a4a7239d6d4c03986e6e1a72abb6c83aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a4283e30ea89d27ae7d061ad760d1d146"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#a4283e30ea89d27ae7d061ad760d1d146">cache_max_age</a></td></tr>
  101. <tr class="separator:a4283e30ea89d27ae7d061ad760d1d146"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a614364c770b0bd4db464ad65cddab477"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#a614364c770b0bd4db464ad65cddab477">auth_mask</a></td></tr>
  103. <tr class="separator:a614364c770b0bd4db464ad65cddab477"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a8316dd183ffbef50419a5a4968d35d84"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#a8316dd183ffbef50419a5a4968d35d84">cache_reusable</a>:1</td></tr>
  105. <tr class="separator:a8316dd183ffbef50419a5a4968d35d84"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:ae137203040c6153694bd88a708da5395"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#ae137203040c6153694bd88a708da5395">cache_revalidate</a>:1</td></tr>
  107. <tr class="separator:ae137203040c6153694bd88a708da5395"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:aabec1a326780aafe11b977000983be0c"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#aabec1a326780aafe11b977000983be0c">cache_intermediaries</a>:1</td></tr>
  109. <tr class="separator:aabec1a326780aafe11b977000983be0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a6a9b1492a0b9749e39bd19932717a0b7"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#a6a9b1492a0b9749e39bd19932717a0b7">origin_protocol</a></td></tr>
  111. <tr class="separator:a6a9b1492a0b9749e39bd19932717a0b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ac8489b60b8f969eb19c9abbdeac90743"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__http__mount.html#ac8489b60b8f969eb19c9abbdeac90743">mountpoint_len</a></td></tr>
  113. <tr class="separator:ac8489b60b8f969eb19c9abbdeac90743"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table>
  115. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  116. <div class="textblock"><p>struct <a class="el" href="structlws__http__mount.html">lws_http_mount</a></p>
  117. <p>arguments for mounting something in a vhost's url namespace </p>
  118. </div><h2 class="groupheader">Field Documentation</h2>
  119. <a class="anchor" id="a614364c770b0bd4db464ad65cddab477"></a>
  120. <div class="memitem">
  121. <div class="memproto">
  122. <table class="memname">
  123. <tr>
  124. <td class="memname">unsigned int lws_http_mount::auth_mask</td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p>bits set here must be set for authorized client session </p>
  129. </div>
  130. </div>
  131. <a class="anchor" id="aabec1a326780aafe11b977000983be0c"></a>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">unsigned int lws_http_mount::cache_intermediaries</td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. <p>set if intermediaries are allowed to cache </p>
  141. </div>
  142. </div>
  143. <a class="anchor" id="a4283e30ea89d27ae7d061ad760d1d146"></a>
  144. <div class="memitem">
  145. <div class="memproto">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname">int lws_http_mount::cache_max_age</td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. <p>max-age for reuse of client cache of files, seconds </p>
  153. </div>
  154. </div>
  155. <a class="anchor" id="a8316dd183ffbef50419a5a4968d35d84"></a>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">unsigned int lws_http_mount::cache_reusable</td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>set if client cache may reuse this </p>
  165. </div>
  166. </div>
  167. <a class="anchor" id="ae137203040c6153694bd88a708da5395"></a>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <table class="memname">
  171. <tr>
  172. <td class="memname">unsigned int lws_http_mount::cache_revalidate</td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. <p>set if client cache should revalidate on use </p>
  177. </div>
  178. </div>
  179. <a class="anchor" id="a4a7239d6d4c03986e6e1a72abb6c83aa"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">int lws_http_mount::cgi_timeout</td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>seconds cgi is allowed to live, if cgi://mount type </p>
  189. </div>
  190. </div>
  191. <a class="anchor" id="ae7b5c0f4c5408061e6ea3a8d281f45af"></a>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">const struct <a class="el" href="structlws__protocol__vhost__options.html">lws_protocol_vhost_options</a>* lws_http_mount::cgienv</td>
  197. </tr>
  198. </table>
  199. </div><div class="memdoc">
  200. <p>optional linked-list of cgi options. These are created as environment variables for the cgi process </p>
  201. </div>
  202. </div>
  203. <a class="anchor" id="ae90d1efe7178199fad39de2926902ee4"></a>
  204. <div class="memitem">
  205. <div class="memproto">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">const char* lws_http_mount::def</td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <p>default target, eg, "index.html" </p>
  213. </div>
  214. </div>
  215. <a class="anchor" id="a4437423df85ee3dbcae0e15974c89ec7"></a>
  216. <div class="memitem">
  217. <div class="memproto">
  218. <table class="memname">
  219. <tr>
  220. <td class="memname">const struct <a class="el" href="structlws__protocol__vhost__options.html">lws_protocol_vhost_options</a>* lws_http_mount::extra_mimetypes</td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. <p>optional linked-list of mimetype mappings </p>
  225. </div>
  226. </div>
  227. <a class="anchor" id="a11ea62b952710d59733dbcf9794a5773"></a>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">const struct <a class="el" href="structlws__protocol__vhost__options.html">lws_protocol_vhost_options</a>* lws_http_mount::interpret</td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p>optional linked-list of files to be interpreted </p>
  237. </div>
  238. </div>
  239. <a class="anchor" id="a0109baf93f23c07c824c997c3533ee44"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">const struct <a class="el" href="structlws__http__mount.html">lws_http_mount</a>* lws_http_mount::mount_next</td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>pointer to next struct <a class="el" href="structlws__http__mount.html">lws_http_mount</a> </p>
  249. </div>
  250. </div>
  251. <a class="anchor" id="aa2391bfcada0b7a290b3c6651f64586c"></a>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname">const char* lws_http_mount::mountpoint</td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. <p>mountpoint in http pathspace, eg, "/" </p>
  261. </div>
  262. </div>
  263. <a class="anchor" id="ac8489b60b8f969eb19c9abbdeac90743"></a>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">unsigned char lws_http_mount::mountpoint_len</td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>length of mountpoint string </p>
  273. </div>
  274. </div>
  275. <a class="anchor" id="a21d86fd6043ec00e121ababbc29af39a"></a>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">const char* lws_http_mount::origin</td>
  281. </tr>
  282. </table>
  283. </div><div class="memdoc">
  284. <p>path to be mounted, eg, "/var/www/warmcat.com" </p>
  285. </div>
  286. </div>
  287. <a class="anchor" id="a6a9b1492a0b9749e39bd19932717a0b7"></a>
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">unsigned char lws_http_mount::origin_protocol</td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <p>one of enum lws_mount_protocols </p>
  297. </div>
  298. </div>
  299. <a class="anchor" id="a05347d92c3d379809564bd4f3eab259b"></a>
  300. <div class="memitem">
  301. <div class="memproto">
  302. <table class="memname">
  303. <tr>
  304. <td class="memname">const char* lws_http_mount::protocol</td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <p>"protocol-name" to handle mount </p>
  309. </div>
  310. </div>
  311. <hr/>The documentation for this struct was generated from the following file:<ul>
  312. <li>lib/<a class="el" href="libwebsockets_8h_source.html">libwebsockets.h</a></li>
  313. </ul>
  314. </div><!-- contents -->
  315. </div><!-- doc-content -->
  316. <!-- start footer part -->
  317. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  318. <ul>
  319. <li class="navelem"><a class="el" href="structlws__http__mount.html">lws_http_mount</a></li>
  320. <li class="footer">Generated by
  321. <a href="http://www.doxygen.org/index.html">
  322. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  323. </ul>
  324. </div>
  325. </body>
  326. </html>