MySQL 9.1.0
Source Code Documentation
Gcs_message_stage_lz4_v2 Class Reference

#include <gcs_message_stage_lz4.h>

Inheritance diagram for Gcs_message_stage_lz4_v2:
[legend]

Public Member Functions

 Gcs_message_stage_lz4_v2 ()
 Creates an instance of the stage with the default threshold in bytes. More...
 
 Gcs_message_stage_lz4_v2 (bool enabled, unsigned long long compress_threshold)
 Creates an instance of the stage with the given threshold in bytes. More...
 
 ~Gcs_message_stage_lz4_v2 () override=default
 
Stage_code get_stage_code () const override
 Return the unique stage code. More...
 
- Public Member Functions inherited from Gcs_message_stage_lz4
Gcs_message_stage::stage_status skip_apply (uint64_t const &original_payload_size) const override
 Check if the apply operation which affects outgoing packets should be executed (i.e. More...
 
std::unique_ptr< Gcs_stage_metadataget_stage_header () override
 
 Gcs_message_stage_lz4 ()
 Creates an instance of the stage with the default threshold in bytes set. More...
 
 Gcs_message_stage_lz4 (bool enabled, unsigned long long compress_threshold)
 Creates an instance of the stage with the given threshold in bytes. More...
 
 ~Gcs_message_stage_lz4 () override=default
 
void set_threshold (unsigned long long threshold)
 Sets the threshold in bytes after which compression kicks in. More...
 
- Public Member Functions inherited from Gcs_message_stage
 Gcs_message_stage ()
 
 Gcs_message_stage (bool enabled)
 
virtual ~Gcs_message_stage ()=default
 
std::pair< bool, std::vector< Gcs_packet > > apply (Gcs_packet &&packet)
 Apply some transformation to the outgoing packet, and return a set of one, or more, transformed packets. More...
 
std::pair< Gcs_pipeline_incoming_result, Gcs_packetrevert (Gcs_packet &&packet)
 Revert some transformation from the incoming packet, and return one, or none, transformed packet. More...
 
bool is_enabled () const
 Return whether the message stage is enabled or not. More...
 
virtual bool update_members_information (const Gcs_member_identifier &, const Gcs_xcom_nodes &)
 Update the list of members in the group as this may be required by some stages in the communication pipeline. More...
 
virtual Gcs_xcom_synode_set get_snapshot () const
 
void set_enabled (bool is_enabled)
 Enable or disable the message stage. More...
 

Additional Inherited Members

- Public Types inherited from Gcs_message_stage
enum class  stage_status : unsigned int { apply , skip , abort }
 
- Static Public Member Functions inherited from Gcs_message_stage_lz4
static constexpr unsigned long long max_input_compression () noexcept
 Return the maximum payload size in bytes that can be compressed. More...
 
- Static Public Attributes inherited from Gcs_message_stage_lz4
static constexpr unsigned long long DEFAULT_THRESHOLD = 1024
 The default threshold value in bytes. More...
 
- Protected Member Functions inherited from Gcs_message_stage_lz4
std::pair< bool, std::vector< Gcs_packet > > apply_transformation (Gcs_packet &&packet) override
 Implements the logic of this stage's transformation to the packet, and returns a set of one, or more, transformed packets. More...
 
std::pair< Gcs_pipeline_incoming_result, Gcs_packetrevert_transformation (Gcs_packet &&packet) override
 Implements the logic to revert this stage's transformation to the packet, and returns one, or none, transformed packet. More...
 
Gcs_message_stage::stage_status skip_revert (const Gcs_packet &packet) const override
 Check if the revert operation which affects incoming packets should be executed (i.e. More...
 
- Protected Member Functions inherited from Gcs_message_stage
void encode (unsigned char *header, unsigned short header_length, unsigned long long old_payload_length)
 Encode the fixed part of the associated dynamic header information into the header buffer. More...
 
void decode (const unsigned char *header, unsigned short *header_length, unsigned long long *old_payload_length)
 Decode the fixed part of the associated dynamic header information from the header buffer. More...
 

Constructor & Destructor Documentation

◆ Gcs_message_stage_lz4_v2() [1/2]

Gcs_message_stage_lz4_v2::Gcs_message_stage_lz4_v2 ( )
inlineexplicit

Creates an instance of the stage with the default threshold in bytes.

◆ Gcs_message_stage_lz4_v2() [2/2]

Gcs_message_stage_lz4_v2::Gcs_message_stage_lz4_v2 ( bool  enabled,
unsigned long long  compress_threshold 
)
inlineexplicit

Creates an instance of the stage with the given threshold in bytes.

Parameters
enabledenables this message stage
compress_thresholdmessages with the payload larger than compress_threshold in bytes are compressed.

◆ ~Gcs_message_stage_lz4_v2()

Gcs_message_stage_lz4_v2::~Gcs_message_stage_lz4_v2 ( )
overridedefault

Member Function Documentation

◆ get_stage_code()

Stage_code Gcs_message_stage_lz4_v2::get_stage_code ( ) const
inlineoverridevirtual

Return the unique stage code.

Returns
the stage code.

Reimplemented from Gcs_message_stage_lz4.


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