Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
187 changes: 186 additions & 1 deletion reference/sockets/constants.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 890cc22d38fa747c9930fd0d5984c170f2490c1b Maintainer: takagi Status: ready -->
<!-- EN-Revision: e079b2a53251ac649dbcf055e604acb2a4ffa513 Maintainer: takagi Status: ready -->
<appendix xml:id="sockets.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
Expand Down Expand Up @@ -3188,6 +3188,191 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.shut-rd">
<term>
<constant>SHUT_RD</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
ソケットでのこれ以降の受信操作を無効にします。
<function>socket_shutdown</function> で使用します。
PHP 8.5.0 以降で利用可能。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.shut-wr">
<term>
<constant>SHUT_WR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
ソケットでのこれ以降の送信操作を無効にします。
<function>socket_shutdown</function> で使用します。
PHP 8.5.0 以降で利用可能。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.shut-rdwr">
<term>
<constant>SHUT_RDWR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
ソケットでのこれ以降の送信操作と受信操作を無効にします。
<function>socket_shutdown</function> で使用します。
PHP 8.5.0 以降で利用可能。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.udp-segment">
<term>
<constant>UDP_SEGMENT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
UDP の Generic Segmentation Offload (GSO) セグメントの最大サイズを設定します。
これにより、ひとつのシステムコールで複数のデータグラムを送信できるようになります。
PHP 8.5.0 以降で利用可能(Linux のみ)。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.so-busy-poll">
<term>
<constant>SO_BUSY_POLL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
ブロッキングモードでの受信時にデータがないときに
ビジーポーリングを行う、おおよその時間をマイクロ秒単位で設定します。
これにより、CPU 使用率と引き換えにレイテンシが下がります。
PHP 8.5.0 以降で利用可能(Linux のみ)。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ip-bindany">
<term>
<constant>IP_BINDANY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
ローカルのアドレスでなくても、任意のアドレスにソケットをバインドできるようにします。
PHP 8.5.0 以降で利用可能(FreeBSD/NetBSD/OpenBSD のみ)。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-function-blk">
<term>
<constant>TCP_FUNCTION_BLK</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
ソケットが使用する TCP スタック(関数ブロック)を選択します。
<function>socket_set_option</function> では、値はスタック名を表す文字列です。
<function>socket_get_option</function> は、
<literal>function_set_name</literal> と <literal>pcbcnt</literal>
をキーに持つ配列を返します。
PHP 8.5.0 以降で利用可能(FreeBSD のみ)。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-function-alias">
<term>
<constant>TCP_FUNCTION_ALIAS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
ソケットが使用する TCP スタックのエイリアスを、
<literal>function_set_name</literal> と <literal>pcbcnt</literal>
をキーに持つ配列として取得します。
PHP 8.5.0 以降で利用可能(FreeBSD のみ)。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-reusport-lb-numa">
<term>
<constant>TCP_REUSPORT_LB_NUMA</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
負荷分散を行うポート再利用における NUMA ドメインアフィニティを制御します。
PHP 8.5.0 以降で利用可能(FreeBSD のみ)。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-reusport-lb-numa-nodom">
<term>
<constant>TCP_REUSPORT_LB_NUMA_NODOM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
NUMA ドメインアフィニティを使用しないことを示す、
<constant>TCP_REUSPORT_LB_NUMA</constant> の定数値です。
PHP 8.5.0 以降で利用可能(FreeBSD のみ)。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-reusport-lb-numa-curdom">
<term>
<constant>TCP_REUSPORT_LB_NUMA_CURDOM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
現在の NUMA ドメインへのアフィニティを示す、
<constant>TCP_REUSPORT_LB_NUMA</constant> の定数値です。
PHP 8.5.0 以降で利用可能(FreeBSD のみ)。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-bbr-algorithm">
<term>
<constant>TCP_BBR_ALGORITHM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
BBR (Bottleneck Bandwidth and Round-trip propagation time)
輻輳制御アルゴリズムに関連するソケットオプションです。
PHP 8.5.0 以降で利用可能(FreeBSD のみ)。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ipproto-icmp">
<term>
<constant>IPPROTO_ICMP</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Internet Control Message Protocol (ICMP) のプロトコル番号です。
raw ソケットを作成する際に使用します。
PHP 8.5.0 以降で利用可能。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ipproto-icmpv6">
<term>
<constant>IPPROTO_ICMPV6</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Internet Control Message Protocol version 6 (ICMPv6) のプロトコル番号です。
IPv6 の raw ソケットを作成する際に使用します。
PHP 8.5.0 以降で利用可能。
</simpara>
</listitem>
</varlistentry>
</variablelist>

