1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="zookeeperconfig.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ZookeeperConfig::get</refname>
<refpurpose>Gets the last committed configuration of the ZooKeeper cluster as it is known to the server to which the client is connected, synchronously</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier>
<type>string</type><methodname>ZookeeperConfig::get</methodname>
<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>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<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>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the configuration string on success, and false on failure.
</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 get configuration.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="zookeeperconfig.get.example.basic">
<title><methodname>ZookeeperConfig::get</methodname> example</title>
<para>
Get configuration.
</para>
<programlisting role="php">
<![CDATA[
<?php
$zk = new Zookeeper();
$zk->connect('localhost:2181');
$zk->addAuth('digest', 'timandes:timandes');
$zkConfig = $zk->getConfig();
$r = $zkConfig->get();
if ($r)
echo $r;
else
echo 'ERR';
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
server.1=localhost:2888:3888:participant;0.0.0.0:2181
version=0xca01e881a2
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>ZookeeperConfig::set</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
-->
|