group__html-chunked-substitution.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  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: HTML Chunked Substitution</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 class="current"><a href="modules.html"><span>Modules</span></a></li>
  44. <li><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><!-- top -->
  49. <div id="side-nav" class="ui-resizable side-nav-resizable">
  50. <div id="nav-tree">
  51. <div id="nav-tree-contents">
  52. <div id="nav-sync" class="sync"></div>
  53. </div>
  54. </div>
  55. <div id="splitbar" style="-moz-user-select:none;"
  56. class="ui-resizable-handle">
  57. </div>
  58. </div>
  59. <script type="text/javascript">
  60. $(document).ready(function(){initNavTree('group__html-chunked-substitution.html','');});
  61. </script>
  62. <div id="doc-content">
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#nested-classes">Data Structures</a> &#124;
  66. <a href="#typedef-members">Typedefs</a> &#124;
  67. <a href="#enum-members">Enumerations</a> &#124;
  68. <a href="#func-members">Functions</a> </div>
  69. <div class="headertitle">
  70. <div class="title">HTML Chunked Substitution<div class="ingroups"><a class="el" href="group__http.html">HTTP</a></div></div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  75. Data Structures</h2></td></tr>
  76. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__process__html__args.html">lws_process_html_args</a></td></tr>
  77. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__process__html__state.html">lws_process_html_state</a></td></tr>
  79. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. </table><table class="memberdecls">
  81. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  82. Typedefs</h2></td></tr>
  83. <tr class="memitem:ga669d3d7ce2d5f193473f649a89b3e7ac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga669d3d7ce2d5f193473f649a89b3e7ac"></a>
  84. typedef const char *(*&#160;</td><td class="memItemRight" valign="bottom"><b>lws_process_html_state_cb</b>) (void *data, int index)</td></tr>
  85. <tr class="separator:ga669d3d7ce2d5f193473f649a89b3e7ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. </table><table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  88. Enumerations</h2></td></tr>
  89. <tr class="memitem:gabc3b93f68c8bdd857ad32913628dfa8d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabc3b93f68c8bdd857ad32913628dfa8d"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>http_status</b> { <br />
  90. &#160;&#160;<b>HTTP_STATUS_OK</b> = 200,
  91. <b>HTTP_STATUS_NO_CONTENT</b> = 204,
  92. <b>HTTP_STATUS_MOVED_PERMANENTLY</b> = 301,
  93. <b>HTTP_STATUS_FOUND</b> = 302,
  94. <br />
  95. &#160;&#160;<b>HTTP_STATUS_SEE_OTHER</b> = 303,
  96. <b>HTTP_STATUS_BAD_REQUEST</b> = 400,
  97. <b>HTTP_STATUS_UNAUTHORIZED</b>,
  98. <b>HTTP_STATUS_PAYMENT_REQUIRED</b>,
  99. <br />
  100. &#160;&#160;<b>HTTP_STATUS_FORBIDDEN</b>,
  101. <b>HTTP_STATUS_NOT_FOUND</b>,
  102. <b>HTTP_STATUS_METHOD_NOT_ALLOWED</b>,
  103. <b>HTTP_STATUS_NOT_ACCEPTABLE</b>,
  104. <br />
  105. &#160;&#160;<b>HTTP_STATUS_PROXY_AUTH_REQUIRED</b>,
  106. <b>HTTP_STATUS_REQUEST_TIMEOUT</b>,
  107. <b>HTTP_STATUS_CONFLICT</b>,
  108. <b>HTTP_STATUS_GONE</b>,
  109. <br />
  110. &#160;&#160;<b>HTTP_STATUS_LENGTH_REQUIRED</b>,
  111. <b>HTTP_STATUS_PRECONDITION_FAILED</b>,
  112. <b>HTTP_STATUS_REQ_ENTITY_TOO_LARGE</b>,
  113. <b>HTTP_STATUS_REQ_URI_TOO_LONG</b>,
  114. <br />
  115. &#160;&#160;<b>HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE</b>,
  116. <b>HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE</b>,
  117. <b>HTTP_STATUS_EXPECTATION_FAILED</b>,
  118. <b>HTTP_STATUS_INTERNAL_SERVER_ERROR</b> = 500,
  119. <br />
  120. &#160;&#160;<b>HTTP_STATUS_NOT_IMPLEMENTED</b>,
  121. <b>HTTP_STATUS_BAD_GATEWAY</b>,
  122. <b>HTTP_STATUS_SERVICE_UNAVAILABLE</b>,
  123. <b>HTTP_STATUS_GATEWAY_TIMEOUT</b>,
  124. <br />
  125. &#160;&#160;<b>HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED</b>
  126. <br />
  127. }</td></tr>
  128. <tr class="separator:gabc3b93f68c8bdd857ad32913628dfa8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. </table><table class="memberdecls">
  130. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  131. Functions</h2></td></tr>
  132. <tr class="memitem:ga643073f918c0a7016b690aae9793fd60"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__html-chunked-substitution.html#ga643073f918c0a7016b690aae9793fd60">lws_chunked_html_process</a> (struct <a class="el" href="structlws__process__html__args.html">lws_process_html_args</a> *args, struct <a class="el" href="structlws__process__html__state.html">lws_process_html_state</a> *s)</td></tr>
  133. <tr class="separator:ga643073f918c0a7016b690aae9793fd60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table>
  135. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  136. <h2>HTML chunked Substitution</h2>
  137. <p>APIs for receiving chunks of text, replacing a set of variable names via a callback, and then prepending and appending HTML chunked encoding headers. </p>
  138. <h2 class="groupheader">Function Documentation</h2>
  139. <a class="anchor" id="ga643073f918c0a7016b690aae9793fd60"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">LWS_VISIBLE LWS_EXTERN int lws_chunked_html_process </td>
  145. <td>(</td>
  146. <td class="paramtype">struct <a class="el" href="structlws__process__html__args.html">lws_process_html_args</a> *&#160;</td>
  147. <td class="paramname"><em>args</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">struct <a class="el" href="structlws__process__html__state.html">lws_process_html_state</a> *&#160;</td>
  153. <td class="paramname"><em>s</em>&#160;</td>
  154. </tr>
  155. <tr>
  156. <td></td>
  157. <td>)</td>
  158. <td></td><td></td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
  163. <p><a class="el" href="group__html-chunked-substitution.html#ga643073f918c0a7016b690aae9793fd60">lws_chunked_html_process()</a> - generic chunked substitution </p><dl class="params"><dt>Parameters</dt><dd>
  164. <table class="params">
  165. <tr><td class="paramname">args</td><td>buffer to process using chunked encoding </td></tr>
  166. <tr><td class="paramname">s</td><td>current processing state </td></tr>
  167. </table>
  168. </dd>
  169. </dl>
  170. </div>
  171. </div>
  172. </div><!-- contents -->
  173. </div><!-- doc-content -->
  174. <!-- start footer part -->
  175. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  176. <ul>
  177. <li class="footer">Generated by
  178. <a href="http://www.doxygen.org/index.html">
  179. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  180. </ul>
  181. </div>
  182. </body>
  183. </html>