Класс Zookeeper

(PECL zookeeper >= 0.1.0)

Введение

Представляет сессию ZooKeeper.

Обзор классов

Zookeeper {

/* Методы */

public __construct ([ string $host = '' [, callable $watcher_cb = NULL [, int $recv_timeout = 10000 ]]] )

public addAuth ( string $scheme , string $cert [, callable $completion_cb = NULL ] ) : bool

public close ( void ) : void

public connect ( string $host [, callable $watcher_cb = NULL [, int $recv_timeout = 10000 ]] ) : void

public create ( string $path , string $value , array $acls [, int $flags = NULL ] ) : string

public delete ( string $path [, int $version = -1 ] ) : bool

public exists ( string $path [, callable $watcher_cb = NULL ] ) : array

public get ( string $path [, callable $watcher_cb = NULL [, array &$stat = NULL [, int $max_size = 0 ]]] ) : string

public getAcl ( string $path ) : array

public getChildren ( string $path [, callable $watcher_cb = NULL ] ) : array

public getClientId ( void ) : int

public getConfig ( void ) : ZookeeperConfig

public getRecvTimeout ( void ) : int

public getState ( void ) : int

public isRecoverable ( void ) : bool

public set ( string $path , string $value [, int $version = -1 [, array &$stat = NULL ]] ) : bool

public setAcl ( string $path , int $version , array $acl ) : bool

public static setDebugLevel ( int $logLevel ) : bool

public static setDeterministicConnOrder ( bool $yesOrNo ) : bool

public setLogStream ( resource $stream ) : bool

public setWatcher ( callable $watcher_cb ) : bool

/* Константы */

const integer PERM_READ = 1 ;

const integer PERM_WRITE = 2 ;

const integer PERM_CREATE = 4 ;

const integer PERM_DELETE = 8 ;

const integer PERM_ADMIN = 16 ;

const integer PERM_ALL = 31 ;

const integer EPHEMERAL = 1 ;

const integer SEQUENCE = 2 ;

const integer LOG_LEVEL_ERROR = 1 ;

const integer LOG_LEVEL_WARN = 2 ;

const integer LOG_LEVEL_INFO = 3 ;

const integer LOG_LEVEL_DEBUG = 4 ;

const integer EXPIRED_SESSION_STATE = -112 ;

const integer AUTH_FAILED_STATE = -113 ;

const integer CONNECTING_STATE = 1 ;

const integer ASSOCIATING_STATE = 2 ;

const integer CONNECTED_STATE = 3 ;

const integer READONLY_STATE = 5 ;

const integer NOTCONNECTED_STATE = 999 ;

const integer CREATED_EVENT = 1 ;

const integer DELETED_EVENT = 2 ;

const integer CHANGED_EVENT = 3 ;

const integer CHILD_EVENT = 4 ;

const integer SESSION_EVENT = -1 ;

const integer NOTWATCHING_EVENT = -2 ;

const integer SYSTEMERROR = -1 ;

const integer RUNTIMEINCONSISTENCY = -2 ;

const integer DATAINCONSISTENCY = -3 ;

const integer CONNECTIONLOSS = -4 ;

const integer MARSHALLINGERROR = -5 ;

const integer UNIMPLEMENTED = -6 ;

const integer OPERATIONTIMEOUT = -7 ;

const integer BADARGUMENTS = -8 ;

const integer INVALIDSTATE = -9 ;

const integer NEWCONFIGNOQUORUM = -13 ;

const integer RECONFIGINPROGRESS = -14 ;

const integer OK = 0 ;

const integer APIERROR = -100 ;

const integer NONODE = -101 ;

const integer NOAUTH = -102 ;

const integer BADVERSION = -103 ;

const integer NOCHILDRENFOREPHEMERALS = -108 ;

const integer NODEEXISTS = -110 ;

const integer NOTEMPTY = -111 ;

const integer SESSIONEXPIRED = -112 ;

const integer INVALIDCALLBACK = -113 ;

const integer INVALIDACL = -114 ;

const integer AUTHFAILED = -115 ;

const integer CLOSING = -116 ;

const integer NOTHING = -117 ;

const integer SESSIONMOVED = -118 ;

const integer NOTREADONLY = -119 ;

const integer EPHEMERALONLOCALSESSION = -120 ;

const integer NOWATCHER = -121 ;

const integer RECONFIGDISABLED = -122 ;

}

