CatapultServer  v0.5.0.1 (Elephant)
NotificationType.h File Reference
Include dependency graph for NotificationType.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 catapult
 
 catapult::model
 

Macros

#define DEFINE_NOTIFICATION_TYPE(CHANNEL, FACILITY, DESCRIPTION, CODE)
 Defines a notification type given CHANNEL, FACILITY, DESCRIPTION and CODE. More...
 
#define DEFINE_CORE_NOTIFICATION(DESCRIPTION, CODE, CHANNEL)   DEFINE_NOTIFICATION_TYPE(CHANNEL, Core, DESCRIPTION, CODE)
 Defines a core notification type with DESCRIPTION, CODE and CHANNEL. More...
 

Enumerations

enum  catapult::model::NotificationChannel : uint8_t { catapult::model::NotificationChannel::None = 0x00, catapult::model::NotificationChannel::Validator = 0x01, catapult::model::NotificationChannel::Observer = 0x02, catapult::model::NotificationChannel::All = 0xFF }
 Notification channel. More...
 
enum  catapult::model::NotificationType : uint32_t
 Enumeration of all possible notification types. More...
 

Functions

constexpr NotificationType catapult::model::MakeNotificationType (NotificationChannel channel, FacilityCode facility, uint16_t code)
 Makes a notification type given channel, facility and code. More...
 
constexpr bool catapult::model::IsSet (NotificationType type, NotificationChannel channel)
 Checks if type has channel set. More...
 
constexpr NotificationChannel catapult::model::GetNotificationChannel (NotificationType type)
 Gets the notification channel set in type. More...
 
constexpr void catapult::model::SetNotificationChannel (NotificationType &type, NotificationChannel channel)
 Sets the notification channel in type to channel. More...
 
constexpr bool catapult::model::AreEqualExcludingChannel (NotificationType lhs, NotificationType rhs)
 Returns true if lhs and rhs have the same source (facility and code). More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Register_Account_Address, 0x0001, All)
 Account was used with specified address. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Register_Account_Public_Key, 0x0002, Observer)
 Account was used with specified public key. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Balance_Transfer, 0x0003, All)
 Mosaic was transferred between two accounts. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Entity, 0x0004, Validator)
 Entity was received. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Block, 0x0005, All)
 Block was received. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Transaction, 0x0006, All)
 Transaction was received. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Signature, 0x0007, Validator)
 Signature was received. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Balance_Debit, 0x0008, All)
 Mosaic was debited from account. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Address_Interaction, 0x0009, Validator)
 Source address interacts with destination addresses. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Mosaic_Required, 0x000A, Validator)
 Mosaic is required. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Source_Change, 0x000B, Observer)
 Source has changed. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Transaction_Fee, 0x000C, All)
 Transaction fee was received. More...
 
 catapult::model::DEFINE_CORE_NOTIFICATION (Transaction_Deadline, 0x000D, Validator)
 Transaction deadline was received. More...
 

Macro Definition Documentation

◆ DEFINE_CORE_NOTIFICATION

#define DEFINE_CORE_NOTIFICATION (   DESCRIPTION,
  CODE,
  CHANNEL 
)    DEFINE_NOTIFICATION_TYPE(CHANNEL, Core, DESCRIPTION, CODE)

Defines a core notification type with DESCRIPTION, CODE and CHANNEL.

◆ DEFINE_NOTIFICATION_TYPE

#define DEFINE_NOTIFICATION_TYPE (   CHANNEL,
  FACILITY,
  DESCRIPTION,
  CODE 
)
Value:
constexpr auto FACILITY##_##DESCRIPTION##_Notification = model::MakeNotificationType( \
(model::NotificationChannel::CHANNEL), \
(model::FacilityCode::FACILITY), \
CODE)

Defines a notification type given CHANNEL, FACILITY, DESCRIPTION and CODE.

catapult::model::MakeNotificationType
constexpr NotificationType MakeNotificationType(NotificationChannel channel, FacilityCode facility, uint16_t code)
Makes a notification type given channel, facility and code.
Definition: NotificationType.h:46