autodoc.git/ traditional_manual/ chapter_9.html

Branch: Tag:

2020-04-26

2020-04-26 13:37:29 by Henrik Grubbström (Grubba) <grubba@grubba.org>

Stdio.UDP: Support the default destination in send().

2405:   <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 class='body--doc'><p>Send data to a UDP socket.</p>   </dd> -  + <dt class='head--doc'><span id='p-to'></span>Parameter <code class='parameter'>to</code></dt> + <dd></dd><dd class='body--doc'><p>The recipient address. For <code>connect()</code>ed objects specifying a +  recipient of either <code>UNDEFINED</code> or <code class='expr'>""</code> causes the default +  recipient to be used.</p> + </dd> + <dt class='head--doc'><span id='p-port'></span>Parameter <code class='parameter'>port</code></dt> + <dd></dd><dd class='body--doc'><p>The recipient port number. For <code>connect()</code>ed objects specifying +  port number <code class='expr'>0</code> casues the default recipient port to be used.</p> + </dd> + <dt class='head--doc'><span id='p-flag'></span>Parameter <code class='parameter'>flag</code></dt> + <dd></dd><dd class='body--doc'><p>A flag bitfield with <code class='expr'>1</code> for out of band data and +  <code class='expr'>2</code> for don't route flag.</p> + </dd>   <dt class='head--doc'>Returns</dt>   <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>
2428:   <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 +  (<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> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'><p>Versions of Pike prior to 8.1.13 did not support the default +  recipient for <code>connect()</code>ed objects.</p> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><p><code>connect()</code>, <code>errno()</code>, <code>query_mtu()</code></p>   </dd></dl>