Gcs_stage_metadata Class Reference

Abstract class that defines specific metadata associated to a stage if it decides to extend it. More...

#include <gcs_internal_message_headers.h>

Inheritance diagram for Gcs_stage_metadata:

Public Member Functions
	Gcs_stage_metadata ()=default
virtual	~Gcs_stage_metadata ()
	Gcs_stage_metadata (const Gcs_stage_metadata &)=default
Gcs_stage_metadata &	operator= (const Gcs_stage_metadata &)=default
	Gcs_stage_metadata (Gcs_stage_metadata &&)=default
Gcs_stage_metadata &	operator= (Gcs_stage_metadata &&)=default
virtual std::unique_ptr< Gcs_stage_metadata >	clone ()=0
	Creates a deep copy of this object. More...
virtual unsigned long long	calculate_encode_length () const =0
	Calculate the length required to encode this object. More...
virtual unsigned long long	encode (unsigned char *buffer) const =0
	Encode the contents of this instance into the buffer. More...
virtual unsigned long long	decode (const unsigned char *buffer)=0
	Decode the contents of the buffer and sets the field values according to the values decoded. More...
virtual void	dump (std::ostringstream &output) const =0
	Create a string representation of the header to be logged. More...

Detailed Description

Abstract class that defines specific metadata associated to a stage if it decides to extend it.

Constructor & Destructor Documentation

Gcs_stage_metadata() [1/3]

Gcs_stage_metadata::Gcs_stage_metadata ( )

default

~Gcs_stage_metadata()

Gcs_stage_metadata::~Gcs_stage_metadata ( )

virtualdefault

Gcs_stage_metadata() [2/3]

Gcs_stage_metadata::Gcs_stage_metadata ( const Gcs_stage_metadata &  )

default

Gcs_stage_metadata() [3/3]

Gcs_stage_metadata::Gcs_stage_metadata ( Gcs_stage_metadata &&  )

default

Member Function Documentation

calculate_encode_length()

virtual unsigned long long Gcs_stage_metadata::calculate_encode_length ( ) const

pure virtual

Calculate the length required to encode this object.

Implemented in Gcs_empty_stage_metadata, and Gcs_split_header_v2.

clone()

virtual std::unique_ptr< Gcs_stage_metadata > Gcs_stage_metadata::clone ( )

pure virtual

Creates a deep copy of this object.

Returns

a deep copy of this object.

Implemented in Gcs_empty_stage_metadata, and Gcs_split_header_v2.

decode()

virtual unsigned long long Gcs_stage_metadata::decode ( const unsigned char *  buffer )

pure virtual

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

The buffer MUST be encoded in little endian format.

Parameters

buffer

The buffer to decode from.

Returns

Encoded size.

Implemented in Gcs_split_header_v2, and Gcs_empty_stage_metadata.

dump()

virtual void Gcs_stage_metadata::dump ( std::ostringstream &  output ) const

pure virtual

Create a string representation of the header to be logged.

Parameters

output

Reference to the output stream where the string will be created

Implemented in Gcs_empty_stage_metadata, and Gcs_split_header_v2.

encode()

virtual unsigned long long Gcs_stage_metadata::encode ( unsigned char *  buffer ) const

pure virtual

Encode the contents of this instance into the buffer.

The encoding SHALL be done in little endian format.

Parameters

buffer

The buffer to encode to.

Returns

Length of the encoded information.

Implemented in Gcs_empty_stage_metadata, and Gcs_split_header_v2.

operator=() [1/2]

Gcs_stage_metadata & Gcs_stage_metadata::operator= ( const Gcs_stage_metadata &  )

default

operator=() [2/2]

Gcs_stage_metadata & Gcs_stage_metadata::operator= ( Gcs_stage_metadata &&  )

default

---

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

• plugin/group_replication/libmysqlgcs/src/bindings/xcom/gcs_internal_message_headers.h
• plugin/group_replication/libmysqlgcs/src/bindings/xcom/gcs_internal_message_headers.cc