autodoc.git
/
traditional.xml
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/traditional.xml:1:
<?xml version='1.0' encoding='utf-8'?>
-
<manual time-stamp='2020-04-
25
' version='Pike v8.1.13'>
+
<manual time-stamp='2020-04-
26
' version='Pike v8.1.13'>
<dir name='./traditional_manual'> <file name='./traditional_manual/index.html'> <chapter title='Table of Contents' unnumbered='1'> <dl><dt><url href='index.html'>Table of Contents</url></dt> <dt><url href='chapter_1.html'>1. Introduction</url></dt> <dd><url href='chapter_1.html#1.1'>1.1. Overview</url></dd> <dd><url href='chapter_1.html#1.2'>1.2. The history of Pike</url></dd> <dd><url href='chapter_1.html#1.3'>1.3. A comparison with other languages</url></dd> <dd><url href='chapter_1.html#1.4'>1.4. What is Pike</url></dd> <dd><url href='chapter_1.html#1.5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:8658:
</text></group></doc> <method name='read'> <arguments/> <returntype><mapping><indextype><string/></indextype><valuetype><or><int/><string/></or></valuetype></mapping></returntype> </method> <method name='read'> <arguments><argument name='flag'><type><int/></type></argument></arguments> <returntype><mapping><indextype><string/></indextype><valuetype><or><int/><string/></or></valuetype></mapping></returntype> </method> </docgroup>
-
<docgroup homogen-name='send' homogen-type='method'><doc><text><p>Send data to a UDP socket. The recipient address
will
be
<ref resolved='predef::Stdio.UDP.
send.to
'>
to
</ref>
-
and
port
will
be
<ref resolved='predef::
Stdio
.
UDP.send.port
'>
port
</ref>.</p>
-
<p>
Flag
<ref>
flag
</ref>
is
a
bitfield
,
1 for out of band data and
-
2 for don't route flag.</p>
-
</text><group><returns/><text><int><group><value><minvalue>0</minvalue></value><text><p>The number of bytes that were actually written.</p>
+
<docgroup homogen-name='send' homogen-type='method'><doc><text><p>Send data to a UDP socket.
</p>
+
</text><group><param
name='to'/><text><p>
The recipient address
.
For
<ref resolved='predef::Stdio.UDP.
connect
'>
connect()
</ref>
ed objects specifying a
+
recipient
of
either
<ref resolved='predef::.
UNDEFINED
'>
UNDEFINED
</ref>
or <expr>""</expr> causes the default
+
recipient to be used
.</p>
+
<
/text></group><group><param name='port'/><text><
p>
The
recipient
port number. For
<ref
resolved='predef::Stdio.UDP.connect'
>
connect()
</ref>
ed
objects
specifying
+
port number <expr>0</expr> casues the default recipient port to be used.</p>
+
</text></group><group><param name='flag'/><text><p>A flag
bitfield
with <expr>
1
</expr>
for out of band data and
+
<expr>
2
</expr>
for don't route flag.</p>
+
</text><
/
group><
group><
returns/><text><int><group><value><minvalue>0</minvalue></value><text><p>The number of bytes that were actually written.</p>
</text></group><group><value><maxvalue>-1</maxvalue></value><text><p>Failed to send the <ref resolved='predef::Stdio.UDP.send.message'>message</ref>. Check <ref resolved='predef::Stdio.UDP.errno'>errno()</ref> for the cause. Common causes are:</p> <int><group><value>System.EMSGSIZE</value><text><p>The <ref resolved='predef::Stdio.UDP.send.message'>message</ref> is too large to send unfragmented.</p> </text></group><group><value>System.EWOULDBLOCK</value><text><p>The send buffers are full.</p> </text></group></int></text></group></int> </text></group><group><throws/><text><p>Throws errors on invalid arguments and uninitialized object.</p> </text></group><group><note/><text><p>Versions of Pike prior to 8.1.5 threw errors also on EMSGSIZE (<expr>"Too big message"</expr>) and EWOULDBLOCK
-
.
(<expr>"Message would block."</expr>). These versions of Pike also
+
(<expr>"Message would block."</expr>). These versions of Pike also
did not update the object errno on this function failing.</p>
-
+
</text></group><group><note/><text><p>Versions of Pike prior to 8.1.13 did not support the default
+
recipient for <ref resolved='predef::Stdio.UDP.connect'>connect()</ref>ed objects.</p>
+
</text></group><group><seealso/><text><p><ref resolved='predef::Stdio.UDP.connect'>connect()</ref>, <ref resolved='predef::Stdio.UDP.errno'>errno()</ref>, <ref resolved='predef::Stdio.UDP.query_mtu'>query_mtu()</ref></p>
</text></group></doc> <method name='send'> <arguments><argument name='to'><type><string/></type></argument><argument name='port'><type><or><int/><string/></or></type></argument><argument name='message'><type><string/></type></argument></arguments> <returntype><int/></returntype> </method> <method name='send'> <arguments><argument name='to'><type><string/></type></argument><argument name='port'><type><or><int/><string/></or></type></argument><argument name='message'><type><string/></type></argument><argument name='flags'><type><int/></type></argument></arguments> <returntype><int/></returntype> </method> </docgroup>