-
Notifications
You must be signed in to change notification settings - Fork 50
/
stream-socket-client.xml
253 lines (243 loc) · 8.75 KB
/
stream-socket-client.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: seros Status: ready -->
<refentry xml:id="function.stream-socket-client" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stream_socket_client</refname>
<refpurpose>Abrir una conexión de socket de dominio de Internet o Unix</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>stream_socket_client</methodname>
<methodparam><type>string</type><parameter>remote_socket</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">errno</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter role="reference">errstr</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>timeout</parameter><initializer>ini_get("default_socket_timeout")</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>STREAM_CLIENT_CONNECT</initializer></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
<para>
Inicia una conexión de flujo o datagrama al destino especificado
por <parameter>remote_socket</parameter>. El tipo de socket creado
se determina por el transporte especificado usando el formato de URL estándar:
<literal>transporte://objetivo</literal>. Para sockets de Dominio de Internet
(AF_INET) como TCP y UDP, la porción del <literal>objetivo</literal>
del parámetro <parameter>remote_socket</parameter> debería consistir en
un nombre de host o dirección IP seguida de dos puntos y un número de puerto. Para sockets
de dominio de Unix, la porción de <parameter>target</parameter> apuntará
al archivo de socket del sistema de archivos.
</para>
<note>
<para>
El flujo será abierto por defecto en modo de bloqueo. Se puede
cambiar al modo de no bloqueo usando
<function>stream_set_blocking</function>.
</para>
</note>
</refsect1>
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>remote_socket</parameter></term>
<listitem>
<para>
Dirección del socket al que se va a conectar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>errno</parameter></term>
<listitem>
<para>
Será establecido al número de error a nivel de sistema si la conexión falla.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>errstr</parameter></term>
<listitem>
<para>
Será establecido al mensaje de error a nivel de sistema si la conexión falla.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
Número de segundos hasta que la llamda al sistema de <literal>connect()</literal>
debería esperar.
<note>
<simpara>
Este parámetro sólo se aplica cuando no se hace un intento de
conexión asíncrona.
</simpara>
</note>
<note>
<para>
Para establecer un tiempo de espera para lectura/escritura de información sobre el socket,
use la función <function>stream_set_timeout</function>, ya que
<parameter>timeout</parameter> sólo se aplica mientras se hace una conexión
al socket.
</para>
</note>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Campo de máscara de bits que puede ser establecido a cualquier combinación de banderas de conexión.
Actualmente la selección de banderas de conexión está limitada a
<constant>STREAM_CLIENT_CONNECT</constant> (por defecto),
<constant>STREAM_CLIENT_ASYNC_CONNECT</constant> y
<constant>STREAM_CLIENT_PERSISTENT</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
Un recurso de contexto válido creado con <function>stream_context_create</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
Si se tuvo éxito, un recurso de flujo es devuelto, el cuál se puede
usar junto con las demás funciones de archivo (tales como
<function>fgets</function>, <function>fgetss</function>,
<function>fwrite</function>, <function>fclose</function>, y
<function>feof</function>), &false; si falló.
</para>
</refsect1><!-- }}} -->
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
Si falló, los argumentos <parameter>errno</parameter> y
<parameter>errstr</parameter> serán rellenados con el error
a nivel de sistema actual que ocurrió en la llamda a nivel de
sistema de <literal>connect()</literal>. Si el valor devuelto en
<parameter>errno</parameter> es <literal>0</literal> y la
función devolvió &false;, es una indicación de que el error
ocurrió antes de la llamada a <literal>connect()</literal>. Esto es
lo más probable debido a un problema de inicialización del socket. Observe que
los argumentos <parameter>errno</parameter> y
<parameter>errstr</parameter> siempre serán pasados por
referencia.
</para>
</refsect1><!-- }}} -->
<refsect1 role="examples"><!-- {{{ -->
&reftitle.examples;
<para>
<example xml:id="stream-socket-client.example.basic"><!-- {{{ -->
<title>Ejemplo de <function>stream_socket_client</function></title>
<programlisting role="php">
<![CDATA[
<?php
$fp = stream_socket_client("tcp://www.example.com:80", $errno, $errstr, 30);
if (!$fp) {
echo "$errstr ($errno)<br />\n";
} else {
fwrite($fp, "GET / HTTP/1.0\r\nHost: www.example.com\r\nAccept: */*\r\n\r\n");
while (!feof($fp)) {
echo fgets($fp, 1024);
}
fclose($fp);
}
?>
]]>
</programlisting>
</example><!-- }}} -->
<example xml:id="stream-socket-client.example.daytime"><!-- {{{ -->
<title>Usar una conexión UDP</title>
<para>
Recuperar el día y la hora desde el servicio "daytime" de UDP (puerto 13)
en localhost.
</para>
<programlisting role="php">
<![CDATA[
<?php
$fp = stream_socket_client("udp://127.0.0.1:13", $errno, $errstr);
if (!$fp) {
echo "ERROR: $errno - $errstr<br />\n";
} else {
fwrite($fp, "\n");
echo fread($fp, 26);
fclose($fp);
}
?>
]]>
</programlisting>
</example><!-- }}} -->
</para>
</refsect1><!-- }}} -->
<refsect1 role="notes"><!-- {{{ -->
&reftitle.notes;
<warning>
<simpara>
Los sockects UDP a veces parecerán estar abiertos sin un error,
incluso si el host remoto es inalcanzable. El error sólo
aparecerá cuando se lea o escriba información desde/en el socket.
La razón de esto es que UDP es un protocolo no orientado a conexión,
lo que significa que el sistema operativo no intenta establecer
un enlace para el socket hasta que se necesite enviar o recibir informaicón.
</simpara>
</warning>
&ipv6.brackets;
<note>
<para>
Dependiendo del entorno, pueden no estar disponibles el dominio Unix
o el tiempo de espera opcional de la conexión. Una lista de transportes
disponibles se puede recuperar unsando <function>stream_get_transports</function>.
Véase <xref linkend="transports"/> para una lista de transportes incluidos.
</para>
</note>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
<para>
<simplelist>
<member><function>stream_socket_server</function></member>
<member><function>stream_set_blocking</function></member>
<member><function>stream_set_timeout</function></member>
<member><function>stream_select</function></member>
<member><function>fgets</function></member>
<member><function>fgetss</function></member>
<member><function>fwrite</function></member>
<member><function>fclose</function></member>
<member><function>feof</function></member>
<member><xref linkend="ref.curl" /></member>
</simplelist>
</para>
</refsect1><!-- }}} -->
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->