</appendix>
Expand Down
19 changes: 15 additions & 4 deletions reference/sqlite3/sqlite3.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6a2ad3ecf9b77855446019ed2d74aa6f734d35a8 Maintainer: takagi Status: ready -->
<!-- EN-Revision: 32916e1adeb2b92179db162f422c63a69d9c9036 Maintainer: takagi Status: ready -->
<reference xml:id="class.sqlite3" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>SQLite3 クラス</title>
<titleabbrev>SQLite3</titleabbrev>
Expand Down Expand Up @@ -264,21 +264,32 @@
<varlistentry xml:id="sqlite3.constants.ok">
<term><constant>SQLite3::OK</constant></term>
<listitem>
<para/>
<simpara>
authorizer コールバックがこの値を返すと、そのアクションが許可されます。
</simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="sqlite3.constants.deny">
<term><constant>SQLite3::DENY</constant></term>
<listitem>
<para/>
<simpara>
authorizer コールバックがこの値を返すと、
エラーが発生し、SQL文全体が拒否されます。
</simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="sqlite3.constants.ignore">
<term><constant>SQLite3::IGNORE</constant></term>
<listitem>
<para/>
<simpara>
authorizer コールバックがこの値を返すと、
SQL文のコンパイルは許可しつつ、
個別のアクションだけを不許可にします。
アクションごとの効果については
<methodname>SQLite3::setAuthorizer</methodname> を参照ください。
</simpara>
</listitem>
</varlistentry>

Expand Down
116 changes: 116 additions & 0 deletions reference/sqlite3/sqlite3/enableextendedresultcodes.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 32916e1adeb2b92179db162f422c63a69d9c9036 Maintainer: KentarouTakeda Status: ready -->

<refentry xml:id="sqlite3.enableextendedresultcodes" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SQLite3::enableExtendedResultCodes</refname>
<refpurpose>
拡張結果コードの使用を有効または無効にする
</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SQLite3">
<modifier>public</modifier> <type>bool</type><methodname>SQLite3::enableExtendedResultCodes</methodname>
<methodparam choice="opt"><type>bool</type><parameter>enable</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<simpara>
拡張結果コードの使用を有効または無効にします。
有効にすると、<methodname>SQLite3::lastErrorCode</methodname>
が拡張結果コードを返すようになります。
<methodname>SQLite3::lastExtendedErrorCode</methodname>
はこの設定の影響を受けず、常に拡張結果コードを返します。
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>enable</parameter></term>
<listitem>
<simpara>
拡張結果コードの使用を有効にする (&true;) か、無効にする (&false;) か。
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title><methodname>SQLite3::enableExtendedResultCodes</methodname> の例</title>
<programlisting role="php">
<![CDATA[
<?php
$db = new SQLite3(':memory:');
$db->enableExceptions(true);
$db->exec('CREATE TABLE t (a INTEGER UNIQUE)');
$db->exec('INSERT INTO t VALUES (1)');

try {
$db->exec('INSERT INTO t VALUES (1)');
} catch (Exception $e) {
}

// 主要な結果コード (SQLITE_CONSTRAINT)、続いて拡張結果コード
// (SQLITE_CONSTRAINT_UNIQUE)。
var_dump($db->lastErrorCode(), $db->lastExtendedErrorCode());

// 有効にすると、SQLite3::lastErrorCode() も
// 拡張結果コードを返すようになります。
$db->enableExtendedResultCodes();
var_dump($db->lastErrorCode());
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
int(19)
int(2067)
int(2067)
]]>
</screen>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>SQLite3::lastExtendedErrorCode</methodname></member>
<member><methodname>SQLite3::lastErrorCode</methodname></member>
</simplelist>
</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
-->
11 changes: 10 additions & 1 deletion reference/sqlite3/sqlite3/lasterrorcode.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 855bfee2f3db70d7dbb4c60c7c4a4efa567f1c60 Maintainer: takagi Status: ready -->
<!-- EN-Revision: 32916e1adeb2b92179db162f422c63a69d9c9036 Maintainer: takagi Status: ready -->

<refentry xml:id="sqlite3.lasterrorcode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
Expand Down Expand Up @@ -33,6 +33,15 @@
</para>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>SQLite3::lastExtendedErrorCode</methodname></member>
<member><methodname>SQLite3::enableExtendedResultCodes</methodname></member>
<member><methodname>SQLite3::lastErrorMsg</methodname></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
Loading
Loading