reference/sockets/functions/socket-sendto.xml
14dc7c47365f2b71f6c907a5ba5bccf42534d5a9
14dc7c47365f2b71f6c907a5ba5bccf42534d5a9
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-sendto">
3
+
<refentry xml:id="function.socket-sendto" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>socket_sendto</refname>
6
6
<refpurpose>Sends a message to a socket, whether it is connected or not </refpurpose>
...
...
@@ -9,19 +9,19 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>int</type><methodname>socket_sendto</methodname>
13
-
<methodparam><type>resource</type><parameter>socket</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter>buf</parameter></methodparam>
15
-
<methodparam><type>int</type><parameter>len</parameter></methodparam>
12
+
<type class="union"><type>int</type><type>false</type></type><methodname>socket_sendto</methodname>
13
+
<methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
14
+
<methodparam><type>string</type><parameter>data</parameter></methodparam>
15
+
<methodparam><type>int</type><parameter>length</parameter></methodparam>
16
16
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
17
-
<methodparam><type>string</type><parameter>addr</parameter></methodparam>
18
-
<methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>0</initializer></methodparam>
17
+
<methodparam><type>string</type><parameter>address</parameter></methodparam>
18
+
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>port</parameter><initializer>&null;</initializer></methodparam>
19
19
</methodsynopsis>
20
20
<para>
21
21
The function <function>socket_sendto</function> sends
22
-
<parameter>len</parameter> bytes from <parameter>buf</parameter>
22
+
<parameter>length</parameter> bytes from <parameter>data</parameter>
23
23
through the socket <parameter>socket</parameter> to the
24
-
<parameter>port</parameter> at the address <parameter>addr</parameter>.
24
+
<parameter>port</parameter> at the address <parameter>address</parameter>.
25
25
</para>
26
26
</refsect1>
27
27
...
...
@@ -33,23 +33,23 @@
33
33
<term><parameter>socket</parameter></term>
34
34
<listitem>
35
35
<para>
36
-
A valid socket resource created using <function>socket_create</function>.
36
+
A <classname>Socket</classname> instance created using <function>socket_create</function>.
37
37
</para>
38
38
</listitem>
39
39
</varlistentry>
40
40
<varlistentry>
41
-
<term><parameter>buf</parameter></term>
41
+
<term><parameter>data</parameter></term>
42
42
<listitem>
43
43
<para>
44
-
The sent data will be taken from buffer <parameter>buf</parameter>.
44
+
The sent data will be taken from buffer <parameter>data</parameter>.
45
45
</para>
46
46
</listitem>
47
47
</varlistentry>
48
48
<varlistentry>
49
-
<term><parameter>len</parameter></term>
49
+
<term><parameter>length</parameter></term>
50
50
<listitem>
51
51
<para>
52
-
<parameter>len</parameter> bytes from <parameter>buf</parameter> will be
52
+
<parameter>length</parameter> bytes from <parameter>data</parameter> will be
53
53
sent.
54
54
</para>
55
55
</listitem>
...
...
@@ -98,7 +98,7 @@
98
98
</listitem>
99
99
</varlistentry>
100
100
<varlistentry>
101
-
<term><parameter>addr</parameter></term>
101
+
<term><parameter>address</parameter></term>
102
102
<listitem>
103
103
<para>
104
104
IP address of the remote host.
...
...
@@ -126,6 +126,28 @@
126
126
</para>
127
127
</refsect1>
128
128
129
+
<refsect1 role="changelog">
130
+
&reftitle.changelog;
131
+
<informaltable>
132
+
<tgroup cols="2">
133
+
<thead>
134
+
<row>
135
+
<entry>&Version;</entry>
136
+
<entry>&Description;</entry>
137
+
</row>
138
+
</thead>
139
+
<tbody>
140
+
&sockets.changelog.socket-param;
141
+
<row>
142
+
<entry>8.0.0</entry>
143
+
<entry>
144
+
<parameter>port</parameter> is nullable now.
145
+
</entry>
146
+
</row>
147
+
</tbody>
148
+
</tgroup>
149
+
</informaltable>
150
+
</refsect1>
129
151
130
152
<refsect1 role="examples">
131
153
&reftitle.examples;
...
...
@@ -159,7 +181,6 @@
159
181
</refsect1>
160
182
161
183
</refentry>
162
-
163
184
<!-- Keep this comment at the end of the file
164
185
Local variables:
165
186
mode: sgml
166
187