Предопределенные константы

Разрешения ZooKeeper

Zookeeper::PERM_READ: Можно читать значение узла и список дочерних узлов
Zookeeper::PERM_WRITE: Можно устанавливать значение узла
Zookeeper::PERM_CREATE: Можно создавать дочерние элементы
Zookeeper::PERM_DELETE: Можно удалять дочерние элементы
Zookeeper::PERM_ADMIN: Можно запускать set_acl()
Zookeeper::PERM_ALL: Можно использовать все вышеуказанные флаги вместе

Флаги создания ZooKeeper

Zookeeper::EPHEMERAL: Если установлен флаг Zookeeper::EPHEMERAL, узел будет автоматически удален по завершению клиентской сессии.
Zookeeper::SEQUENCE: Если установлен флаг Zookeeper::SEQUENCE, к имени пути будет добавляться уникальный номер из монотонно возрастающей последовательности. Номер из последовательности всегда имеет фиксированную длину в 10 цифр, дополненную лидирующими нулями по необходимости.

Уровень логирования ZooKeeper

Zookeeper::LOG_LEVEL_ERROR: Выводить только сообщения об ошибках
Zookeeper::LOG_LEVEL_WARN: Выводить ошибки и предупреждения
Zookeeper::LOG_LEVEL_INFO: Выводить большие сообщения о действиях помимо ошибок и предупреждений
Zookeeper::LOG_LEVEL_DEBUG: Выводить все

Состояния ZooKeeper

Zookeeper::EXPIRED_SESSION_STATE: Соединение установлено, но сессия истекла
Zookeeper::AUTH_FAILED_STATE: Соединение установлено, но аутентификация неудачная
Zookeeper::CONNECTING_STATE: Устанавливается соединение
Zookeeper::ASSOCIATING_STATE: Ассоциирование
Zookeeper::CONNECTED_STATE: Соединение установлено
Zookeeper::READONLY_STATE: TODO: помогите нам улучшить это расширение
Zookeeper::NOTCONNECTED_STATE: Соединение не установлено

Типы событий ZooKeeper

Zookeeper::CREATED_EVENT

Узел был создан

Генерируется только путем наблюдения за несуществующими узлами. Эти наблюдатели задаются с помощью Zookeeper::exists.

Zookeeper::DELETED_EVENT

Узел был удален

Генерируется только путем наблюдения за узлами. Эти наблюдатели задаются с помощью Zookeeper::exists и Zookeeper::get.

Zookeeper::CHANGED_EVENT

Узел был изменен

Генерируется только путем наблюдения за узлами. Эти наблюдатели задаются с помощью Zookeeper::exists и Zookeeper::get.

Zookeeper::CHILD_EVENT

Произошло изменение в списке дочерних узлов

Генерируется только путем наблюдения за списком дочерних узлов. Эти наблюдатели задаются с помощью Zookeeper::getChildren.

Zookeeper::SESSION_EVENT

Сессия была потеряна

Генерируется когда коиент потерял соединение с сервером, либо инициировал пересоединение.

Zookeeper::NOTWATCHING_EVENT

Наблюдатель был удален

Генерируется сервером по разным причинам, например связанным с ограничением ресурса, и говорит о том, что дальнейшее наблюдение за узлом невозможно.

Системные ошибки и ошибки на стороне сервера ZooKeeper

Zookeeper::SYSTEMERROR

Никогда не выбрасывается сервером и может использоваться только для ограничения диапазона кодов ошибок. Все ошибки большие этой, но меньшие Zookeeper::APIERROR, являются системными ошибками.

Zookeeper::RUNTIMEINCONSISTENCY

Обнаружена несогласованность во время выполнения.

Zookeeper::DATAINCONSISTENCY

Обнаружена несогласованность данных.

Zookeeper::CONNECTIONLOSS

Потеряно соединение с сервером.

