mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
add class Zookeeper
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@340987 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Timandes White
parent
1520fc2ce5
commit
4be6dd71af
21 changed files with 2127 additions and 83 deletions
|
|
@ -2,8 +2,8 @@
|
|||
<!-- $Revision: 295472 $ -->
|
||||
|
||||
<book xml:id="book.zookeeper" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<title>Zookeeper</title>
|
||||
<titleabbrev>Zookeeper</titleabbrev>
|
||||
<title>ZooKeeper</title>
|
||||
<titleabbrev>ZooKeeper</titleabbrev>
|
||||
|
||||
<!-- {{{ preface -->
|
||||
<preface xml:id="intro.zookeeper">
|
||||
|
|
|
|||
|
|
@ -3,87 +3,7 @@
|
|||
|
||||
<appendix xml:id="zookeeper.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
&reftitle.constants;
|
||||
&extension.constants;
|
||||
|
||||
<!-- If the extension doesn't define any constants, use this entity -->
|
||||
<!-- &no.constants; -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>Zookeeper::PERM_READ</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
can read nodes value and list its children
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>Zookeeper::PERM_WRITE</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
can set the nodes value
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>Zookeeper::PERM_CREATE</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
can create children
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>Zookeeper::PERM_DELETE</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
can delete children
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>Zookeeper::PERM_ADMIN</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
can execute set_acl()
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>Zookeeper::PERM_ALL</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
all of the above flags ORd together
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
&no.constants;
|
||||
</appendix>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
319
reference/zookeeper/zookeeper.xml
Normal file
319
reference/zookeeper/zookeeper.xml
Normal file
|
|
@ -0,0 +1,319 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 325397 $ -->
|
||||
|
||||
<phpdoc:classref xml:id="class.zookeeper"
|
||||
xmlns:phpdoc="http://php.net/ns/phpdoc"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<title>The ZooKeeper class</title>
|
||||
<titleabbrev>ZooKeeper</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
|
||||
<!-- {{{ Zookeeper intro -->
|
||||
<section xml:id="zookeeper.intro">
|
||||
&reftitle.intro;
|
||||
<para>
|
||||
Represents ZooKeeper session.
|
||||
</para>
|
||||
</section>
|
||||
<!-- }}} -->
|
||||
|
||||
<section xml:id="zookeeper.synopsis">
|
||||
&reftitle.classsynopsis;
|
||||
|
||||
<!-- {{{ Synopsis -->
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Zookeeper</classname></ooclass>
|
||||
|
||||
<!-- {{{ Class synopsis -->
|
||||
<classsynopsisinfo>
|
||||
<ooclass>
|
||||
<classname>Zookeeper</classname>
|
||||
</ooclass>
|
||||
|
||||
</classsynopsisinfo>
|
||||
<!-- }}} -->
|
||||
|
||||
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.zookeeper')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
|
||||
<xi:fallback />
|
||||
</xi:include>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.zookeeper')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])">
|
||||
<xi:fallback />
|
||||
</xi:include>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.zookeeper')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
|
||||
<xi:fallback />
|
||||
</xi:include>
|
||||
|
||||
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.perm-read">PERM_READ</varname>
|
||||
<initializer>1</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.perm-write">PERM_WRITE</varname>
|
||||
<initializer>2</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.perm-create">PERM_CREATE</varname>
|
||||
<initializer>4</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.perm-delete">PERM_DELETE</varname>
|
||||
<initializer>8</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.perm-admin">PERM_ADMIN</varname>
|
||||
<initializer>16</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.perm-all">PERM_ALL</varname>
|
||||
<initializer>31</initializer>
|
||||
</fieldsynopsis>
|
||||
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.log-level-error">LOG_LEVEL_ERROR</varname>
|
||||
<initializer>1</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.log-level-warn">LOG_LEVEL_WARN</varname>
|
||||
<initializer>2</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.log-level-info">LOG_LEVEL_INFO</varname>
|
||||
<initializer>3</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.log-level-debug">LOG_LEVEL_DEBUG</varname>
|
||||
<initializer>4</initializer>
|
||||
</fieldsynopsis>
|
||||
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.expired-session-state">EXPIRED_SESSION_STATE</varname>
|
||||
<initializer>-112</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.auth-failed-state">AUTH_FAILED_STATE</varname>
|
||||
<initializer>-113</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.connecting-state">CONNECTING_STATE</varname>
|
||||
<initializer>1</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.associating-state">ASSOCIATING_STATE</varname>
|
||||
<initializer>2</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.connected-state">CONNECTED_STATE</varname>
|
||||
<initializer>3</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.readonly-state">READONLY_STATE</varname>
|
||||
<initializer>5</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>const</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="zookeeper.constants.notconnected-state">NOTCONNECTED_STATE</varname>
|
||||
<initializer>999</initializer>
|
||||
</fieldsynopsis>
|
||||
|
||||
<!-- }}} -->
|
||||
|
||||
<!-- {{{ Constants -->
|
||||
<section xml:id="zookeeper.constants">
|
||||
&reftitle.constants;
|
||||
<section xml:id="zookeeper.constants.perms">
|
||||
<title><acronym>ZooKeeper</acronym> Permissions</title>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry xml:id="zookeeper.constants.perm-read">
|
||||
<term><constant>Zookeeper::PERM_READ</constant></term>
|
||||
<listitem>
|
||||
<para>Can read nodes value and list its children</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.perm-write">
|
||||
<term><constant>Zookeeper::PERM_WRITE</constant></term>
|
||||
<listitem>
|
||||
<para>Can set the nodes value</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.perm-create">
|
||||
<term><constant>Zookeeper::PERM_CREATE</constant></term>
|
||||
<listitem>
|
||||
<para>Can create children</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.perm-delete">
|
||||
<term><constant>Zookeeper::PERM_DELETE</constant></term>
|
||||
<listitem>
|
||||
<para>Can delete children</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.perm-admin">
|
||||
<term><constant>Zookeeper::PERM_ADMIN</constant></term>
|
||||
<listitem>
|
||||
<para>Can execute set_acl()</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.perm-all">
|
||||
<term><constant>Zookeeper::PERM_ALL</constant></term>
|
||||
<listitem>
|
||||
<para>All of the above flags ORd together</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</section>
|
||||
|
||||
<section xml:id="zookeeper.constants.log-levels">
|
||||
<title><acronym>ZooKeeper</acronym> Log Levels</title>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry xml:id="zookeeper.constants.log-level-error">
|
||||
<term><constant>Zookeeper::LOG_LEVEL_ERROR</constant></term>
|
||||
<listitem>
|
||||
<para>Outputs only error mesages</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.log-level-warn">
|
||||
<term><constant>Zookeeper::LOG_LEVEL_WARN</constant></term>
|
||||
<listitem>
|
||||
<para>Outputs errors/warnings</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.log-level-info">
|
||||
<term><constant>Zookeeper::LOG_LEVEL_INFO</constant></term>
|
||||
<listitem>
|
||||
<para>Outputs big action messages besides errors/warnings</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.log-level-debug">
|
||||
<term><constant>Zookeeper::LOG_LEVEL_DEBUG</constant></term>
|
||||
<listitem>
|
||||
<para>Outputs all</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</section>
|
||||
|
||||
<section xml:id="zookeeper.constants.states">
|
||||
<title><acronym>ZooKeeper</acronym> States</title>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry xml:id="zookeeper.constants.expired-session-state">
|
||||
<term><constant>Zookeeper::EXPIRED_SESSION_STATE</constant></term>
|
||||
<listitem>
|
||||
<para>Connected but session expired</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.auth-failed-state">
|
||||
<term><constant>Zookeeper::AUTH_FAILED_STATE</constant></term>
|
||||
<listitem>
|
||||
<para>Connected but auth failed</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.connecting-state">
|
||||
<term><constant>Zookeeper::CONNECTING_STATE</constant></term>
|
||||
<listitem>
|
||||
<para>Connecting</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.associating-state">
|
||||
<term><constant>Zookeeper::ASSOCIATING_STATE</constant></term>
|
||||
<listitem>
|
||||
<para>Associating</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.connected-state">
|
||||
<term><constant>Zookeeper::CONNECTED_STATE</constant></term>
|
||||
<listitem>
|
||||
<para>Connected</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.readonly-state">
|
||||
<term><constant>Zookeeper::READONLY_STATE</constant></term>
|
||||
<listitem>
|
||||
<para>TODO: help us improve this extension.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="zookeeper.constants.notconnected-state">
|
||||
<term><constant>Zookeeper::NOTCONNECTED_STATE</constant></term>
|
||||
<listitem>
|
||||
<para>Connection failed</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
<!-- }}} -->
|
||||
|
||||
</section>
|
||||
|
||||
</partintro>
|
||||
|
||||
&reference.zookeeper.entities.zookeeper;
|
||||
|
||||
</phpdoc:classref>
|
||||
|
||||
<!-- 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
|
||||
-->
|
||||
|
||||
135
reference/zookeeper/zookeeper/addauth.xml
Normal file
135
reference/zookeeper/zookeeper/addauth.xml
Normal file
|
|
@ -0,0 +1,135 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.addauth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::addAuth</refname>
|
||||
<refpurpose>Specify application credentials.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>bool</type><methodname>Zookeeper::addAuth</methodname>
|
||||
<methodparam><type>string</type><parameter>scheme</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>callable</type><parameter>completion_cb</parameter><initializer>null</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
The application calls this function to specify its credentials for purposes of authentication. The server will use the security provider specified by the scheme parameter to authenticate the client connection. If the authentication request has failed:
|
||||
- the server connection is dropped.
|
||||
- the watcher is called with the ZOO_AUTH_FAILED_STATE value as the state parameter.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>scheme</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The id of authentication scheme. Natively supported: "digest" password-based authentication
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>cert</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Application credentials. The actual value depends on the scheme.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>completion_cb</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The routine to invoke when the request completes. One of the following result codes may be passed into the completion callback:
|
||||
- ZOK operation completed successfully
|
||||
- ZAUTHFAILED authentication failed
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or operation fails.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="zookeeper.addauth.example.basic">
|
||||
<title><methodname>Zookeeper::addAuth</methodname> example</title>
|
||||
<para>
|
||||
Add auth before requesting node value.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$zookeeper = new Zookeeper('locahost:2181');
|
||||
$path = '/path/to/node';
|
||||
$value = 'nodevalue';
|
||||
$zookeeper->set($path, $value);
|
||||
|
||||
$zookeeper->addAuth('digest', 'user0:passwd0');
|
||||
$r = $zookeeper->get($path);
|
||||
if ($r)
|
||||
echo $r;
|
||||
else
|
||||
echo 'ERR';
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
nodevalue
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::create</methodname></member>
|
||||
<member><methodname>Zookeeper::setAcl</methodname></member>
|
||||
<member><methodname>Zookeeper::getAcl</methodname></member>
|
||||
<member><link linkend="zookeeper.constants.states">ZooKeeper States</link></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
|
||||
-->
|
||||
89
reference/zookeeper/zookeeper/connect.xml
Normal file
89
reference/zookeeper/zookeeper/connect.xml
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.connect" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::connect</refname>
|
||||
<refpurpose>Create a handle to used communicate with zookeeper.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>void</type><methodname>Zookeeper::connect</methodname>
|
||||
<methodparam><type>string</type><parameter>host</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>callable</type><parameter>watcher_cb</parameter><initializer>null</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>recv_timeout</parameter><initializer>10000</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
This method creates a new handle and a zookeeper session that corresponds to that handle. Session establishment is asynchronous, meaning that the session should not be considered established until (and unless) an event of state ZOO_CONNECTED_STATE is received.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>host</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Comma separated host:port pairs, each corresponding to a zk server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>watcher_cb</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The global watcher callback function. When notifications are triggered this function will be invoked.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>recv_timeout</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The timeout for this session, only valid if the connections is currently connected (ie. last watcher state is ZOO_CONNECTED_STATE).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or could not init instance.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::__construct</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
|
||||
-->
|
||||
88
reference/zookeeper/zookeeper/construct.xml
Normal file
88
reference/zookeeper/zookeeper/construct.xml
Normal file
|
|
@ -0,0 +1,88 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 299459 $ -->
|
||||
|
||||
<refentry xml:id="zookeeper.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::__construct</refname>
|
||||
<refpurpose>Create a handle to used communicate with zookeeper.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<constructorsynopsis role="oop">
|
||||
<methodname>Zookeeper::__construct</methodname>
|
||||
<methodparam choice="opt"><type>string</type><parameter>host</parameter><initializer>''</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>callable</type><parameter>watcher_cb</parameter><initializer>null</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>recv_timeout</parameter><initializer>10000</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
This method creates a new handle and a zookeeper session that corresponds to that handle. Session establishment is asynchronous, meaning that the session should not be considered established until (and unless) an event of state ZOO_CONNECTED_STATE is received.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>host</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
comma separated host:port pairs, each corresponding to a zk server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>watcher_cb</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
the global watcher callback function. When notifications are triggered this function will be invoked.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>recv_timeout</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
the timeout for this session, only valid if the connections is currently connected (ie. last watcher state is ZOO_CONNECTED_STATE).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or could not init instance.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::connect</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
|
||||
-->
|
||||
141
reference/zookeeper/zookeeper/create.xml
Normal file
141
reference/zookeeper/zookeeper/create.xml
Normal file
|
|
@ -0,0 +1,141 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.create" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::create</refname>
|
||||
<refpurpose>Create a node synchronously.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>string</type><methodname>Zookeeper::create</methodname>
|
||||
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>value</parameter></methodparam>
|
||||
<methodparam><type>array</type><parameter>acls</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>null</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
This method will create a node in ZooKeeper. A node can only be created if it does not already exists. The Create Flags affect the creation of nodes. If ZOO_EPHEMERAL flag is set, the node will automatically get removed if the client session goes away. If the ZOO_SEQUENCE flag is set, a unique monotonically increasing sequence number is appended to the path name.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>path</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the node. Expressed as a file name with slashes separating ancestors of the node.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The data to be stored in the node.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>acls</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The initial ACL of the node. The ACL must not be null or empty.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>flags</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
this parameter can be set to 0 for normal create or an OR of the Create Flags
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the path of the new node (this might be different than the supplied path because of the ZOO_SEQUENCE flag) on success, and false on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or fail to create node.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="zookeeper.create.example.basic">
|
||||
<title><methodname>Zookeeper::create</methodname> example</title>
|
||||
<para>
|
||||
Create a new node.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$zookeeper = new Zookeeper('locahost:2181');
|
||||
$aclArray = array(
|
||||
array(
|
||||
'perms' => Zookeeper::PERM_ALL,
|
||||
'scheme' => 'world',
|
||||
'id' => 'anyone',
|
||||
)
|
||||
);
|
||||
$path = '/path/to/newnode';
|
||||
$realPath = $zookeeper->create($path, null, $aclArray);
|
||||
if ($realPath)
|
||||
echo $realPath;
|
||||
else
|
||||
echo 'ERR';
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
/path/to/newnode
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::delete</methodname></member>
|
||||
<member><link linkend="zookeeper.constants.perms">ZooKeeper Permissions</link></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
|
||||
-->
|
||||
112
reference/zookeeper/zookeeper/delete.xml
Normal file
112
reference/zookeeper/zookeeper/delete.xml
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::delete</refname>
|
||||
<refpurpose>Delete a node in zookeeper synchronously.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>bool</type><methodname>Zookeeper::delete</methodname>
|
||||
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>version</parameter><initializer>-1</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>path</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the node. Expressed as a file name with slashes separating ancestors of the node.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>version</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The expected version of the node. The function will fail if the actual version of the node does not match the expected version. If -1 is used the version check will not take place.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or fail to delete node.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="zookeeper.delete.example.basic">
|
||||
<title><methodname>Zookeeper::delete</methodname> example</title>
|
||||
<para>
|
||||
Delete a existing node.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$zookeeper = new Zookeeper('locahost:2181');
|
||||
$path = '/path/to/node';
|
||||
$r = $zookeeper->delete($path);
|
||||
if ($r)
|
||||
echo 'SUCCESS';
|
||||
else
|
||||
echo 'ERR';
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
SUCCESS
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::create</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
|
||||
-->
|
||||
112
reference/zookeeper/zookeeper/exists.xml
Normal file
112
reference/zookeeper/zookeeper/exists.xml
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.exists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::exists</refname>
|
||||
<refpurpose>Checks the existence of a node in zookeeper synchronously.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>bool</type><methodname>Zookeeper::exists</methodname>
|
||||
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>callable</type><parameter>watcher_cb</parameter><initializer>null</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>path</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the node. Expressed as a file name with slashes separating ancestors of the node.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>watcher_cb</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
if nonzero, a watch will be set at the server to notify the client if the node changes. The watch will be set even if the node does not
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns true/false on success, and false on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or fail to check the existence of a node.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="zookeeper.exists.example.basic">
|
||||
<title><methodname>Zookeeper::exists</methodname> example</title>
|
||||
<para>
|
||||
Check the existence of a node.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$zookeeper = new Zookeeper('locahost:2181');
|
||||
$path = '/path/to/node';
|
||||
$r = $zookeeper->exists($path);
|
||||
if ($r)
|
||||
echo 'EXISTS';
|
||||
else
|
||||
echo 'N/A or ERR';
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
EXISTS
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::get</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
|
||||
-->
|
||||
133
reference/zookeeper/zookeeper/get.xml
Normal file
133
reference/zookeeper/zookeeper/get.xml
Normal file
|
|
@ -0,0 +1,133 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::get</refname>
|
||||
<refpurpose>Gets the data associated with a node synchronously.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>string</type><methodname>Zookeeper::get</methodname>
|
||||
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>callable</type><parameter>watcher_cb</parameter><initializer>null</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">stat</parameter><initializer>null</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>max_size</parameter><initializer>0</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>path</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the node. Expressed as a file name with slashes separating ancestors of the node.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>watcher_cb</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If nonzero, a watch will be set at the server to notify the client if the node changes.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>stat</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If not NULL, will hold the value of stat for the path on return.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>max_size</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Max size of the data. If 0 is used, this method will return the whole data.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the data on success, and false on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or fail to get value from node.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="zookeeper.get.example.basic">
|
||||
<title><methodname>Zookeeper::get</methodname> example</title>
|
||||
<para>
|
||||
Get value from node.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$zookeeper = new Zookeeper('locahost:2181');
|
||||
$path = '/path/to/node';
|
||||
$value = 'nodevalue';
|
||||
$zookeeper->set($path, $value);
|
||||
|
||||
$r = $zookeeper->get($path);
|
||||
if ($r)
|
||||
echo $r;
|
||||
else
|
||||
echo 'ERR';
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
nodevalue
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::set</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
|
||||
-->
|
||||
124
reference/zookeeper/zookeeper/getacl.xml
Normal file
124
reference/zookeeper/zookeeper/getacl.xml
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.getacl" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::getAcl</refname>
|
||||
<refpurpose>Gets the acl associated with a node synchronously.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>array</type><methodname>Zookeeper::getAcl</methodname>
|
||||
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>path</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the node. Expressed as a file name with slashes separating ancestors of the node.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Return acl array on success and false on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or fail to get ACL of a node.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="zookeeper.getacl.example.basic">
|
||||
<title><methodname>Zookeeper::getAcl</methodname> example</title>
|
||||
<para>
|
||||
Get ACL of a node.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$zookeeper = new Zookeeper('locahost:2181');
|
||||
$aclArray = array(
|
||||
array(
|
||||
'perms' => Zookeeper::PERM_ALL,
|
||||
'scheme' => 'world',
|
||||
'id' => 'anyone',
|
||||
)
|
||||
);
|
||||
$path = '/path/to/newnode';
|
||||
$zookeeper->setAcl($path, $aclArray);
|
||||
|
||||
$r = $zookeeper->getAcl($path);
|
||||
if ($r)
|
||||
var_dump($r);
|
||||
else
|
||||
echo 'ERR';
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
array(1) {
|
||||
[0]=>
|
||||
array(3) {
|
||||
["perms"]=>
|
||||
int(31)
|
||||
["scheme"]=>
|
||||
string(5) "world"
|
||||
["id"]=>
|
||||
string(6) "anyone"
|
||||
}
|
||||
}
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::create</methodname></member>
|
||||
<member><methodname>Zookeeper::setAcl</methodname></member>
|
||||
<member><link linkend="zookeeper.constants.perms">ZooKeeper Permissions</link></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
|
||||
-->
|
||||
63
reference/zookeeper/zookeeper/getclientid.xml
Normal file
63
reference/zookeeper/zookeeper/getclientid.xml
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.getclientid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::getClientId</refname>
|
||||
<refpurpose>return the client session id, only valid if the connections is currently connected (ie. last watcher state is ZOO_CONNECTED_STATE)</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>int</type><methodname>Zookeeper::getClientId</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the client session id on success, and false on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when it could not get client session id.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::__construct</methodname></member>
|
||||
<member><methodname>Zookeeper::connect</methodname></member>
|
||||
<member><methodname>Zookeeper::getState</methodname></member>
|
||||
<member><link linkend="zookeeper.constants.states">ZooKeeper States</link></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
|
||||
-->
|
||||
61
reference/zookeeper/zookeeper/getrecvtimeout.xml
Normal file
61
reference/zookeeper/zookeeper/getrecvtimeout.xml
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.getrecvtimeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::getRecvTimeout</refname>
|
||||
<refpurpose>Return the timeout for this session, only valid if the connections is currently connected (ie. last watcher state is ZOO_CONNECTED_STATE). This value may change after a server re-connect.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>int</type><methodname>Zookeeper::getRecvTimeout</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the timeout for this session on success, and false on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when operation fails.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::__construct</methodname></member>
|
||||
<member><methodname>Zookeeper::connect</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
|
||||
-->
|
||||
63
reference/zookeeper/zookeeper/getstate.xml
Normal file
63
reference/zookeeper/zookeeper/getstate.xml
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.getstate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::getState</refname>
|
||||
<refpurpose>Get the state of the zookeeper connection.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>int</type><methodname>Zookeeper::getState</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the state of zookeeper connection on success, and false on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when it fails to get state of zookeeper connection.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::__construct</methodname></member>
|
||||
<member><methodname>Zookeeper::connect</methodname></member>
|
||||
<member><methodname>Zookeeper::getClientId</methodname></member>
|
||||
<member><link linkend="zookeeper.constants.states">ZooKeeper States</link></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
|
||||
-->
|
||||
66
reference/zookeeper/zookeeper/isrecoverable.xml
Normal file
66
reference/zookeeper/zookeeper/isrecoverable.xml
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.isrecoverable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::isRecoverable</refname>
|
||||
<refpurpose>Checks if the current zookeeper connection state can be recovered.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>bool</type><methodname>Zookeeper::isRecoverable</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
The application must close the zhandle and try to reconnect.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns true/false on success, and false on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when operation fails.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::__construct</methodname></member>
|
||||
<member><methodname>Zookeeper::connect</methodname></member>
|
||||
<member><methodname>Zookeeper::getClientId</methodname></member>
|
||||
<member><link linkend="zookeeper.constants.states">ZooKeeper States</link></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
|
||||
-->
|
||||
132
reference/zookeeper/zookeeper/set.xml
Normal file
132
reference/zookeeper/zookeeper/set.xml
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::set</refname>
|
||||
<refpurpose>Sets the data associated with a node.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>bool</type><methodname>Zookeeper::set</methodname>
|
||||
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>value</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>version</parameter><initializer>-1</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">stat</parameter><initializer>null</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>path</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the node. Expressed as a file name with slashes separating ancestors of the node.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The data to be stored in the node.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>version</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The expected version of the node. The function will fail if the actual version of the node does not match the expected version. If -1 is used the version check will not take place.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>stat</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If not NULL, will hold the value of stat for the path on return.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or fail to save value to node.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="zookeeper.set.example.basic">
|
||||
<title><methodname>Zookeeper::set</methodname> example</title>
|
||||
<para>
|
||||
Save value to node.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$zookeeper = new Zookeeper('locahost:2181');
|
||||
$path = '/path/to/node';
|
||||
$value = 'nodevalue';
|
||||
$r = $zookeeper->set($path, $value);
|
||||
if ($r)
|
||||
echo 'SUCCESS';
|
||||
else
|
||||
echo 'ERR';
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
SUCCESS
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::create</methodname></member>
|
||||
<member><methodname>Zookeeper::get</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
|
||||
-->
|
||||
142
reference/zookeeper/zookeeper/setacl.xml
Normal file
142
reference/zookeeper/zookeeper/setacl.xml
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.setacl" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::setAcl</refname>
|
||||
<refpurpose>Sets the acl associated with a node synchronously.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>bool</type><methodname>Zookeeper::setAcl</methodname>
|
||||
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>version</parameter></methodparam>
|
||||
<methodparam><type>array</type><parameter>acl</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>path</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the node. Expressed as a file name with slashes separating ancestors of the node.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>version</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The expected version of the path.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>acl</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The acl to be set on the path.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or fail to set ACL for a node.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="zookeeper.setacl.example.basic">
|
||||
<title><methodname>Zookeeper::setAcl</methodname> example</title>
|
||||
<para>
|
||||
Set ACL for a node.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$zookeeper = new Zookeeper('locahost:2181');
|
||||
$aclArray = array(
|
||||
array(
|
||||
'perms' => Zookeeper::PERM_ALL,
|
||||
'scheme' => 'world',
|
||||
'id' => 'anyone',
|
||||
)
|
||||
);
|
||||
$path = '/path/to/newnode';
|
||||
$zookeeper->setAcl($path, $aclArray);
|
||||
|
||||
$r = $zookeeper->getAcl($path);
|
||||
if ($r)
|
||||
var_dump($r);
|
||||
else
|
||||
echo 'ERR';
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
array(1) {
|
||||
[0]=>
|
||||
array(3) {
|
||||
["perms"]=>
|
||||
int(31)
|
||||
["scheme"]=>
|
||||
string(5) "world"
|
||||
["id"]=>
|
||||
string(6) "anyone"
|
||||
}
|
||||
}
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::create</methodname></member>
|
||||
<member><methodname>Zookeeper::getAcl</methodname></member>
|
||||
<member><link linkend="zookeeper.constants.perms">ZooKeeper Permissions</link></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
|
||||
-->
|
||||
102
reference/zookeeper/zookeeper/setdebuglevel.xml
Normal file
102
reference/zookeeper/zookeeper/setdebuglevel.xml
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.setdebuglevel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::setDebugLevel</refname>
|
||||
<refpurpose>Sets the debugging level for the library.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<modifier>static</modifier><type>bool</type><methodname>Zookeeper::setDebugLevel</methodname>
|
||||
<methodparam><type>int</type><parameter>logLevel</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>logLevel</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ZooKeeper log level constants.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or fail to set debug level.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="zookeeper.setdebuglevel.example.basic">
|
||||
<title><methodname>Zookeeper::setDebugLevel</methodname> example</title>
|
||||
<para>
|
||||
Set debugl level.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$r = Zookeeper::setDebugLevel(Zookeeper::LOG_LEVEL_WARN);
|
||||
if ($r)
|
||||
echo 'SUCCESS';
|
||||
else
|
||||
echo 'ERR';
|
||||
?>
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
SUCCESS
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><link linkend="zookeeper.constants.log-levels">ZooKeeper Log Levels</link></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
|
||||
-->
|
||||
90
reference/zookeeper/zookeeper/setdeterministicconnorder.xml
Normal file
90
reference/zookeeper/zookeeper/setdeterministicconnorder.xml
Normal file
|
|
@ -0,0 +1,90 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.setdeterministicconnorder" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::setDeterministicConnOrder</refname>
|
||||
<refpurpose>Enable/disable quorum endpoint order randomization.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<modifier>static</modifier><type>bool</type><methodname>Zookeeper::setDeterministicConnOrder</methodname>
|
||||
<methodparam><type>bool</type><parameter>yesOrNo</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
If passed a non-zero value, will make the client connect to quorum peers in the order as specified in the zookeeper_init() call. A zero value causes zookeeper_init() to permute the peer endpoints which is good for more even client connection distribution among the quorum peers.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>yesOrNo</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Enable/disable quorum endpoint order randomization.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or operation fails.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
<caution>
|
||||
<para>
|
||||
Note: typically this method should NOT be used outside of testing.
|
||||
</para>
|
||||
</caution>
|
||||
¬e.language-construct;
|
||||
¬e.not-bin-safe;
|
||||
¬e.registerglobals;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::__construct</methodname></member>
|
||||
<member><methodname>Zookeeper::connect</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
|
||||
-->
|
||||
77
reference/zookeeper/zookeeper/setlogstream.xml
Normal file
77
reference/zookeeper/zookeeper/setlogstream.xml
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.setlogstream" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::setLogStream</refname>
|
||||
<refpurpose>Sets the stream to be used by the library for logging.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>bool</type><methodname>Zookeeper::setLogStream</methodname>
|
||||
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
The zookeeper library uses stderr as its default log stream. Application must make sure the stream is writable. Passing in NULL resets the stream to its default value (stderr).
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>stream</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The stream to be used by the library for logging.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or operation fails.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::setDebugLevel</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
|
||||
-->
|
||||
75
reference/zookeeper/zookeeper/setwatcher.xml
Normal file
75
reference/zookeeper/zookeeper/setwatcher.xml
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="zookeeper.setwatcher" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Zookeeper::setWatcher</refname>
|
||||
<refpurpose>Set a watcher function.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="oop">
|
||||
<type>bool</type><methodname>Zookeeper::setWatcher</methodname>
|
||||
<methodparam><type>callable</type><parameter>watcher_cb</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>watcher_cb</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
A watch will be set at the server to notify the client if the node changes.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
This method emits PHP error/warning when parameters count or types are wrong or fail to set watcher.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Zookeeper::exists</methodname></member>
|
||||
<member><methodname>Zookeeper::get</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
|
||||
-->
|
||||
Loading…
Reference in a new issue