MySQL  8.0.20
Source Code Documentation
Recovery_message Class Reference

#include <recovery_message.h>

Inheritance diagram for Recovery_message:
Plugin_gcs_message

Public Types

enum  enum_payload_item_type { PIT_UNKNOWN = 0, PIT_RECOVERY_MESSAGE_TYPE = 1, PIT_MEMBER_UUID = 2, PIT_MAX = 3 }
 
enum  Recovery_message_type { RECOVERY_UNKNOWN = 0, RECOVERY_END_MESSAGE = 1, DONOR_FINISHED_MESSAGE = 2, RECOVERY_MESSAGE_TYPE_END = 3 }
 The several recovery type messages. More...
 
- Public Types inherited from Plugin_gcs_message
enum  enum_cargo_type {
  CT_UNKNOWN = 0, CT_CERTIFICATION_MESSAGE = 1, CT_TRANSACTION_MESSAGE = 2, CT_RECOVERY_MESSAGE = 3,
  CT_MEMBER_INFO_MESSAGE = 4, CT_MEMBER_INFO_MANAGER_MESSAGE = 5, CT_PIPELINE_STATS_MEMBER_MESSAGE = 6, CT_SINGLE_PRIMARY_MESSAGE = 7,
  CT_GROUP_ACTION_MESSAGE = 8, CT_GROUP_VALIDATION_MESSAGE = 9, CT_SYNC_BEFORE_EXECUTION_MESSAGE = 10, CT_TRANSACTION_WITH_GUARANTEE_MESSAGE = 11,
  CT_TRANSACTION_PREPARED_MESSAGE = 12, CT_MESSAGE_SERVICE_MESSAGE = 13, CT_MAX = 14
}
 The different cargo type codes. More...
 

Public Member Functions

 Recovery_message (Recovery_message_type type, const std::string &member_uuid)
 Message constructor. More...
 
virtual ~Recovery_message ()
 Message destructor. More...
 
 Recovery_message (const uchar *buf, size_t len)
 Message constructor for raw data. More...
 
Recovery_message_type get_recovery_message_type ()
 Returns this recovery message type. More...
 
const std::string & get_member_uuid ()
 Returns this message sender's uuid. More...
 
- Public Member Functions inherited from Plugin_gcs_message
virtual ~Plugin_gcs_message ()
 
int get_version ()
 
unsigned short get_header_length ()
 
enum_cargo_type get_cargo_type () const
 
unsigned long long get_msg_length ()
 
void encode (std::vector< unsigned char > *buffer) const
 Encodes the contents of this instance into the buffer. More...
 
void decode (const unsigned char *buffer, size_t length)
 Decodes the contents of the buffer and sets the field values according to the values decoded. More...
 

Protected Member Functions

void encode_payload (std::vector< unsigned char > *buffer) const
 Encodes the message contents for transmission. More...
 
void decode_payload (const unsigned char *buffer, const unsigned char *)
 Message decoding method. More...
 
- Protected Member Functions inherited from Plugin_gcs_message
 Plugin_gcs_message (enum_cargo_type cargo_type)
 Plugin_gcs_message constructor. More...
 
void encode_payload_item_type_and_length (std::vector< unsigned char > *buffer, uint16 payload_item_type, unsigned long long payload_item_length) const
 Encodes the given payload item type and length into the buffer. More...
 
void encode_payload_item_char (std::vector< unsigned char > *buffer, uint16 type, unsigned char value) const
 Encodes the given payload item (type, length and value) into the buffer as a char (1 byte). More...
 
void encode_payload_item_int2 (std::vector< unsigned char > *buffer, uint16 type, uint16 value) const
 Encodes the given payload item (type, length and value) into the buffer as a 2 bytes integer. More...
 
void decode_payload_item_int2 (const unsigned char **buffer, uint16 *type, uint16 *value)
 Decodes the given payload item (type, length and value) from the buffer as a 2 bytes integer. More...
 
void encode_payload_item_int4 (std::vector< unsigned char > *buffer, uint16 type, uint32 value) const
 Encodes the given payload item (type, length and value) into the buffer as a 4 bytes integer. More...
 
void decode_payload_item_int4 (const unsigned char **buffer, uint16 *type, uint32 *value)
 Decodes the given payload item (type, length and value) from the buffer as a 4 bytes integer. More...
 
void encode_payload_item_int8 (std::vector< unsigned char > *buffer, uint16 type, ulonglong value) const
 Encodes the given payload item (type, length and value) into the buffer as a 8 bytes integer. More...
 
void decode_payload_item_int8 (const unsigned char **buffer, uint16 *type, uint64 *value)
 Decodes the given payload item (type, length and value) from the buffer as a 8 bytes integer. More...
 
void encode_payload_item_string (std::vector< unsigned char > *buffer, uint16 type, const char *value, unsigned long long length) const
 Encodes the given payload item (type, length and value) into the buffer as a char array (variable size). More...
 
