diff options
Diffstat (limited to 'qpid/cpp/src/qpid/ha/types.h')
-rw-r--r-- | qpid/cpp/src/qpid/ha/types.h | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/qpid/cpp/src/qpid/ha/types.h b/qpid/cpp/src/qpid/ha/types.h new file mode 100644 index 0000000000..ae4b948dfc --- /dev/null +++ b/qpid/cpp/src/qpid/ha/types.h @@ -0,0 +1,147 @@ +#ifndef QPID_HA_ENUM_H +#define QPID_HA_ENUM_H + +/* + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +#include "qpid/types/Variant.h" +#include "qpid/types/Uuid.h" +#include "qpid/framing/SequenceSet.h" + +#include <boost/shared_ptr.hpp> + +#include <string> +#include <set> +#include <iosfwd> + +namespace qpid { + +namespace broker { +class Message; +class Queue; +} +namespace framing { +class FieldTable; +} + +namespace ha { + +/** Base class for enums with string conversion */ +class EnumBase { + public: + EnumBase(const char* name_, const char* names_[], size_t count_, unsigned value) + : name(name_), names(names_), count(count_), value(value) {} + + /** Convert to string */ + std::string str() const; + /** Parse from string, throw if unsuccessful */ + void parse(const std::string&); + /** Parse from string, return false if unsuccessful. */ + bool parseNoThrow(const std::string&); + + protected: + const char* name; + const char** names; + size_t count; + unsigned value; +}; + +std::ostream& operator<<(std::ostream&, EnumBase); +std::istream& operator>>(std::istream&, EnumBase&); + +/** Wrapper template for enums with string conversion */ +template <class T> class Enum : public EnumBase { + public: + Enum(T x=T()) : EnumBase(NAME, NAMES, N, x) {} + T get() const { return T(value); } + void operator=(T x) { value = x; } + + private: + static const size_t N; // Number of enum values. + static const char* NAMES[]; // Names of enum values. + static const char* NAME; // Descriptive name for the enum type. +}; + +/** To print an enum x: o << printable(x) */ +template <class T> Enum<T> printable(T x) { return Enum<T>(x); } + +enum ReplicateLevel { + NONE, ///< Nothing is replicated + CONFIGURATION, ///< Wiring is replicated but not messages + ALL ///< Everything is replicated +}; + +/** State of a broker: see HaBroker::setStatus for state diagram */ +enum BrokerStatus { + JOINING, ///< New broker, looking for primary + CATCHUP, ///< Backup: Connected to primary, catching up on state. + READY, ///< Backup: Caught up, ready to take over. + RECOVERING, ///< Primary: waiting for backups to connect & sync + ACTIVE, ///< Primary: actively serving clients. + STANDALONE ///< Not part of a cluster. +}; + +inline bool isPrimary(BrokerStatus s) { + return s == RECOVERING || s == ACTIVE || s == STANDALONE; +} + +inline bool isBackup(BrokerStatus s) { return !isPrimary(s); } + +// String constants, defined as char* to avoid initialization order problems. +extern const std::string QPID_REPLICATE; +extern const std::string QPID_HA_UUID; + +// Strings used as prefixes, defined as char* to avoid link order problems. +extern const char* QPID_HA_PREFIX; +extern const char* QUEUE_REPLICATOR_PREFIX; +extern const char* TRANSACTION_REPLICATOR_PREFIX; + +bool startsWith(const std::string& name, const std::string& prefix); + +/** Define IdSet type, not a typedef so we can overload operator << and add encoding.*/ +class UuidSet : public std::set<types::Uuid> { + public: + void encode(framing::Buffer&) const; + void decode(framing::Buffer&); + size_t encodedSize() const; +}; + +std::ostream& operator<<(std::ostream& o, const UuidSet& ids); + +// Use type names to distinguish Positions from Replication Ids +typedef framing::SequenceNumber QueuePosition; +typedef framing::SequenceNumber ReplicationId; +typedef framing::SequenceSet QueuePositionSet; +typedef framing::SequenceSet ReplicationIdSet; + +/** Helpers for logging message ID */ +std::string logMessageId(const std::string& q, QueuePosition pos, ReplicationId id); +std::string logMessageId(const std::string& q, ReplicationId id); +std::string logMessageId(const std::string& q, const broker::Message& m); +std::string logMessageId(const broker::Queue& q, QueuePosition pos, ReplicationId id); +std::string logMessageId(const broker::Queue& q, ReplicationId id); +std::string logMessageId(const broker::Queue& q, const broker::Message& m); + +/** Return short version of human-readable UUID. */ +inline std::string shortStr(const types::Uuid& uuid) { return uuid.str().substr(0,8); } + +}} // qpid::ha +#endif /*!QPID_HA_ENUM_H*/ |