Zookeeper::MARSHALLINGERROR

Ошибка при маршалинге и демаршалинге данных.

Zookeeper::UNIMPLEMENTED

Операция не реализована.

Zookeeper::OPERATIONTIMEOUT

Превышение времени ожидания операции.

Zookeeper::BADARGUMENTS

Некорректный аргумент.

Zookeeper::INVALIDSTATE

Некорректный статус zhandle.

Zookeeper::NEWCONFIGNOQUORUM

Кворум новой конфигурации не подключен и не синхронизирован с лидером последней подтвержденной конфигурации. Попробуйте запустить переконфигурацию после подключения и синхронизации новых серверов.

Доступно с версии ZooKeeper 3.5.0

Zookeeper::RECONFIGINPROGRESS

Запрос переконфигурации во время работы другого процесса переконфигурации. В данный момент не поддерживается. Попробуйте повторить позже.

Доступно с версии ZooKeeper 3.5.0

ZooKeeper API Errors

Zookeeper::OK: Все хорошо.
Zookeeper::APIERROR: Никогда не выбрасывается сервером и может использоваться только для ограничения диапазона кодов ошибок. Все ошибки большие этой, являются ошибками API (значения меньшие данного означают системные ошибки).
Zookeeper::NONODE: Узел отсутствует.
Zookeeper::NOAUTH: Отсутствует аутентификация.
Zookeeper::BADVERSION: Конфликт версий.
Zookeeper::NOCHILDRENFOREPHEMERALS: Эфемерные узлы не должны иметь потомков.
Zookeeper::NODEEXISTS: Узел уже существует.
Zookeeper::NOTEMPTY: Узел имеет потомков.
Zookeeper::SESSIONEXPIRED: Срок действия сессии истек.
Zookeeper::INVALIDCALLBACK: Задана некорректная функция обратного вызова.
Zookeeper::INVALIDACL: Задан некорректный ACL.
Zookeeper::AUTHFAILED: Неудачная аутентификация клиента.
Zookeeper::CLOSING: ZooKeeper закрывается.
Zookeeper::NOTHING: (не ошибка) Никакакого ответа от сервера для обработки.
Zookeeper::SESSIONMOVED: Сессия перемещена на другой сервер, таким образом операция проигнорирована.
Zookeeper::NOTREADONLY: Запрос изменения статуса отправлен на сервер с режимом "только чтение".
Zookeeper::EPHEMERALONLOCALSESSION: Попытка создать эфемерный узел в локальной сессии.
Zookeeper::NOWATCHER: Невозможно найти наблюдателя.
Zookeeper::RECONFIGDISABLED: Попытка произвести операцию переконфигурации в случае если она запрещена.

Содержание

Zookeeper::addAuth — Specify application credentials
Zookeeper::close — Close the zookeeper handle and free up any resources
Zookeeper::connect — Create a handle to used communicate with zookeeper
Zookeeper::__construct — Create a handle to used communicate with zookeeper
Zookeeper::create — Create a node synchronously
Zookeeper::delete — Delete a node in zookeeper synchronously
Zookeeper::exists — Checks the existence of a node in zookeeper synchronously
Zookeeper::get — Gets the data associated with a node synchronously
Zookeeper::getAcl — Gets the acl associated with a node synchronously
Zookeeper::getChildren — Lists the children of a node synchronously
Zookeeper::getClientId — Return the client session id, only valid if the connections is currently connected (ie. last watcher state is ZOO_CONNECTED_STATE)
Zookeeper::getConfig — Get instance of ZookeeperConfig
Zookeeper::getRecvTimeout — 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
Zookeeper::getState — Get the state of the zookeeper connection
Zookeeper::isRecoverable — Checks if the current zookeeper connection state can be recovered
Zookeeper::set — Sets the data associated with a node
Zookeeper::setAcl — Sets the acl associated with a node synchronously
Zookeeper::setDebugLevel — Sets the debugging level for the library
Zookeeper::setDeterministicConnOrder — Enable/disable quorum endpoint order randomization
Zookeeper::setLogStream — Sets the stream to be used by the library for logging
Zookeeper::setWatcher — Set a watcher function