void decode_payload_item_string (const unsigned char **buffer, uint16 *type, std::string *value, unsigned long long *length)
 Decodes the given payload item (type, length and value) from the buffer as a char array (variable size). More...
 
void encode_payload_item_bytes (std::vector< unsigned char > *buffer, uint16 type, const unsigned char *value, unsigned long long length) const
 Encodes the given payload item (type, length and value) into the buffer as a byte buffer (variable size). More...
 
void decode_payload_item_bytes (const unsigned char **buffer, uint16 *type, unsigned char *value, unsigned long long *length)
 Decodes the given payload item (type, length and value) from the buffer as a byte buffer (variable size). More...
 

Private Attributes

Recovery_message_type recovery_message_type
 The message type. More...
 
std::string member_uuid
 The member uuid where the message originated. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Plugin_gcs_message
static enum_cargo_type get_cargo_type (const unsigned char *buffer)
 Return the cargo type of a given message buffer, without decode the complete message. More...
 
static void get_first_payload_item_raw_data (const unsigned char *buffer, const unsigned char **payload_item_data, size_t *payload_item_length)
 Return the raw data of the first payload item of a given message buffer, without decode the complete message. More...
 
- Static Public Attributes inherited from Plugin_gcs_message
static const int PLUGIN_GCS_MESSAGE_VERSION = 1
 The protocol version number. More...
 
static const unsigned int WIRE_VERSION_SIZE = 4
 The protocol version number. More...
 
static const unsigned int WIRE_HD_LEN_SIZE = 2
 The on-the-wire size of the header length field. More...
 
static const unsigned int WIRE_MSG_LEN_SIZE = 8
 The on-the-wire size of the message size field. More...
 
static const unsigned int WIRE_CARGO_TYPE_SIZE = 2
 The on-the-wire size of the cargo type field. More...
 
static const unsigned int WIRE_FIXED_HEADER_SIZE
 The on-the-wire size of the fixed header. More...
 
static const unsigned int WIRE_PAYLOAD_ITEM_TYPE_SIZE = 2
 The on-the-wire size of the each payload item type field. More...
 
static const unsigned int WIRE_PAYLOAD_ITEM_LEN_SIZE = 8
 The on-the-wire size of the each payload item size field. More...
 
static const unsigned int WIRE_PAYLOAD_ITEM_HEADER_SIZE
 The on-the-wire size of the payload item header. More...
 
- Static Protected Member Functions inherited from Plugin_gcs_message
static void decode_payload_item_type_and_length (const unsigned char **buffer, uint16 *payload_item_type, unsigned long long *payload_item_length)
 Decodes the given payload item type and length from the buffer. More...
 
static void decode_payload_item_char (const unsigned char **buffer, uint16 *type, unsigned char *value)
 Decodes the given payload item (type, length and value) from the buffer as a char (1 byte). More...
 

Member Enumeration Documentation

◆ enum_payload_item_type

Enumerator
PIT_UNKNOWN 
PIT_RECOVERY_MESSAGE_TYPE 
PIT_MEMBER_UUID 
PIT_MAX 

◆ Recovery_message_type

The several recovery type messages.

Enumerator
RECOVERY_UNKNOWN 

This type should not be used anywhere.

RECOVERY_END_MESSAGE 

Recovery ended, member is online.

DONOR_FINISHED_MESSAGE 

Donor transmitted all data (for future use)

RECOVERY_MESSAGE_TYPE_END 

The end of the enum.

Constructor & Destructor Documentation

◆ Recovery_message() [1/2]

Recovery_message::Recovery_message ( Recovery_message_type  type,
const std::string &  member_uuid 
)

Message constructor.

Parameters
[in]typethe recovery message type
[in]member_uuidthe origination member uuid

◆ ~Recovery_message()

Recovery_message::~Recovery_message ( )
virtual

Message destructor.

◆ Recovery_message() [2/2]

Recovery_message::Recovery_message ( const uchar buf,
size_t  len 
)

Message constructor for raw data.

Parameters
[in]bufraw data
[in]lenraw length

Member Function Documentation

◆ decode_payload()

void Recovery_message::decode_payload ( const unsigned char *  buffer,
const unsigned char *   
)
protectedvirtual

Message decoding method.

Parameters
[in]bufferthe received data

Implements Plugin_gcs_message.

◆ encode_payload()

void Recovery_message::encode_payload ( std::vector< unsigned char > *  buffer) const
protectedvirtual

Encodes the message contents for transmission.

Parameters
[out]bufferthe message buffer to be written

Implements Plugin_gcs_message.

◆ get_member_uuid()

const std::string& Recovery_message::get_member_uuid ( )
inline

Returns this message sender's uuid.

◆ get_recovery_message_type()

Recovery_message_type Recovery_message::get_recovery_message_type ( )
inline

Returns this recovery message type.

Member Data Documentation

◆ member_uuid

std::string Recovery_message::member_uuid
private

The member uuid where the message originated.

◆ recovery_message_type

Recovery_message_type Recovery_message::recovery_message_type
private

The message type.


The documentation for this class was generated from the following files: