autodoc.git / traditional_manual / chapter_9.html

version» Context lines:

autodoc.git/traditional_manual/chapter_9.html:1836:   <dd><p><code><code class='datatype'>int</code> <b><span class='method'>send</span>(</b><code class='datatype'>string</code> <code class='argument'>to</code>, <code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>port</code>, <code class='datatype'>string</code> <code class='argument'>message</code><b>)</b></code><br>   <code><code class='datatype'>int</code> <b><span class='method'>send</span>(</b><code class='datatype'>string</code> <code class='argument'>to</code>, <code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>port</code>, <code class='datatype'>string</code> <code class='argument'>message</code>, <code class='datatype'>int</code> <code class='argument'>flags</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Send data to a UDP socket. The recipient address will be <code>to</code>    and port will be <code>port</code>.</p>   <p> Flag <code>flag</code> is a bitfield, 1 for out of band data and    2 for don't route flag.</p>   </dd>   <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><p>The number of bytes that were actually written.</p> + <dd class='body--doc'><table class='box'><tr><td><code><code class='key'>(0..)</code></code></td><td><p>The number of bytes that were actually written.</p> + </td></tr> + <tr><td><code><code class='key'>(..-1)</code></code></td><td><p>Failed to send the <code>message</code>. Check <code>errno()</code> for +  the cause. Common causes are:</p> + <table class='box'><tr><td><code><code class='key'>System.EMSGSIZE</code></code></td><td><p>The <code>message</code> is too large to send unfragmented.</p> + </td></tr> + <tr><td><code><code class='key'>System.EWOULDBLOCK</code></code></td><td><p>The send buffers are full.</p> + </td></tr> + </table></td></tr> + </table> + </dd> + <dt class='head--doc'>Throws</dt> + <dd class='body--doc'><p>Throws errors on invalid arguments and uninitialized object.</p> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'><p>Versions of Pike prior to 8.1.5 threw errors also on EMSGSIZE +  (<code class='expr'>"Too&nbsp;big&nbsp;message"</code>) and EWOULDBLOCK +  .(<code class='expr'>"Message&nbsp;would&nbsp;block."</code>). These versions of Pike also +  did not update the object errno on this function failing.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>set_backend</b></span>   </dt>   <dd><p><code><code class='datatype'>void</code> <b><span class='method'>set_backend</span>(</b><code class='object unresolved'>Pike.Backend</code> <code class='argument'>backend</code><b>)</b></code></p></dd>