NotificationType.h

Go to the documentation of this file.

 
#pragma once
#include "FacilityCode.h"
#include "catapult/utils/Casting.h"
 
namespace catapult { namespace model {
 
    enum class NotificationChannel : uint8_t {
        None = 0x00,
 
        Validator = 0x01,
 
        Observer = 0x02,
 
        All = 0xFF
    };
 
    enum class NotificationType : uint32_t {};
 
    constexpr NotificationType MakeNotificationType(NotificationChannel channel, FacilityCode facility, uint16_t code) {
        return static_cast<NotificationType>(
                static_cast<uint32_t>(channel) << 24 | //  01..08: channel
                static_cast<uint32_t>(facility) << 16 | // 09..16: facility
                code); //                                  16..32: code
    }
 
#define DEFINE_NOTIFICATION_TYPE(CHANNEL, FACILITY, DESCRIPTION, CODE) \
    constexpr auto FACILITY##_##DESCRIPTION##_Notification = model::MakeNotificationType( \
            (model::NotificationChannel::CHANNEL), \
            (model::FacilityCode::FACILITY), \
            CODE)
 
    constexpr bool IsSet(NotificationType type, NotificationChannel channel) {
        return utils::to_underlying_type(channel) == (utils::to_underlying_type(channel) & (utils::to_underlying_type(type) >> 24));
    }
 
    constexpr NotificationChannel GetNotificationChannel(NotificationType type) {
        return static_cast<NotificationChannel>(utils::to_underlying_type(type) >> 24);
    }
 
    constexpr void SetNotificationChannel(NotificationType& type, NotificationChannel channel) {
        type = static_cast<NotificationType>(
                static_cast<uint32_t>(utils::to_underlying_type(channel) << 24) |
                (0x00FFFFFFu & utils::to_underlying_type(type)));
    }
 
    constexpr bool AreEqualExcludingChannel(NotificationType lhs, NotificationType rhs) {
        return (0x00FFFFFFu & utils::to_underlying_type(lhs)) == (0x00FFFFFFu & utils::to_underlying_type(rhs));
    }
 
    // region core notification types
 
#define DEFINE_CORE_NOTIFICATION(DESCRIPTION, CODE, CHANNEL) DEFINE_NOTIFICATION_TYPE(CHANNEL, Core, DESCRIPTION, CODE)
 
    DEFINE_CORE_NOTIFICATION(Register_Account_Address, 0x0001, All);
 
    DEFINE_CORE_NOTIFICATION(Register_Account_Public_Key, 0x0002, Observer);
 
    DEFINE_CORE_NOTIFICATION(Balance_Transfer, 0x0003, All);
 
    DEFINE_CORE_NOTIFICATION(Entity, 0x0004, Validator);
 
    DEFINE_CORE_NOTIFICATION(Block, 0x0005, All);
 
    DEFINE_CORE_NOTIFICATION(Transaction, 0x0006, All);
 
    DEFINE_CORE_NOTIFICATION(Signature, 0x0007, Validator);
 
    DEFINE_CORE_NOTIFICATION(Balance_Debit, 0x0008, All);
 
    DEFINE_CORE_NOTIFICATION(Address_Interaction, 0x0009, Validator);
 
    DEFINE_CORE_NOTIFICATION(Mosaic_Required, 0x000A, Validator);
 
    DEFINE_CORE_NOTIFICATION(Source_Change, 0x000B, Observer);
 
    DEFINE_CORE_NOTIFICATION(Transaction_Fee, 0x000C, All);
 
    DEFINE_CORE_NOTIFICATION(Transaction_Deadline, 0x000D, Validator);
 
#undef DEFINE_CORE_NOTIFICATION
 
    // endregion
}}