MySQL 8.3.0
Source Code Documentation
Transaction_prepared_message Class Reference

#include <transaction_prepared_message.h>

Inheritance diagram for Transaction_prepared_message:
[legend]

Public Types

enum  enum_payload_item_type {
  PIT_UNKNOWN = 0 , PIT_TRANSACTION_PREPARED_GNO = 1 , PIT_TRANSACTION_PREPARED_SID = 2 , PIT_SENT_TIMESTAMP = 3 ,
  PIT_TRANSACTION_PREPARED_TAG = 4 , PIT_MAX = 5
}
 
using Error_ptr = mysql::utils::Error_ptr
 
- 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_RECOVERY_METADATA_MESSAGE = 14 , CT_MAX = 15
}
 The different cargo type codes. More...
 

Public Member Functions

 Transaction_prepared_message (const gr::Gtid_tsid &tsid, bool is_tsid_specified, rpl_gno gno)
 Message constructor. More...
 
 Transaction_prepared_message (const unsigned char *buf, size_t len)
 Message decode constructor. More...
 
 ~Transaction_prepared_message () override
 
rpl_gno get_gno ()
 
bool is_tsid_specified () const
 returns information on whether TSID is specified for this trx More...
 
const gr::Gtid_tsidget_tsid ()
 TSID accessor. More...
 
bool is_valid () const
 Checks whether message encoding/decoding succeeded. More...
 
const Error_ptrget_error () const
 Gets information about decoding/encoding error. More...
 
- Public Member Functions inherited from Plugin_gcs_message
virtual ~Plugin_gcs_message ()=default
 
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...
 

Static Public Member Functions

static uint64_t get_sent_timestamp (const unsigned char *buffer, size_t length)
 Return the time at which the message contained in the buffer was sent. More...
 
- 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 bool get_payload_item_type_raw_data (const unsigned char *buffer, const unsigned char *end, uint16 payload_item_type, const unsigned char **payload_item_data, unsigned long long *payload_item_length)
 Return the raw data of the payload item of a given payload type of a given message buffer. More...
 

Protected Member Functions

void encode_payload (std::vector< unsigned char > *buffer) const override
 Encodes the contents of this instance payload into the buffer. More...
 
void decode_payload (const unsigned char *buffer, const unsigned char *end) override
 Decodes the contents of the buffer and sets the payload field values according to the values decoded. More...
 
- Protected Member Functions inherited from Plugin_gcs_message
 Plugin_gcs_message (enum_cargo_type cargo_type)
 Plugin_gcs_message constructor. More...
 
void encode_header (std::vector< unsigned char > *buffer) const
 Encodes the header of this instance into the buffer. More...
 
void decode_header (const unsigned char **slider)
 Decodes the header of the buffer into this instance. 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 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

bool m_tsid_specified
 
rpl_gno m_gno
 
gr::Gtid_tsid m_tsid
 
Error_ptr m_error
 Holds information about error that might occur during encoding/decoding. More...
 

Additional Inherited Members

- 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 int64_t get_sent_timestamp (const unsigned char *buffer, size_t length, const uint16 timestamp_payload_item_type)
 Return the time at which the message contained in the buffer was sent. More...
 
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...
 
static 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...
 

Member Typedef Documentation

◆ Error_ptr

Member Enumeration Documentation

◆ enum_payload_item_type

Enumerator
PIT_UNKNOWN 
PIT_TRANSACTION_PREPARED_GNO 
PIT_TRANSACTION_PREPARED_SID 
PIT_SENT_TIMESTAMP 
PIT_TRANSACTION_PREPARED_TAG 
PIT_MAX 

Constructor & Destructor Documentation

◆ Transaction_prepared_message() [1/2]

Transaction_prepared_message::Transaction_prepared_message ( const gr::Gtid_tsid tsid,
bool  is_tsid_specified,
rpl_gno  gno 
)

Message constructor.

Parameters
[in]tsidthe prepared transaction tsid
[in]is_tsid_specifiedinformation on whether tsid is specified
[in]gnothe prepared transaction gno

◆ Transaction_prepared_message() [2/2]

Transaction_prepared_message::Transaction_prepared_message ( const unsigned char *  buf,
size_t  len 
)

Message decode constructor.

Parameters
[in]bufmessage buffer
[in]lenmessage buffer length

◆ ~Transaction_prepared_message()

Transaction_prepared_message::~Transaction_prepared_message ( )
overridedefault

Member Function Documentation

◆ decode_payload()

void Transaction_prepared_message::decode_payload ( const unsigned char *  buffer,
const unsigned char *  end 
)
overrideprotectedvirtual

Decodes the contents of the buffer and sets the payload field values according to the values decoded.

Parameters
[in]bufferthe buffer to decode from.
[in]endthe end of the buffer.

Implements Plugin_gcs_message.

◆ encode_payload()

void Transaction_prepared_message::encode_payload ( std::vector< unsigned char > *  buffer) const
overrideprotectedvirtual

Encodes the contents of this instance payload into the buffer.

Parameters
[out]bufferthe buffer to encode to.

Implements Plugin_gcs_message.

◆ get_error()

const Transaction_prepared_message::Error_ptr & Transaction_prepared_message::get_error ( ) const

Gets information about decoding/encoding error.

Returns
Const reference to decoding/encoding error information

◆ get_gno()

rpl_gno Transaction_prepared_message::get_gno ( )

◆ get_sent_timestamp()

uint64_t Transaction_prepared_message::get_sent_timestamp ( const unsigned char *  buffer,
size_t  length 
)
static

Return the time at which the message contained in the buffer was sent.

See also
Metrics_handler::get_current_time()
Parameters
[in]bufferthe buffer to decode from.
[in]lengththe buffer length
Returns
the time on which the message was sent.

◆ get_tsid()

const gr::Gtid_tsid & Transaction_prepared_message::get_tsid ( )

TSID accessor.

Returns
Const reference to transaction TSID

◆ is_tsid_specified()

bool Transaction_prepared_message::is_tsid_specified ( ) const
inline

returns information on whether TSID is specified for this trx

Returns
information on whether TSID is specified for this trx

◆ is_valid()

bool Transaction_prepared_message::is_valid ( void  ) const

Checks whether message encoding/decoding succeeded.

Returns
Message validity

Member Data Documentation

◆ m_error

Error_ptr Transaction_prepared_message::m_error
private

Holds information about error that might occur during encoding/decoding.

◆ m_gno

rpl_gno Transaction_prepared_message::m_gno
private

◆ m_tsid

gr::Gtid_tsid Transaction_prepared_message::m_tsid
private

◆ m_tsid_specified

bool Transaction_prepared_message::m_tsid_specified
private

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