doc/html/group__sending-data.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: Sending data</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__sending-data.html','');});
  60 </script>
  61 <div id="doc-content">
  62 <div class="header">
  63   <div class="summary">
  64 <a href="#enum-members">Enumerations</a> &#124;
  65 <a href="#func-members">Functions</a>  </div>
  66   <div class="headertitle">
  67 <div class="title">Sending data</div>  </div>
  68 </div><!--header-->
  69 <div class="contents">
  70 <table class="memberdecls">
  71 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  72 Enumerations</h2></td></tr>
  73 <tr class="memitem:ga98b099cf8c1c7e38ad78501f270e193d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sending-data.html#ga98b099cf8c1c7e38ad78501f270e193d">lws_write_protocol</a> { <br />
  74 &#160;&#160;<a class="el" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da80e8f169fda236c56bfb795ed62903db">LWS_WRITE_TEXT</a> = 0,
  75 <a class="el" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193daf6486c0dba50c44198100717721d9ab2">LWS_WRITE_BINARY</a> = 1,
  76 <a class="el" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da10047eb05b5e1c298151dc47a5b44826">LWS_WRITE_CONTINUATION</a> = 2,
  77 <a class="el" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193dabb6705e1d1327cdda5025be28f07712e">LWS_WRITE_HTTP</a> = 3,
  78 <br />
  79 &#160;&#160;<b>LWS_WRITE_PING</b> = 5,
  80 <b>LWS_WRITE_PONG</b> = 6,
  81 <b>LWS_WRITE_HTTP_FINAL</b> = 7,
  82 <a class="el" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193dafe5a38e940ce56708ac814627e9c0917">LWS_WRITE_HTTP_HEADERS</a> = 8,
  83 <br />
  84 &#160;&#160;<a class="el" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da115440f272a5d55518adfc8099acfee3">LWS_WRITE_NO_FIN</a> = 0x40,
  85 <a class="el" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da220d8e8652d9b97fb66e476e2a60ffce">LWS_WRITE_CLIENT_IGNORE_XOR_MASK</a> = 0x80
  86 <br />
  87  }</td></tr>
  88 <tr class="separator:ga98b099cf8c1c7e38ad78501f270e193d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 </table><table class="memberdecls">
  90 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  91 Functions</h2></td></tr>
  92 <tr class="memitem:gafd5fdd285a0e25ba7e3e1051deec1001"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sending-data.html#gafd5fdd285a0e25ba7e3e1051deec1001">lws_write</a> (struct lws *wsi, unsigned char *buf, size_t len, enum <a class="el" href="group__sending-data.html#ga98b099cf8c1c7e38ad78501f270e193d">lws_write_protocol</a> protocol)</td></tr>
  93 <tr class="separator:gafd5fdd285a0e25ba7e3e1051deec1001"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 </table>
  95 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  96 <p>APIs related to writing data on a connection </p>
  97 <h2 class="groupheader">Enumeration Type Documentation</h2>
  98 <a id="ga98b099cf8c1c7e38ad78501f270e193d"></a>
  99 <h2 class="memtitle"><span class="permalink"><a href="#ga98b099cf8c1c7e38ad78501f270e193d">&sect;&nbsp;</a></span>lws_write_protocol</h2>
 100
 101 <div class="memitem">
 102 <div class="memproto">
 103       <table class="memname">
 104         <tr>
 105           <td class="memname">enum <a class="el" href="group__sending-data.html#ga98b099cf8c1c7e38ad78501f270e193d">lws_write_protocol</a></td>
 106         </tr>
 107       </table>
 108 </div><div class="memdoc">
 109
 110 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 111 <table class="fieldtable">
 112 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga98b099cf8c1c7e38ad78501f270e193da80e8f169fda236c56bfb795ed62903db"></a>LWS_WRITE_TEXT&#160;</td><td class="fielddoc"><p>Send a ws TEXT message,the pointer must have LWS_PRE valid memory behind it. The receiver expects only valid utf-8 in the payload </p>
 113 </td></tr>
 114 <tr><td class="fieldname"><a id="gga98b099cf8c1c7e38ad78501f270e193daf6486c0dba50c44198100717721d9ab2"></a>LWS_WRITE_BINARY&#160;</td><td class="fielddoc"><p>Send a ws BINARY message, the pointer must have LWS_PRE valid memory behind it. Any sequence of bytes is valid </p>
 115 </td></tr>
 116 <tr><td class="fieldname"><a id="gga98b099cf8c1c7e38ad78501f270e193da10047eb05b5e1c298151dc47a5b44826"></a>LWS_WRITE_CONTINUATION&#160;</td><td class="fielddoc"><p>Continue a previous ws message, the pointer must have LWS_PRE valid memory behind it </p>
 117 </td></tr>
 118 <tr><td class="fieldname"><a id="gga98b099cf8c1c7e38ad78501f270e193dabb6705e1d1327cdda5025be28f07712e"></a>LWS_WRITE_HTTP&#160;</td><td class="fielddoc"><p>Send HTTP content </p>
 119 </td></tr>
 120 <tr><td class="fieldname"><a id="gga98b099cf8c1c7e38ad78501f270e193dafe5a38e940ce56708ac814627e9c0917"></a>LWS_WRITE_HTTP_HEADERS&#160;</td><td class="fielddoc"><p>Send http headers (http2 encodes this payload and LWS_WRITE_HTTP payload differently, http 1.x links also handle this correctly. so to be compatible with both in the future,header response part should be sent using this regardless of http version expected) </p>
 121 </td></tr>
 122 <tr><td class="fieldname"><a id="gga98b099cf8c1c7e38ad78501f270e193da115440f272a5d55518adfc8099acfee3"></a>LWS_WRITE_NO_FIN&#160;</td><td class="fielddoc"><p>This part of the message is not the end of the message </p>
 123 </td></tr>
 124 <tr><td class="fieldname"><a id="gga98b099cf8c1c7e38ad78501f270e193da220d8e8652d9b97fb66e476e2a60ffce"></a>LWS_WRITE_CLIENT_IGNORE_XOR_MASK&#160;</td><td class="fielddoc"><p>client packet payload goes out on wire unmunged only useful for security tests since normal servers cannot decode the content if used </p>
 125 </td></tr>
 126 </table>
 127 <div class="fragment"><div class="line"><a name="l03230"></a><span class="lineno"> 3230</span>&#160;                        {</div><div class="line"><a name="l03231"></a><span class="lineno"> 3231</span>&#160;        <a class="code" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da80e8f169fda236c56bfb795ed62903db">LWS_WRITE_TEXT</a>                                          = 0,</div><div class="line"><a name="l03235"></a><span class="lineno"> 3235</span>&#160;        <a class="code" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193daf6486c0dba50c44198100717721d9ab2">LWS_WRITE_BINARY</a>                                        = 1,</div><div class="line"><a name="l03238"></a><span class="lineno"> 3238</span>&#160;        <a class="code" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da10047eb05b5e1c298151dc47a5b44826">LWS_WRITE_CONTINUATION</a>                                  = 2,</div><div class="line"><a name="l03241"></a><span class="lineno"> 3241</span>&#160;        <a class="code" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193dabb6705e1d1327cdda5025be28f07712e">LWS_WRITE_HTTP</a>                                          = 3,</div><div class="line"><a name="l03244"></a><span class="lineno"> 3244</span>&#160;        <span class="comment">/* LWS_WRITE_CLOSE is handled by lws_close_reason() */</span></div><div class="line"><a name="l03245"></a><span class="lineno"> 3245</span>&#160;        LWS_WRITE_PING                                          = 5,</div><div class="line"><a name="l03246"></a><span class="lineno"> 3246</span>&#160;        LWS_WRITE_PONG                                          = 6,</div><div class="line"><a name="l03247"></a><span class="lineno"> 3247</span>&#160;</div><div class="line"><a name="l03248"></a><span class="lineno"> 3248</span>&#160;        <span class="comment">/* Same as write_http but we know this write ends the transaction */</span></div><div class="line"><a name="l03249"></a><span class="lineno"> 3249</span>&#160;        LWS_WRITE_HTTP_FINAL                                    = 7,</div><div class="line"><a name="l03250"></a><span class="lineno"> 3250</span>&#160;</div><div class="line"><a name="l03251"></a><span class="lineno"> 3251</span>&#160;        <span class="comment">/* HTTP2 */</span></div><div class="line"><a name="l03252"></a><span class="lineno"> 3252</span>&#160;</div><div class="line"><a name="l03253"></a><span class="lineno"> 3253</span>&#160;        <a class="code" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193dafe5a38e940ce56708ac814627e9c0917">LWS_WRITE_HTTP_HEADERS</a>                                  = 8,</div><div class="line"><a name="l03260"></a><span class="lineno"> 3260</span>&#160;        <span class="comment">/****** add new things just above ---^ ******/</span></div><div class="line"><a name="l03261"></a><span class="lineno"> 3261</span>&#160;</div><div class="line"><a name="l03262"></a><span class="lineno"> 3262</span>&#160;        <span class="comment">/* flags */</span></div><div class="line"><a name="l03263"></a><span class="lineno"> 3263</span>&#160;</div><div class="line"><a name="l03264"></a><span class="lineno"> 3264</span>&#160;        <a class="code" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da115440f272a5d55518adfc8099acfee3">LWS_WRITE_NO_FIN</a> = 0x40,</div><div class="line"><a name="l03267"></a><span class="lineno"> 3267</span>&#160;        <a class="code" href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da220d8e8652d9b97fb66e476e2a60ffce">LWS_WRITE_CLIENT_IGNORE_XOR_MASK</a> = 0x80</div><div class="line"><a name="l03271"></a><span class="lineno"> 3271</span>&#160;};</div><div class="ttc" id="group__sending-data_html_gga98b099cf8c1c7e38ad78501f270e193dabb6705e1d1327cdda5025be28f07712e"><div class="ttname"><a href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193dabb6705e1d1327cdda5025be28f07712e">LWS_WRITE_HTTP</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:3241</div></div>
 128 <div class="ttc" id="group__sending-data_html_gga98b099cf8c1c7e38ad78501f270e193da115440f272a5d55518adfc8099acfee3"><div class="ttname"><a href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da115440f272a5d55518adfc8099acfee3">LWS_WRITE_NO_FIN</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:3264</div></div>
 129 <div class="ttc" id="group__sending-data_html_gga98b099cf8c1c7e38ad78501f270e193da80e8f169fda236c56bfb795ed62903db"><div class="ttname"><a href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da80e8f169fda236c56bfb795ed62903db">LWS_WRITE_TEXT</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:3231</div></div>
 130 <div class="ttc" id="group__sending-data_html_gga98b099cf8c1c7e38ad78501f270e193daf6486c0dba50c44198100717721d9ab2"><div class="ttname"><a href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193daf6486c0dba50c44198100717721d9ab2">LWS_WRITE_BINARY</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:3235</div></div>
 131 <div class="ttc" id="group__sending-data_html_gga98b099cf8c1c7e38ad78501f270e193da220d8e8652d9b97fb66e476e2a60ffce"><div class="ttname"><a href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da220d8e8652d9b97fb66e476e2a60ffce">LWS_WRITE_CLIENT_IGNORE_XOR_MASK</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:3267</div></div>
 132 <div class="ttc" id="group__sending-data_html_gga98b099cf8c1c7e38ad78501f270e193da10047eb05b5e1c298151dc47a5b44826"><div class="ttname"><a href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193da10047eb05b5e1c298151dc47a5b44826">LWS_WRITE_CONTINUATION</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:3238</div></div>
 133 <div class="ttc" id="group__sending-data_html_gga98b099cf8c1c7e38ad78501f270e193dafe5a38e940ce56708ac814627e9c0917"><div class="ttname"><a href="group__sending-data.html#gga98b099cf8c1c7e38ad78501f270e193dafe5a38e940ce56708ac814627e9c0917">LWS_WRITE_HTTP_HEADERS</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:3253</div></div>
 134 </div><!-- fragment -->
 135 </div>
 136 </div>
 137 <h2 class="groupheader">Function Documentation</h2>
 138 <a id="gafd5fdd285a0e25ba7e3e1051deec1001"></a>
 139 <h2 class="memtitle"><span class="permalink"><a href="#gafd5fdd285a0e25ba7e3e1051deec1001">&sect;&nbsp;</a></span>lws_write()</h2>
 140
 141 <div class="memitem">
 142 <div class="memproto">
 143       <table class="memname">
 144         <tr>
 145           <td class="memname">LWS_VISIBLE LWS_EXTERN int lws_write </td>
 146           <td>(</td>
 147           <td class="paramtype">struct lws *&#160;</td>
 148           <td class="paramname"><em>wsi</em>, </td>
 149         </tr>
 150         <tr>
 151           <td class="paramkey"></td>
 152           <td></td>
 153           <td class="paramtype">unsigned char *&#160;</td>
 154           <td class="paramname"><em>buf</em>, </td>
 155         </tr>
 156         <tr>
 157           <td class="paramkey"></td>
 158           <td></td>
 159           <td class="paramtype">size_t&#160;</td>
 160           <td class="paramname"><em>len</em>, </td>
 161         </tr>
 162         <tr>
 163           <td class="paramkey"></td>
 164           <td></td>
 165           <td class="paramtype">enum <a class="el" href="group__sending-data.html#ga98b099cf8c1c7e38ad78501f270e193d">lws_write_protocol</a>&#160;</td>
 166           <td class="paramname"><em>protocol</em>&#160;</td>
 167         </tr>
 168         <tr>
 169           <td></td>
 170           <td>)</td>
 171           <td></td><td></td>
 172         </tr>
 173       </table>
 174 </div><div class="memdoc">
 175
 176 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 177 <p><a class="el" href="group__sending-data.html#gafd5fdd285a0e25ba7e3e1051deec1001">lws_write()</a> - Apply protocol then write data to client </p><dl class="params"><dt>Parameters</dt><dd>
 178   <table class="params">
 179     <tr><td class="paramname">wsi</td><td>Websocket instance (available from user callback) </td></tr>
 180     <tr><td class="paramname">buf</td><td>The data to send. For data being sent on a websocket connection (ie, not default http), this buffer MUST have LWS_PRE bytes valid BEFORE the pointer. This is so the protocol header data can be added in-situ. </td></tr>
 181     <tr><td class="paramname">len</td><td>Count of the data bytes in the payload starting from buf </td></tr>
 182     <tr><td class="paramname">protocol</td><td>Use LWS_WRITE_HTTP to reply to an http connection, and one of LWS_WRITE_BINARY or LWS_WRITE_TEXT to send appropriate data on a websockets connection. Remember to allow the extra bytes before and after buf if LWS_WRITE_BINARY or LWS_WRITE_TEXT are used.</td></tr>
 183   </table>
 184   </dd>
 185 </dl>
 186 <p>This function provides the way to issue data back to the client for both http and websocket protocols.</p>
 187 <p>IMPORTANT NOTICE!</p>
 188 <p>When sending with websocket protocol</p>
 189 <p>LWS_WRITE_TEXT, LWS_WRITE_BINARY, LWS_WRITE_CONTINUATION, LWS_WRITE_PING, LWS_WRITE_PONG</p>
 190 <p>the send buffer has to have LWS_PRE bytes valid BEFORE the buffer pointer you pass to <a class="el" href="group__sending-data.html#gafd5fdd285a0e25ba7e3e1051deec1001">lws_write()</a>.</p>
 191 <p>This allows us to add protocol info before and after the data, and send as one packet on the network without payload copying, for maximum efficiency.</p>
 192 <p>So for example you need this kind of code to use lws_write with a 128-byte payload</p>
 193 <p>char buf[LWS_PRE + 128];</p>
 194 <p>// fill your part of the buffer... for example here it's all zeros memset(&amp;buf[LWS_PRE], 0, 128);</p>
 195 <p>lws_write(wsi, &amp;buf[LWS_PRE], 128, LWS_WRITE_TEXT);</p>
 196 <p>When sending HTTP, with</p>
 197 <p>LWS_WRITE_HTTP, LWS_WRITE_HTTP_HEADERS LWS_WRITE_HTTP_FINAL</p>
 198 <p>there is no protocol data prepended, and don't need to take care about the LWS_PRE bytes valid before the buffer pointer.</p>
 199 <p>LWS_PRE is at least the frame nonce + 2 header + 8 length LWS_SEND_BUFFER_POST_PADDING is deprecated, it's now 0 and can be left off. The example apps no longer use it.</p>
 200 <p>Pad LWS_PRE to the CPU word size, so that word references to the address immediately after the padding won't cause an unaligned access error. Sometimes for performance reasons the recommended padding is even larger than sizeof(void *). </p><pre class="fragment"> In the case of sending using websocket protocol, be sure to allocate
 201  valid storage before and after buf as explained above.  This scheme
 202  allows maximum efficiency of sending data and protocol in a single
 203  packet while not burdening the user code with any protocol knowledge.
 204
 205  Return may be -1 for a fatal error needing connection close, or the
 206  number of bytes sent.
 207 </pre><h1>Truncated Writes </h1>
 208 <p>The OS may not accept everything you asked to write on the connection.</p>
 209 <p>Posix defines POLLOUT indication from poll() to show that the connection will accept more write data, but it doesn't specifiy how much. It may just accept one byte of whatever you wanted to send.</p>
 210 <p>LWS will buffer the remainder automatically, and send it out autonomously.</p>
 211 <p>During that time, WRITABLE callbacks will be suppressed.</p>
 212 <p>This is to handle corner cases where unexpectedly the OS refuses what we usually expect it to accept. You should try to send in chunks that are almost always accepted in order to avoid the inefficiency of the buffering. </p>
 213
 214 </div>
 215 </div>
 216 </div><!-- contents -->
 217 </div><!-- doc-content -->
 218 <!-- start footer part -->
 219 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 220   <ul>
 221     <li class="footer">Generated by
 222     <a href="http://www.doxygen.org/index.html">
 223     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
 224   </ul>
 225 </div>
 226 </body>
 227 </html>