2014-03-07 13:50:58 +00:00
|
|
|
|
#pragma once
|
2014-03-07 19:18:48 +00:00
|
|
|
|
#include <zkutil/Types.h>
|
|
|
|
|
#include <zkutil/KeeperException.h>
|
2014-03-13 14:49:17 +00:00
|
|
|
|
#include <Poco/Util/LayeredConfiguration.h>
|
2014-06-04 13:48:36 +00:00
|
|
|
|
#include <unordered_set>
|
2014-03-07 13:50:58 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
namespace zkutil
|
|
|
|
|
{
|
|
|
|
|
|
|
|
|
|
const UInt32 DEFAULT_SESSION_TIMEOUT = 30000;
|
|
|
|
|
|
2014-06-04 13:48:36 +00:00
|
|
|
|
struct WatchWithPromise;
|
|
|
|
|
|
|
|
|
|
/// Из-за вызова С кода легче самому явно управлять памятью
|
|
|
|
|
typedef WatchWithPromise * WatchWithPromisePtr;
|
|
|
|
|
|
2014-03-07 13:50:58 +00:00
|
|
|
|
/** Сессия в ZooKeeper. Интерфейс существенно отличается от обычного API ZooKeeper.
|
|
|
|
|
* Вместо callback-ов для watch-ей используются std::future.
|
2014-06-04 16:48:55 +00:00
|
|
|
|
* Методы с названиями, не начинающимися с try, бросают исключение при любой ошибке кроме OperationTimeout.
|
|
|
|
|
* При OperationTimeout пытаемся попробоватть еще retry_num раз.
|
2014-03-07 19:18:48 +00:00
|
|
|
|
* Методы с названиями, начинающимися с try, не бросают исключение только при перечисленных видах ошибок.
|
2014-03-07 13:50:58 +00:00
|
|
|
|
* Например, исключение бросается в любом случае, если сессия разорвалась или если не хватает прав или ресурсов.
|
|
|
|
|
*/
|
|
|
|
|
class ZooKeeper
|
|
|
|
|
{
|
|
|
|
|
public:
|
2014-04-24 08:27:39 +00:00
|
|
|
|
typedef Poco::SharedPtr<ZooKeeper> Ptr;
|
|
|
|
|
|
2014-03-07 13:50:58 +00:00
|
|
|
|
ZooKeeper(const std::string & hosts, int32_t sessionTimeoutMs = DEFAULT_SESSION_TIMEOUT, WatchFunction * watch = nullptr);
|
|
|
|
|
|
2014-03-13 14:56:31 +00:00
|
|
|
|
/** конфиг вида
|
|
|
|
|
<zookeeper>
|
|
|
|
|
<node>
|
|
|
|
|
<host>example1</host>
|
|
|
|
|
<port>2181</port>
|
|
|
|
|
</node>
|
|
|
|
|
<node>
|
|
|
|
|
<host>example2</host>
|
|
|
|
|
<port>2181</port>
|
|
|
|
|
</node>
|
|
|
|
|
<session_timeout_ms>30000</session_timeout_ms>
|
|
|
|
|
</zookeeper>
|
|
|
|
|
*/
|
2014-03-14 10:48:54 +00:00
|
|
|
|
ZooKeeper(const Poco::Util::AbstractConfiguration & config, const std::string & config_name,
|
2014-03-13 14:49:17 +00:00
|
|
|
|
WatchFunction * watch = nullptr);
|
|
|
|
|
|
2014-03-22 14:44:44 +00:00
|
|
|
|
~ZooKeeper();
|
|
|
|
|
|
2014-04-24 08:27:39 +00:00
|
|
|
|
/** Создает новую сессию с теми же параметрами. Можно использовать для переподключения, если сессия истекла.
|
|
|
|
|
* Новой сессии соответствует только возвращенный экземпляр ZooKeeper, этот экземпляр не изменяется.
|
|
|
|
|
*/
|
|
|
|
|
Ptr startNewSession() const;
|
|
|
|
|
|
2014-06-04 13:48:36 +00:00
|
|
|
|
int state();
|
|
|
|
|
|
2014-03-07 17:57:53 +00:00
|
|
|
|
/** Возвращает true, если сессия навсегда завершена.
|
2014-04-24 08:27:39 +00:00
|
|
|
|
* Это возможно только если соединение было установлено, потом разорвалось, потом снова восстановилось, но слишком поздно.
|
|
|
|
|
* Это достаточно редкая ситуация.
|
2014-03-07 17:57:53 +00:00
|
|
|
|
* С другой стороны, если, например, указан неправильный сервер или порт, попытки соединения будут продолжаться бесконечно,
|
2014-04-24 08:27:39 +00:00
|
|
|
|
* expired() будет возвращать false, и все вызовы будут выбрасывать исключение ConnectionLoss.
|
2014-03-07 17:57:53 +00:00
|
|
|
|
*/
|
2014-04-24 08:27:39 +00:00
|
|
|
|
bool expired();
|
2014-03-07 13:50:58 +00:00
|
|
|
|
|
2014-06-04 13:48:36 +00:00
|
|
|
|
AclPtr getDefaultACL();
|
2014-03-07 13:50:58 +00:00
|
|
|
|
|
2014-06-04 13:48:36 +00:00
|
|
|
|
void setDefaultACL(AclPtr new_acl);
|
2014-03-07 19:18:48 +00:00
|
|
|
|
|
2014-03-07 13:50:58 +00:00
|
|
|
|
/** Создать znode. Используется ACL, выставленный вызовом setDefaultACL (по умолчанию, всем полный доступ).
|
|
|
|
|
* Если что-то пошло не так, бросить исключение.
|
|
|
|
|
*/
|
2014-06-04 13:48:36 +00:00
|
|
|
|
std::string create(const std::string & path, const std::string & data, int32_t mode);
|
2014-03-07 13:50:58 +00:00
|
|
|
|
|
|
|
|
|
/** Не бросает исключение при следующих ошибках:
|
|
|
|
|
* - Нет родителя создаваемой ноды.
|
|
|
|
|
* - Родитель эфемерный.
|
|
|
|
|
* - Такая нода уже есть.
|
|
|
|
|
* При остальных ошибках бросает исключение.
|
|
|
|
|
*/
|
2014-06-04 13:48:36 +00:00
|
|
|
|
int32_t tryCreate(const std::string & path, const std::string & data, int32_t mode, std::string & pathCreated);
|
|
|
|
|
int32_t tryCreate(const std::string & path, const std::string & data, int32_t mode);
|
2014-03-07 13:50:58 +00:00
|
|
|
|
|
|
|
|
|
/** Удалить ноду, если ее версия равна version (если -1, подойдет любая версия).
|
|
|
|
|
*/
|
|
|
|
|
void remove(const std::string & path, int32_t version = -1);
|
|
|
|
|
|
|
|
|
|
/** Не бросает исключение при следующих ошибках:
|
|
|
|
|
* - Такой ноды нет.
|
|
|
|
|
* - У ноды другая версия.
|
|
|
|
|
* - У ноды есть дети.
|
|
|
|
|
*/
|
2014-06-04 13:48:36 +00:00
|
|
|
|
int32_t tryRemove(const std::string & path, int32_t version = -1);
|
2014-03-07 13:50:58 +00:00
|
|
|
|
|
|
|
|
|
bool exists(const std::string & path, Stat * stat = nullptr, WatchFuture * watch = nullptr);
|
|
|
|
|
|
2014-03-22 14:44:44 +00:00
|
|
|
|
std::string get(const std::string & path, Stat * stat = nullptr, WatchFuture * watch = nullptr);
|
2014-03-07 13:50:58 +00:00
|
|
|
|
|
2014-03-07 19:18:48 +00:00
|
|
|
|
/** Не бросает исключение при следующих ошибках:
|
|
|
|
|
* - Такой ноды нет. В таком случае возвращает false.
|
|
|
|
|
*/
|
|
|
|
|
bool tryGet(const std::string & path, std::string & res, Stat * stat = nullptr, WatchFuture * watch = nullptr);
|
2014-03-07 13:50:58 +00:00
|
|
|
|
|
|
|
|
|
void set(const std::string & path, const std::string & data,
|
|
|
|
|
int32_t version = -1, Stat * stat = nullptr);
|
|
|
|
|
|
2014-03-07 19:18:48 +00:00
|
|
|
|
/** Не бросает исключение при следующих ошибках:
|
|
|
|
|
* - Такой ноды нет.
|
|
|
|
|
* - У ноды другая версия.
|
|
|
|
|
*/
|
2014-06-04 13:48:36 +00:00
|
|
|
|
int32_t trySet(const std::string & path, const std::string & data,
|
2014-03-07 19:18:48 +00:00
|
|
|
|
int32_t version = -1, Stat * stat = nullptr);
|
|
|
|
|
|
2014-03-07 13:50:58 +00:00
|
|
|
|
Strings getChildren(const std::string & path,
|
|
|
|
|
Stat * stat = nullptr,
|
|
|
|
|
WatchFuture * watch = nullptr);
|
|
|
|
|
|
2014-03-07 19:18:48 +00:00
|
|
|
|
/** Не бросает исключение при следующих ошибках:
|
2014-06-04 16:48:55 +00:00
|
|
|
|
* - Такой ноды нет.
|
2014-03-07 19:18:48 +00:00
|
|
|
|
*/
|
2014-06-04 13:48:36 +00:00
|
|
|
|
int32_t tryGetChildren(const std::string & path, Strings & res,
|
2014-03-07 19:18:48 +00:00
|
|
|
|
Stat * stat = nullptr,
|
|
|
|
|
WatchFuture * watch = nullptr);
|
|
|
|
|
|
|
|
|
|
/** Транзакционно выполняет несколько операций. При любой ошибке бросает исключение.
|
|
|
|
|
*/
|
|
|
|
|
OpResultsPtr multi(const Ops & ops);
|
|
|
|
|
|
|
|
|
|
/** Бросает исключение только если какая-нибудь операция вернула "неожиданную" ошибку - такую ошибку,
|
2014-03-22 14:44:44 +00:00
|
|
|
|
* увидев которую соответствующий метод try* бросил бы исключение. */
|
2014-06-04 13:48:36 +00:00
|
|
|
|
int32_t tryMulti(const Ops & ops, OpResultsPtr * out_results = nullptr);
|
2014-03-07 13:50:58 +00:00
|
|
|
|
|
2014-03-22 14:44:44 +00:00
|
|
|
|
|
|
|
|
|
/** Удаляет ноду вместе с поддеревом. Если в это время кто-то добавит иили удалит ноду в поддереве, результат не определен.
|
|
|
|
|
*/
|
|
|
|
|
void removeRecursive(const std::string & path);
|
|
|
|
|
|
2014-06-04 13:48:36 +00:00
|
|
|
|
static std::string error2string(int32_t code);
|
|
|
|
|
|
|
|
|
|
/// максимальный размер данных в узле в байтах
|
|
|
|
|
/// В версии 3.4.5. максимальный размер узла 1 Mb
|
|
|
|
|
static const size_t MAX_NODE_SIZE = 1048576;
|
|
|
|
|
|
|
|
|
|
/// Размер прибавляемого ZooKeeper суффикса при создании Sequential ноды
|
|
|
|
|
/// На самом деле размер меньше, но для удобства округлим в верхнюю сторону
|
|
|
|
|
static const size_t SEQUENTIAL_SUFFIX_SIZE = 64;
|
2014-03-07 13:50:58 +00:00
|
|
|
|
private:
|
2014-03-13 14:49:17 +00:00
|
|
|
|
void init(const std::string & hosts, int32_t sessionTimeoutMs, WatchFunction * watch_);
|
2014-06-04 13:48:36 +00:00
|
|
|
|
void removeChildrenRecursive(const std::string & path);
|
|
|
|
|
WatchWithPromisePtr watchForFuture(WatchFuture * future);
|
|
|
|
|
static void processPromise(zhandle_t * zh, int type, int state, const char * path, void *watcherCtx);
|
2014-04-25 13:55:15 +00:00
|
|
|
|
|
2014-06-04 16:48:55 +00:00
|
|
|
|
template <class T>
|
|
|
|
|
int32_t retry(const T & operation)
|
|
|
|
|
{
|
|
|
|
|
int32_t code = operation();
|
|
|
|
|
for (size_t i = 0; (i < retry_num) && (code == ZOPERATIONTIMEOUT); ++i)
|
|
|
|
|
{
|
|
|
|
|
code = operation();
|
|
|
|
|
}
|
|
|
|
|
return code;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// методы не бросают исключений, а возвращают коды ошибок
|
|
|
|
|
int32_t createImpl(const std::string & path, const std::string & data, int32_t mode, std::string & pathCreated);
|
|
|
|
|
int32_t removeImpl(const std::string & path, int32_t version = -1);
|
2014-06-27 12:08:15 +00:00
|
|
|
|
int32_t getImpl(const std::string & path, std::string & res, Stat * stat = nullptr, WatchFuture * watch = nullptr);
|
2014-06-04 16:48:55 +00:00
|
|
|
|
int32_t setImpl(const std::string & path, const std::string & data,
|
|
|
|
|
int32_t version = -1, Stat * stat = nullptr);
|
|
|
|
|
int32_t getChildrenImpl(const std::string & path, Strings & res,
|
|
|
|
|
Stat * stat = nullptr,
|
|
|
|
|
WatchFuture * watch = nullptr);
|
|
|
|
|
int32_t multiImpl(const Ops & ops, OpResultsPtr * out_results = nullptr);
|
|
|
|
|
int32_t existsImpl(const std::string & path, Stat * stat_, WatchFuture * watch = nullptr);
|
|
|
|
|
|
2014-05-13 10:10:26 +00:00
|
|
|
|
std::string hosts;
|
2014-04-25 13:55:15 +00:00
|
|
|
|
int32_t sessionTimeoutMs;
|
2014-03-21 18:58:24 +00:00
|
|
|
|
|
|
|
|
|
Poco::FastMutex mutex;
|
2014-06-04 13:48:36 +00:00
|
|
|
|
AclPtr default_acl;
|
|
|
|
|
zhandle_t * impl;
|
2014-05-19 09:21:57 +00:00
|
|
|
|
|
2014-06-04 13:48:36 +00:00
|
|
|
|
WatchFunction * state_watch;
|
|
|
|
|
std::unordered_set<WatchWithPromise *> watch_store;
|
2014-06-04 16:48:55 +00:00
|
|
|
|
|
|
|
|
|
/// Количество попыток повторить операцию при OperationTimeout
|
|
|
|
|
size_t retry_num = 3;
|
2014-03-07 13:50:58 +00:00
|
|
|
|
};
|
|
|
|
|
|
2014-04-25 13:55:15 +00:00
|
|
|
|
typedef ZooKeeper::Ptr ZooKeeperPtr;
|
|
|
|
|
|
2014-03-22 14:44:44 +00:00
|
|
|
|
|
|
|
|
|
/** В конструкторе создает эфемерную ноду, в деструкторе - удаляет.
|
|
|
|
|
*/
|
|
|
|
|
class EphemeralNodeHolder
|
|
|
|
|
{
|
|
|
|
|
public:
|
|
|
|
|
typedef Poco::SharedPtr<EphemeralNodeHolder> Ptr;
|
|
|
|
|
|
|
|
|
|
EphemeralNodeHolder(const std::string & path_, ZooKeeper & zookeeper_, bool create, bool sequential, const std::string & data)
|
|
|
|
|
: path(path_), zookeeper(zookeeper_)
|
|
|
|
|
{
|
|
|
|
|
if (create)
|
2014-04-04 10:37:33 +00:00
|
|
|
|
path = zookeeper.create(path, data, sequential ? CreateMode::EphemeralSequential : CreateMode::Ephemeral);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
std::string getPath() const
|
|
|
|
|
{
|
|
|
|
|
return path;
|
2014-03-22 14:44:44 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static Ptr create(const std::string & path, ZooKeeper & zookeeper, const std::string & data = "")
|
|
|
|
|
{
|
|
|
|
|
return new EphemeralNodeHolder(path, zookeeper, true, false, data);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static Ptr createSequential(const std::string & path, ZooKeeper & zookeeper, const std::string & data = "")
|
|
|
|
|
{
|
|
|
|
|
return new EphemeralNodeHolder(path, zookeeper, true, true, data);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static Ptr existing(const std::string & path, ZooKeeper & zookeeper)
|
|
|
|
|
{
|
|
|
|
|
return new EphemeralNodeHolder(path, zookeeper, false, false, "");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
~EphemeralNodeHolder()
|
|
|
|
|
{
|
|
|
|
|
try
|
|
|
|
|
{
|
|
|
|
|
zookeeper.tryRemove(path);
|
|
|
|
|
}
|
|
|
|
|
catch (KeeperException) {}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
std::string path;
|
|
|
|
|
ZooKeeper & zookeeper;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
typedef EphemeralNodeHolder::Ptr EphemeralNodeHolderPtr;
|
|
|
|
|
|
2014-03-07 13:50:58 +00:00
|
|
|
|
}
|