mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 07:02:08 +01:00
279 lines
10 KiB
XML
279 lines
10 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 181e9c5572ed04ed712b8d7f858f61a94647c6ac Maintainer: hirokawa Status: ready -->
|
|
<refentry xml:id="function.stream-socket-client" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>stream_socket_client</refname>
|
|
<refpurpose>インターネットドメインまたは Unix ドメインのソケット接続を開く</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>resource</type><type>false</type></type><methodname>stream_socket_client</methodname>
|
|
<methodparam><type>string</type><parameter>address</parameter></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>
|
|
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>STREAM_CLIENT_CONNECT</constant></initializer></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<parameter>address</parameter> で指定された接続先との、
|
|
ストリームまたはデータグラム接続を確立します。
|
|
作成されるソケットのタイプは、<literal>[トランスポート]://[ターゲット]</literal>
|
|
という形式の URL フォーマットによって指定された
|
|
トランスポートによって決定されます。
|
|
TCP や UDP といったインターネットドメインのソケット (AF_INET)
|
|
には、<parameter>address</parameter> パラメータの
|
|
<literal>ターゲット</literal> の部分は、ホスト名または IP アドレスと、
|
|
それに続くコロンで区切られたポート番号から構成されていなければなりません。
|
|
Unix ドメインのソケットの場合は、<literal>ターゲット</literal>
|
|
の部分は、ファイルシステムにおけるソケットのファイルを指定しなくては
|
|
いけません。
|
|
</para>
|
|
<note>
|
|
<para>
|
|
ストリームはデフォルトではブロックモードで開かれますが、
|
|
<function>stream_set_blocking</function> を使うことで非ブロックモードに
|
|
変更することができます。
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters"><!-- {{{ -->
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>address</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
接続するソケットのアドレス。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>error_code</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
接続に失敗した場合にシステムレベルのエラー番号が設定されます。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>error_message</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
接続に失敗した場合にシステムレベルのエラーメッセージが設定されます。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>timeout</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<literal>connect()</literal> システムコールがタイムアウトとなるまでの秒数。
|
|
デフォルトでは、
|
|
<link linkend="ini.default-socket-timeout">default_socket_timeout</link>
|
|
の値を使います。
|
|
<note>
|
|
<simpara>
|
|
このパラメータが適用されるのは、非同期通信を試みていない場合のみです。
|
|
</simpara>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
ソケット上のデータの読み書きに関してタイムアウトを設定する必要がある場合は、
|
|
<function>stream_set_timeout</function> を使ってください。
|
|
<function>stream_socket_client</function> に渡される
|
|
<parameter>timeout</parameter> は、ソケットの接続時にのみ適用されます。
|
|
</para>
|
|
</note>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
接続設定フラグの任意の組み合わせを指定できるビットフィールドです。
|
|
現在、接続設定フラグとして選択できる値は、
|
|
<constant>STREAM_CLIENT_CONNECT</constant>（デフォルト）、
|
|
<constant>STREAM_CLIENT_ASYNC_CONNECT</constant> と
|
|
<constant>STREAM_CLIENT_PERSISTENT</constant> のみです。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>context</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<function>stream_context_create</function> で作成した有効なコンテキストリソース。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="returnvalues"><!-- {{{ -->
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
成功した場合に、
|
|
<function>fgets</function>, <function>fgetss</function>,
|
|
<function>fwrite</function>, <function>fclose</function>,
|
|
<function>feof</function> といった、ファイル関数と共に使うことのできるストリームリソースを返します。
|
|
</para>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="errors"><!-- {{{ -->
|
|
&reftitle.errors;
|
|
<para>
|
|
失敗した場合は、<parameter>error_code</parameter> と
|
|
<parameter>error_message</parameter> に
|
|
システムレベルの <literal>connect()</literal>
|
|
関数の実行時に発生したシステムレベルのエラーを表す値を返します。
|
|
もし、<parameter>error_code</parameter> に返された値が <literal>0</literal>
|
|
で、かつ、 この関数が &false; を返した時は、
|
|
<literal>connect()</literal> システムコールの前に何らかのエラーが
|
|
発生したことを示しています。これは、多くの場合、ソケットの初期化
|
|
に失敗したことで起こります。<parameter>error_code</parameter> と
|
|
<parameter>error_message</parameter> パラメータは常に参照渡しされることに
|
|
留意してください。
|
|
</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> と
|
|
<parameter>context</parameter> は、nullable になりました。
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples"><!-- {{{ -->
|
|
&reftitle.examples;
|
|
<para>
|
|
<example xml:id="stream-socket-client.example.basic"><!-- {{{ -->
|
|
<title><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>UDP 接続の使用</title>
|
|
<para>
|
|
ローカルホスト上で動いている
|
|
UDP サービスの "daytime" (ポート 13) で日時の情報を取得します。
|
|
</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>
|
|
UDP ソケットは、リモートホストに到達できなくても
|
|
エラーを発生せず、開いているかような状態になることがありす。
|
|
このエラーは、実際にソケットに対して、読み込みや書き込み動作を
|
|
行ってみないと判断できません。原因としては、UDP が非接続型の
|
|
プロトコルであることが挙げられます。つまり、実際にデータを
|
|
送受信する段階になるまで、OS の側では接続を確立しようとしないという
|
|
ことです。
|
|
</simpara>
|
|
</warning>
|
|
&ipv6.brackets;
|
|
<note>
|
|
<para>
|
|
環境により、Unix ドメインや接続タイムアウトが利用できない場合があります。
|
|
有効なトランスポートのリストは、<function>stream_get_transports</function>
|
|
で取得できます。組み込むのポートの一覧については、
|
|
<xref linkend="transports"/> を参照ください。
|
|
</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
|
|
-->
|