mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 15:28:55 +00:00
299d1daf07
Bundle reference/zookeeper/* missing returnvalues and parameters sections into one single commit.
117 lines
3.4 KiB
XML
117 lines
3.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="zookeeperconfig.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>ZookeeperConfig::set</refname>
|
|
<refpurpose>Change ZK cluster ensemble membership and roles of ensemble peers</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="oop">
|
|
<modifier>public</modifier>
|
|
<type>void</type><methodname>ZookeeperConfig::set</methodname>
|
|
<methodparam><type>string</type><parameter>members</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>members</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Comma separated list of new membership (e.g., contents of a membership configuration file) - for use only with a non-incremental reconfiguration.
|
|
</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.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
This method emits <classname>ZookeeperException</classname> and it's derivatives when parameters count or types are wrong or fail to save value to node.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example xml:id="zookeeperconfig.set.example.basic">
|
|
<title><methodname>ZookeeperConfig::set</methodname> example</title>
|
|
<para>
|
|
Reconfig.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$client = new Zookeeper();
|
|
$client->connect('localhost:2181');
|
|
$client->addAuth('digest', 'timandes:timandes');
|
|
$zkConfig = $client->getConfig();
|
|
$zkConfig->set("server.1=localhost:2888:3888:participant;0.0.0.0:2181");
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><methodname>ZookeeperConfig::get</methodname></member>
|
|
<member><methodname>ZookeeperConfig::add</methodname></member>
|
|
<member><methodname>ZookeeperConfig::remove</methodname></member>
|
|
<member><classname>ZookeeperException</classname></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
|
|
-->
|