-
Notifications
You must be signed in to change notification settings - Fork 164
Expand file tree
/
Copy pathfsockopen.xml
More file actions
268 lines (257 loc) · 8.51 KB
/
fsockopen.xml
File metadata and controls
268 lines (257 loc) · 8.51 KB
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4e6f0774f03131cbeeb8c21019a690bf97fd22b6 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.fsockopen" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fsockopen</refname>
<refpurpose>Ouvre un socket de connexion Internet ou Unix</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>fsockopen</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">error_code</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter role="reference">error_message</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>float</type><type>null</type></type><parameter>timeout</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Initialise une connexion par socket à la ressource spécifiée par
<parameter>hostname</parameter>.
</para>
<para>
PHP supporte les cibles dans les domaines Internet et Unix comme décrit dans
<xref linkend="transports"/>. Une liste des types de transports peut également
être trouvée en utilisant la fonction <function>stream_get_transports</function>.
</para>
<para>
Le socket sera ouvert par défaut en mode bloquant. L'on peut
changer de mode en utilisant : <function>stream_set_blocking</function>.
</para>
<para>
La fonction <function>stream_socket_client</function> est similaire
mais fournit plus d'options, incluant la connexion non-bloquante
et la possibilité de fournir un contexte de flux.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
<para>
Si le support OpenSSL <link linkend="openssl.installation">est
installé</link>, il est possible de préfixer <parameter>hostname</parameter>
avec <literal>ssl://</literal> ou <literal>tls://</literal> pour utiliser
une connexion cliente SSL ou TLS sur TCP/IP pour se connecter à l'hôte
distant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
Le numéro du port. Ce paramètre peut être omis et ignoré
en utilisant la valeur <literal>-1</literal> pour les transports
qui n'utilisent pas les ports, comme <literal>unix://</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>error_code</parameter></term>
<listitem>
<para>
Si fourni, contient le numéro de l'erreur système qui survient
lors de l'appel système à <literal>connect()</literal>.
</para>
<para>
Si la valeur retournée par <parameter>error_code</parameter> est
<literal>0</literal> et que la fonction retourne &false;, ce peut
être une indication laissant penser que l'erreur est survenue
avant l'appel à <literal>connect()</literal>. La plupart du temps,
cela est dû à un problème d'initialisation du socket.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>error_message</parameter></term>
<listitem>
<para>
Le message d'erreur, sous la forme d'une &string;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
Le délai d'attente maximal, en secondes. Si &null; le paramètre &php.ini;
<link linkend="ini.default-socket-timeout">default_socket_timeout</link> est utilisé.
</para>
<note>
<para>
Si on a besoin de définir un délai limite pour lire/écrire des
données à travers ce socket, utiliser la fonction
<function>stream_set_timeout</function>, car le paramètre
<parameter>timeout</parameter> de la fonction
<function>fsockopen</function> est uniquement appliqué lors de la
connexion du socket.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>fsockopen</function> retourne un pointeur de fichier qui peut
être utilisé avec d'autres fonctions fichiers, telles
<function>fgets</function>, <function>fgetss</function>,
<function>fputs</function>, <function>fclose</function> et
<function>feof</function>. Si l'appel échoue, la fonction retourne
&false;.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Lance une alerte de type <constant>E_WARNING</constant> si le paramètre
<parameter>hostname</parameter> n'est pas un domaine valide.
</para>
</refsect1>
<refsect1 role="changelog"><!-- {{{ -->
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>timeout</parameter> est désormais nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>fsockopen</function></title>
<programlisting role="php">
<![CDATA[
<?php
$fp = fsockopen("www.example.com", 80, $errno, $errstr, 30);
if (!$fp) {
echo "$errstr ($errno)<br />\n";
} else {
$out = "GET / HTTP/1.1\r\n";
$out .= "Host: www.example.com\r\n";
$out .= "Connection: Close\r\n\r\n";
fwrite($fp, $out);
while (!feof($fp)) {
echo fgets($fp, 128);
}
fclose($fp);
}
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Utilisation d'une connexion UDP</title>
<para>
L'exemple ci-dessous décrit comment lire la date et l'heure grâce à
un service UDP "daytime" (port 13), sur sa propre machine.
</para>
<programlisting role="php">
<![CDATA[
<?php
$fp = fsockopen("udp://127.0.0.1", 13, $errno, $errstr);
if (!$fp) {
echo "ERREUR : $errno - $errstr<br />\n";
} else {
fwrite($fp, "\n");
echo fread($fp, 26);
fclose($fp);
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
Suivant les environnements, le type 'domaine Unix' ou l'option
<parameter>timeout</parameter> ne sont pas toujours disponibles.
</para>
</note>
<warning>
<para>
Les sockets UDP semblent quelques fois avoir été ouverts sans erreur,
même si l'hôte distant n'est pas accessible. L'erreur apparaît alors
uniquement lorsqu'on tente de lire/écrire sur le socket.
La raison de cela est que UDP est un protocole <literal>"connectionless"</literal>,
ce qui signifie que le système ne tentera pas d'établir un lien pour le socket
tant qu'il ne doit pas recevoir/envoyer de données.
</para>
</warning>
&ipv6.brackets;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pfsockopen</function></member>
<member><function>stream_socket_client</function></member>
<member><function>stream_set_blocking</function></member>
<member><function>stream_set_timeout</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><function>socket_connect</function></member>
<member>L'<link linkend="ref.curl">extension Curl</link></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
-->