首页 发现 帮助
登录
SoftwareDesign
/
csu3_am335x
8
0
派生 0
文件 工单管理 0 合并请求 0 Wiki
目录树: d7a5bbbc4f
分支列表 标签列表
csu3_am335x
/
EVSE
/
GPL
/
libwebsockets-v2.1-stable
/
doc
/
html
/
group__extensions.html

group__extensions.html 24 KB
文件历史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449 
  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: Extensions</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__extensions.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="#typedef-members">Typedefs</a> &#124;
    67. 

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

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

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

  70. <div class="title">Extensions</div>  </div>
    71. 

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

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

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

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

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

  76. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__ext__options.html">lws_ext_options</a></td></tr>
    77. 

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

  78. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__ext__option__arg.html">lws_ext_option_arg</a></td></tr>
    79. 

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

  80. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__extension.html">lws_extension</a></td></tr>
    81. 

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

  82. </table><table class="memberdecls">
    83. 

  83. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
    84. 

  84. Typedefs</h2></td></tr>
    85. 

  85. <tr class="memitem:gaae7169b2cd346b34fa33d0250db2afd0"><td class="memItemLeft" align="right" valign="top">typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__extensions.html#gaae7169b2cd346b34fa33d0250db2afd0">lws_extension_callback_function</a>(struct lws_context *context, const struct <a class="el" href="structlws__extension.html">lws_extension</a> *ext, struct lws *wsi, enum lws_extension_callback_reasons reason, void *user, void *in, size_t len)</td></tr>
    86. 

  86. <tr class="separator:gaae7169b2cd346b34fa33d0250db2afd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
    87. 

  87. </table><table class="memberdecls">
    88. 

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

  89. Enumerations</h2></td></tr>
    90. 

  90. <tr class="memitem:gae9993815eee72c6070300a0ae2f022d7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae9993815eee72c6070300a0ae2f022d7"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>lws_extension_callback_reasons</b> { <br />
    91. 

  91. &#160;&#160;<b>LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT</b> = 0, 
    92. 

  92. <b>LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT</b> = 1, 
    93. 

  93. <b>LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT</b> = 2, 
    94. 

  94. <b>LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT</b> = 3, 
    95. 

  95. <br />
    96. 

  96. &#160;&#160;<b>LWS_EXT_CB_CONSTRUCT</b> = 4, 
    97. 

  97. <b>LWS_EXT_CB_CLIENT_CONSTRUCT</b> = 5, 
    98. 

  98. <b>LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE</b> = 6, 
    99. 

  99. <b>LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION</b> = 7, 
    100. 

  100. <br />
    101. 

  101. &#160;&#160;<b>LWS_EXT_CB_DESTROY</b> = 8, 
    102. 

  102. <b>LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING</b> = 9, 
    103. 

  103. <b>LWS_EXT_CB_ANY_WSI_ESTABLISHED</b> = 10, 
    104. 

  104. <b>LWS_EXT_CB_PACKET_RX_PREPARSE</b> = 11, 
    105. 

  105. <br />
    106. 

  106. &#160;&#160;<b>LWS_EXT_CB_PACKET_TX_PRESEND</b> = 12, 
    107. 

  107. <b>LWS_EXT_CB_PACKET_TX_DO_SEND</b> = 13, 
    108. 

  108. <b>LWS_EXT_CB_HANDSHAKE_REPLY_TX</b> = 14, 
    109. 

  109. <b>LWS_EXT_CB_FLUSH_PENDING_TX</b> = 15, 
    110. 

  110. <br />
    111. 

  111. &#160;&#160;<b>LWS_EXT_CB_EXTENDED_PAYLOAD_RX</b> = 16, 
    112. 

  112. <b>LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION</b> = 17, 
    113. 

  113. <b>LWS_EXT_CB_1HZ</b> = 18, 
    114. 

  114. <b>LWS_EXT_CB_REQUEST_ON_WRITEABLE</b> = 19, 
    115. 

  115. <br />
    116. 

  116. &#160;&#160;<b>LWS_EXT_CB_IS_WRITEABLE</b> = 20, 
    117. 

  117. <b>LWS_EXT_CB_PAYLOAD_TX</b> = 21, 
    118. 

  118. <b>LWS_EXT_CB_PAYLOAD_RX</b> = 22, 
    119. 

  119. <b>LWS_EXT_CB_OPTION_DEFAULT</b> = 23, 
    120. 

  120. <br />
    121. 

  121. &#160;&#160;<b>LWS_EXT_CB_OPTION_SET</b> = 24, 
    122. 

  122. <b>LWS_EXT_CB_OPTION_CONFIRM</b> = 25, 
    123. 

  123. <b>LWS_EXT_CB_NAMED_OPTION_SET</b> = 26
    124. 

  124. <br />
    125. 

  125.  }</td></tr>
    126. 

  126. <tr class="separator:gae9993815eee72c6070300a0ae2f022d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    127. 

  127. <tr class="memitem:gacc9f55936dc165257a2e1f7d47bce89e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__extensions.html#gacc9f55936dc165257a2e1f7d47bce89e">lws_ext_options_types</a> { <a class="el" href="group__extensions.html#ggacc9f55936dc165257a2e1f7d47bce89eaabcf56c456c1ff6e81dc82586a16f14c">EXTARG_NONE</a>, 
    128. 

  128. <a class="el" href="group__extensions.html#ggacc9f55936dc165257a2e1f7d47bce89ea1c86adf924c8786a12bee9687094673e">EXTARG_DEC</a>, 
    129. 

  129. <a class="el" href="group__extensions.html#ggacc9f55936dc165257a2e1f7d47bce89ea5265abe3e1c3f64412f2affe7bffd880">EXTARG_OPT_DEC</a>
    130. 

  130.  }</td></tr>
    131. 

  131. <tr class="separator:gacc9f55936dc165257a2e1f7d47bce89e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    132. 

  132. </table><table class="memberdecls">
    133. 

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

  134. Functions</h2></td></tr>
    135. 

  135. <tr class="memitem:gae0e24e1768f83a7fb07896ce975704b9"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__extensions.html#gae0e24e1768f83a7fb07896ce975704b9">lws_set_extension_option</a> (struct lws *wsi, const char *ext_name, const char *opt_name, const char *opt_val)</td></tr>
    136. 

  136. <tr class="separator:gae0e24e1768f83a7fb07896ce975704b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
    137. 

  137. <tr class="memitem:ga6fb3e2c3dfb9d64dc87026a4e99c128b"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__extensions.html#ga6fb3e2c3dfb9d64dc87026a4e99c128b">lws_ext_parse_options</a> (const struct <a class="el" href="structlws__extension.html">lws_extension</a> *ext, struct lws *wsi, void *ext_user, const struct <a class="el" href="structlws__ext__options.html">lws_ext_options</a> *opts, const char *o, int len)</td></tr>
    138. 

  138. <tr class="separator:ga6fb3e2c3dfb9d64dc87026a4e99c128b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    139. 

  139. <tr class="memitem:ga4cdbe42d872e21a448a947714d6c607e"><td class="memItemLeft" align="right" valign="top">LWS_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__extensions.html#ga4cdbe42d872e21a448a947714d6c607e">lws_extension_callback_pm_deflate</a> (struct lws_context *context, const struct <a class="el" href="structlws__extension.html">lws_extension</a> *ext, struct lws *wsi, enum lws_extension_callback_reasons reason, void *user, void *in, size_t len)</td></tr>
    140. 

  140. <tr class="separator:ga4cdbe42d872e21a448a947714d6c607e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    141. 

  141. </table>
    142. 

  142. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    143. 

  143. <h2>Extension releated functions</h2>
    144. 

  144. <p>Ws defines optional extensions, lws provides the ability to implement these in user code if so desired.</p>
    145. 

  145. <p>We provide one extensions permessage-deflate. </p>
    146. 

  146. <h2 class="groupheader">Typedef Documentation</h2>
    147. 

  147. <a class="anchor" id="gaae7169b2cd346b34fa33d0250db2afd0"></a>
    148. 

  148. <div class="memitem">
    149. 

  149. <div class="memproto">
    150. 

  150.       <table class="memname">
    151. 

  151.         <tr>
    152. 

  152.           <td class="memname">typedef int lws_extension_callback_function(struct lws_context *context, const struct <a class="el" href="structlws__extension.html">lws_extension</a> *ext, struct lws *wsi, enum lws_extension_callback_reasons reason, void *user, void *in, size_t len)</td>
    153. 

  153.         </tr>
    154. 

  154.       </table>
    155. 

  155. </div><div class="memdoc">
    156. 

  156. 

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

  158. <p>typedef <a class="el" href="group__extensions.html#gaae7169b2cd346b34fa33d0250db2afd0">lws_extension_callback_function()</a> - Hooks to allow extensions to operate </p><dl class="params"><dt>Parameters</dt><dd>
    159. 

  159.   <table class="params">
    160. 

  160.     <tr><td class="paramname">context</td><td>Websockets context </td></tr>
    161. 

  161.     <tr><td class="paramname">ext</td><td>This extension </td></tr>
    162. 

  162.     <tr><td class="paramname">wsi</td><td>Opaque websocket instance pointer </td></tr>
    163. 

  163.     <tr><td class="paramname">reason</td><td>The reason for the call </td></tr>
    164. 

  164.     <tr><td class="paramname">user</td><td>Pointer to ptr to per-session user data allocated by library </td></tr>
    165. 

  165.     <tr><td class="paramname">in</td><td>Pointer used for some callback reasons </td></tr>
    166. 

  166.     <tr><td class="paramname">len</td><td>Length set for some callback reasons <pre class="fragment"> Each extension that is active on a particular connection receives
    167. 

  167.  callbacks during the connection lifetime to allow the extension to
    168. 

  168.  operate on websocket data and manage itself.
    169. 

  169. 

  170.  Libwebsockets takes care of allocating and freeing "user" memory for
    171. 

  171.  each active extension on each connection.  That is what is pointed to
    172. 

  172.  by the user parameter.
    173. 

  173. 

  174.  LWS_EXT_CB_CONSTRUCT:  called when the server has decided to
    175. 

  175.     select this extension from the list provided by the client,
    176. 

  176.     just before the server will send back the handshake accepting
    177. 

  177.     the connection with this extension active.  This gives the
    178. 

  178.     extension a chance to initialize its connection context found
    179. 

  179.     in user.
    180. 

  180. 

  181.  LWS_EXT_CB_CLIENT_CONSTRUCT: same as LWS_EXT_CB_CONSTRUCT
    182. 

  182.     but called when client is instantiating this extension.  Some
    183. 

  183.     extensions will work the same on client and server side and then
    184. 

  184.     you can just merge handlers for both CONSTRUCTS.
    185. 

  185. 

  186.  LWS_EXT_CB_DESTROY:  called when the connection the extension was
    187. 

  187.     being used on is about to be closed and deallocated.  It's the
    188. 

  188.     last chance for the extension to deallocate anything it has
    189. 

  189.     allocated in the user data (pointed to by user) before the
    190. 

  190.     user data is deleted.  This same callback is used whether you
    191. 

  191.     are in client or server instantiation context.
    192. 

  192. 

  193.  LWS_EXT_CB_PACKET_RX_PREPARSE: when this extension was active on
    194. 

  194.     a connection, and a packet of data arrived at the connection,
    195. 

  195.     it is passed to this callback to give the extension a chance to
    196. 

  196.     change the data, eg, decompress it.  user is pointing to the
    197. 

  197.     extension's private connection context data, in is pointing
    198. 

  198.     to an lws_tokens struct, it consists of a char * pointer called
    199. 

  199.     token, and an int called token_len.  At entry, these are
    200. 

  200.     set to point to the received buffer and set to the content
    201. 

  201.     length.  If the extension will grow the content, it should use
    202. 

  202.     a new buffer allocated in its private user context data and
    203. 

  203.     set the pointed-to lws_tokens members to point to its buffer.
    204. 

  204. 

  205.  LWS_EXT_CB_PACKET_TX_PRESEND: this works the same way as
    206. 

  206.     LWS_EXT_CB_PACKET_RX_PREPARSE above, except it gives the
    207. 

  207.     extension a chance to change websocket data just before it will
    208. 

  208.     be sent out.  Using the same lws_token pointer scheme in in,
    209. 

  209.     the extension can change the buffer and the length to be
    210. 

  210.     transmitted how it likes.  Again if it wants to grow the
    211. 

  211.     buffer safely, it should copy the data into its own buffer and
    212. 

  212.     set the lws_tokens token pointer to it.
    213. 

  213. 

  214.  LWS_EXT_CB_ARGS_VALIDATE:</pre> </td></tr>
    215. 

  215.   </table>
    216. 

  216.   </dd>
    217. 

  217. </dl>
    218. 

  218. 

  219. </div>
    220. 

  220. </div>
    221. 

  221. <h2 class="groupheader">Enumeration Type Documentation</h2>
    222. 

  222. <a class="anchor" id="gacc9f55936dc165257a2e1f7d47bce89e"></a>
    223. 

  223. <div class="memitem">
    224. 

  224. <div class="memproto">
    225. 

  225.       <table class="memname">
    226. 

  226.         <tr>
    227. 

  227.           <td class="memname">enum <a class="el" href="group__extensions.html#gacc9f55936dc165257a2e1f7d47bce89e">lws_ext_options_types</a></td>
    228. 

  228.         </tr>
    229. 

  229.       </table>
    230. 

  230. </div><div class="memdoc">
    231. 

  231. 

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

  233. <p>enum lws_ext_options_types </p>
    234. 

  234. <table class="fieldtable">
    235. 

  235. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggacc9f55936dc165257a2e1f7d47bce89eaabcf56c456c1ff6e81dc82586a16f14c"></a>EXTARG_NONE&#160;</td><td class="fielddoc">
    236. 

  236. <p>does not take an argument </p>
    237. 

  237. </td></tr>
    238. 

  238. <tr><td class="fieldname"><a class="anchor" id="ggacc9f55936dc165257a2e1f7d47bce89ea1c86adf924c8786a12bee9687094673e"></a>EXTARG_DEC&#160;</td><td class="fielddoc">
    239. 

  239. <p>requires a decimal argument </p>
    240. 

  240. </td></tr>
    241. 

  241. <tr><td class="fieldname"><a class="anchor" id="ggacc9f55936dc165257a2e1f7d47bce89ea5265abe3e1c3f64412f2affe7bffd880"></a>EXTARG_OPT_DEC&#160;</td><td class="fielddoc">
    242. 

  242. <p>may have an optional decimal argument </p>
    243. 

  243. </td></tr>
    244. 

  244. </table>
    245. 

  245. <div class="fragment"><div class="line"><a name="l01095"></a><span class="lineno"> 1095</span>&#160;                           {</div><div class="line"><a name="l01096"></a><span class="lineno"> 1096</span>&#160;        <a class="code" href="group__extensions.html#ggacc9f55936dc165257a2e1f7d47bce89eaabcf56c456c1ff6e81dc82586a16f14c">EXTARG_NONE</a>, </div><div class="line"><a name="l01097"></a><span class="lineno"> 1097</span>&#160;        <a class="code" href="group__extensions.html#ggacc9f55936dc165257a2e1f7d47bce89ea1c86adf924c8786a12bee9687094673e">EXTARG_DEC</a>,  </div><div class="line"><a name="l01098"></a><span class="lineno"> 1098</span>&#160;        <a class="code" href="group__extensions.html#ggacc9f55936dc165257a2e1f7d47bce89ea5265abe3e1c3f64412f2affe7bffd880">EXTARG_OPT_DEC</a> </div><div class="line"><a name="l01100"></a><span class="lineno"> 1100</span>&#160;        <span class="comment">/* Add new things just above here ---^</span></div><div class="line"><a name="l01101"></a><span class="lineno"> 1101</span>&#160;<span class="comment">         * This is part of the ABI, don&#39;t needlessly break compatibility */</span></div><div class="line"><a name="l01102"></a><span class="lineno"> 1102</span>&#160;};</div><div class="ttc" id="group__extensions_html_ggacc9f55936dc165257a2e1f7d47bce89ea5265abe3e1c3f64412f2affe7bffd880"><div class="ttname"><a href="group__extensions.html#ggacc9f55936dc165257a2e1f7d47bce89ea5265abe3e1c3f64412f2affe7bffd880">EXTARG_OPT_DEC</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:1098</div></div>
    246. 

  246. <div class="ttc" id="group__extensions_html_ggacc9f55936dc165257a2e1f7d47bce89eaabcf56c456c1ff6e81dc82586a16f14c"><div class="ttname"><a href="group__extensions.html#ggacc9f55936dc165257a2e1f7d47bce89eaabcf56c456c1ff6e81dc82586a16f14c">EXTARG_NONE</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:1096</div></div>
    247. 

  247. <div class="ttc" id="group__extensions_html_ggacc9f55936dc165257a2e1f7d47bce89ea1c86adf924c8786a12bee9687094673e"><div class="ttname"><a href="group__extensions.html#ggacc9f55936dc165257a2e1f7d47bce89ea1c86adf924c8786a12bee9687094673e">EXTARG_DEC</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:1097</div></div>
    248. 

  248. </div><!-- fragment -->
    249. 

  249. </div>
    250. 

  250. </div>
    251. 

  251. <h2 class="groupheader">Function Documentation</h2>
    252. 

  252. <a class="anchor" id="ga6fb3e2c3dfb9d64dc87026a4e99c128b"></a>
    253. 

  253. <div class="memitem">
    254. 

  254. <div class="memproto">
    255. 

  255.       <table class="memname">
    256. 

  256.         <tr>
    257. 

  257.           <td class="memname">LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_ext_parse_options </td>
    258. 

  258.           <td>(</td>
    259. 

  259.           <td class="paramtype">const struct <a class="el" href="structlws__extension.html">lws_extension</a> *&#160;</td>
    260. 

  260.           <td class="paramname"><em>ext</em>, </td>
    261. 

  261.         </tr>
    262. 

  262.         <tr>
    263. 

  263.           <td class="paramkey"></td>
    264. 

  264.           <td></td>
    265. 

  265.           <td class="paramtype">struct lws *&#160;</td>
    266. 

  266.           <td class="paramname"><em>wsi</em>, </td>
    267. 

  267.         </tr>
    268. 

  268.         <tr>
    269. 

  269.           <td class="paramkey"></td>
    270. 

  270.           <td></td>
    271. 

  271.           <td class="paramtype">void *&#160;</td>
    272. 

  272.           <td class="paramname"><em>ext_user</em>, </td>
    273. 

  273.         </tr>
    274. 

  274.         <tr>
    275. 

  275.           <td class="paramkey"></td>
    276. 

  276.           <td></td>
    277. 

  277.           <td class="paramtype">const struct <a class="el" href="structlws__ext__options.html">lws_ext_options</a> *&#160;</td>
    278. 

  278.           <td class="paramname"><em>opts</em>, </td>
    279. 

  279.         </tr>
    280. 

  280.         <tr>
    281. 

  281.           <td class="paramkey"></td>
    282. 

  282.           <td></td>
    283. 

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

  284.           <td class="paramname"><em>o</em>, </td>
    285. 

  285.         </tr>
    286. 

  286.         <tr>
    287. 

  287.           <td class="paramkey"></td>
    288. 

  288.           <td></td>
    289. 

  289.           <td class="paramtype">int&#160;</td>
    290. 

  290.           <td class="paramname"><em>len</em>&#160;</td>
    291. 

  291.         </tr>
    292. 

  292.         <tr>
    293. 

  293.           <td></td>
    294. 

  294.           <td>)</td>
    295. 

  295.           <td></td><td></td>
    296. 

  296.         </tr>
    297. 

  297.       </table>
    298. 

  298. </div><div class="memdoc">
    299. 

  299. 

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

  301. <p><a class="el" href="group__extensions.html#ga6fb3e2c3dfb9d64dc87026a4e99c128b">lws_ext_parse_options()</a> - deal with parsing negotiated extension options</p>
    302. 

  302. <dl class="params"><dt>Parameters</dt><dd>
    303. 

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

  304.     <tr><td class="paramname">ext</td><td>related extension struct </td></tr>
    305. 

  305.     <tr><td class="paramname">wsi</td><td>websocket connection </td></tr>
    306. 

  306.     <tr><td class="paramname">ext_user</td><td>per-connection extension private data </td></tr>
    307. 

  307.     <tr><td class="paramname">opts</td><td>list of supported options </td></tr>
    308. 

  308.     <tr><td class="paramname">o</td><td>option string to parse </td></tr>
    309. 

  309.     <tr><td class="paramname">len</td><td>length </td></tr>
    310. 

  310.   </table>
    311. 

  311.   </dd>
    312. 

  312. </dl>
    313. 

  313. 

  314. </div>
    315. 

  315. </div>
    316. 

  316. <a class="anchor" id="ga4cdbe42d872e21a448a947714d6c607e"></a>
    317. 

  317. <div class="memitem">
    318. 

  318. <div class="memproto">
    319. 

  319.       <table class="memname">
    320. 

  320.         <tr>
    321. 

  321.           <td class="memname">LWS_EXTERN int lws_extension_callback_pm_deflate </td>
    322. 

  322.           <td>(</td>
    323. 

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

  324.           <td class="paramname"><em>context</em>, </td>
    325. 

  325.         </tr>
    326. 

  326.         <tr>
    327. 

  327.           <td class="paramkey"></td>
    328. 

  328.           <td></td>
    329. 

  329.           <td class="paramtype">const struct <a class="el" href="structlws__extension.html">lws_extension</a> *&#160;</td>
    330. 

  330.           <td class="paramname"><em>ext</em>, </td>
    331. 

  331.         </tr>
    332. 

  332.         <tr>
    333. 

  333.           <td class="paramkey"></td>
    334. 

  334.           <td></td>
    335. 

  335.           <td class="paramtype">struct lws *&#160;</td>
    336. 

  336.           <td class="paramname"><em>wsi</em>, </td>
    337. 

  337.         </tr>
    338. 

  338.         <tr>
    339. 

  339.           <td class="paramkey"></td>
    340. 

  340.           <td></td>
    341. 

  341.           <td class="paramtype">enum lws_extension_callback_reasons&#160;</td>
    342. 

  342.           <td class="paramname"><em>reason</em>, </td>
    343. 

  343.         </tr>
    344. 

  344.         <tr>
    345. 

  345.           <td class="paramkey"></td>
    346. 

  346.           <td></td>
    347. 

  347.           <td class="paramtype">void *&#160;</td>
    348. 

  348.           <td class="paramname"><em>user</em>, </td>
    349. 

  349.         </tr>
    350. 

  350.         <tr>
    351. 

  351.           <td class="paramkey"></td>
    352. 

  352.           <td></td>
    353. 

  353.           <td class="paramtype">void *&#160;</td>
    354. 

  354.           <td class="paramname"><em>in</em>, </td>
    355. 

  355.         </tr>
    356. 

  356.         <tr>
    357. 

  357.           <td class="paramkey"></td>
    358. 

  358.           <td></td>
    359. 

  359.           <td class="paramtype">size_t&#160;</td>
    360. 

  360.           <td class="paramname"><em>len</em>&#160;</td>
    361. 

  361.         </tr>
    362. 

  362.         <tr>
    363. 

  363.           <td></td>
    364. 

  364.           <td>)</td>
    365. 

  365.           <td></td><td></td>
    366. 

  366.         </tr>
    367. 

  367.       </table>
    368. 

  368. </div><div class="memdoc">
    369. 

  369. 

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

  371. <p><a class="el" href="group__extensions.html#ga4cdbe42d872e21a448a947714d6c607e">lws_extension_callback_pm_deflate()</a> - extension for RFC7692</p>
    372. 

  372. <dl class="params"><dt>Parameters</dt><dd>
    373. 

  373.   <table class="params">
    374. 

  374.     <tr><td class="paramname">context</td><td>lws context </td></tr>
    375. 

  375.     <tr><td class="paramname">ext</td><td>related <a class="el" href="structlws__extension.html">lws_extension</a> struct </td></tr>
    376. 

  376.     <tr><td class="paramname">wsi</td><td>websocket connection </td></tr>
    377. 

  377.     <tr><td class="paramname">reason</td><td>incoming callback reason </td></tr>
    378. 

  378.     <tr><td class="paramname">user</td><td>per-connection extension private data </td></tr>
    379. 

  379.     <tr><td class="paramname">in</td><td>pointer parameter </td></tr>
    380. 

  380.     <tr><td class="paramname">len</td><td>length parameter</td></tr>
    381. 

  381.   </table>
    382. 

  382.   </dd>
    383. 

  383. </dl>
    384. 

  384. <p>Built-in callback implementing RFC7692 permessage-deflate </p>
    385. 

  385. 

  386. </div>
    387. 

  387. </div>
    388. 

  388. <a class="anchor" id="gae0e24e1768f83a7fb07896ce975704b9"></a>
    389. 

  389. <div class="memitem">
    390. 

  390. <div class="memproto">
    391. 

  391.       <table class="memname">
    392. 

  392.         <tr>
    393. 

  393.           <td class="memname">LWS_VISIBLE LWS_EXTERN int lws_set_extension_option </td>
    394. 

  394.           <td>(</td>
    395. 

  395.           <td class="paramtype">struct lws *&#160;</td>
    396. 

  396.           <td class="paramname"><em>wsi</em>, </td>
    397. 

  397.         </tr>
    398. 

  398.         <tr>
    399. 

  399.           <td class="paramkey"></td>
    400. 

  400.           <td></td>
    401. 

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

  402.           <td class="paramname"><em>ext_name</em>, </td>
    403. 

  403.         </tr>
    404. 

  404.         <tr>
    405. 

  405.           <td class="paramkey"></td>
    406. 

  406.           <td></td>
    407. 

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

  408.           <td class="paramname"><em>opt_name</em>, </td>
    409. 

  409.         </tr>
    410. 

  410.         <tr>
    411. 

  411.           <td class="paramkey"></td>
    412. 

  412.           <td></td>
    413. 

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

  414.           <td class="paramname"><em>opt_val</em>&#160;</td>
    415. 

  415.         </tr>
    416. 

  416.         <tr>
    417. 

  417.           <td></td>
    418. 

  418.           <td>)</td>
    419. 

  419.           <td></td><td></td>
    420. 

  420.         </tr>
    421. 

  421.       </table>
    422. 

  422. </div><div class="memdoc">
    423. 

  423. 

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

  425. <p><a class="el" href="group__extensions.html#gae0e24e1768f83a7fb07896ce975704b9">lws_set_extension_option()</a>: set extension option if possible</p>
    426. 

  426. <dl class="params"><dt>Parameters</dt><dd>
    427. 

  427.   <table class="params">
    428. 

  428.     <tr><td class="paramname">wsi</td><td>websocket connection </td></tr>
    429. 

  429.     <tr><td class="paramname">ext_name</td><td>name of ext, like "permessage-deflate" </td></tr>
    430. 

  430.     <tr><td class="paramname">opt_name</td><td>name of option, like "rx_buf_size" </td></tr>
    431. 

  431.     <tr><td class="paramname">opt_val</td><td>value to set option to </td></tr>
    432. 

  432.   </table>
    433. 

  433.   </dd>
    434. 

  434. </dl>
    435. 

  435. 

  436. </div>
    437. 

  437. </div>
    438. 

  438. </div><!-- contents -->
    439. 

  439. </div><!-- doc-content -->
    440. 

  440. <!-- start footer part -->
    441. 

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

  442.   <ul>
    443. 

  443.     <li class="footer">Generated by
    444. 

  444.     <a href="http://www.doxygen.org/index.html">
    445. 

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

  446.   </ul>
    447. 

  447. </div>
    448. 

  448. </body>
    449. 

  449. </html>
    450.