MySQL 9.0.0
Source Code Documentation
Clone_notify Class Reference

Clone Notification handler. More...

#include <clone0api.h>

Public Types

enum class  Type {
  SPACE_CREATE , SPACE_DROP , SPACE_RENAME , SPACE_IMPORT ,
  SPACE_ALTER_ENCRYPT , SPACE_ALTER_ENCRYPT_GENERAL , SPACE_ALTER_ENCRYPT_GENERAL_FLAGS , SPACE_ALTER_INPLACE ,
  SPACE_ALTER_INPLACE_BULK , SPACE_UNDO_DDL , SYSTEM_REDO_DISABLE
}
 Notification type. More...
 

Public Member Functions

 Clone_notify (Type type, space_id_t space, bool no_wait)
 Constructor to initiate notification. More...
 
 ~Clone_notify ()
 Destructor to automatically end notification. More...
 
void get_mesg (bool begin, std::string &mesg)
 Get notification message for printing. More...
 
bool failed () const
 
int get_error () const
 
 Clone_notify (Clone_notify &)=delete
 Disable copy construction. More...
 
Clone_notifyoperator= (Clone_notify const &)=delete
 Disable assignment. More...
 

Private Types

enum class  Wait_at { NONE , ENTER , STATE_CHANGE , ABORT }
 Notification wait type set. More...
 

Private Attributes

space_id_t m_space_id
 Tablespace ID for which notification is sent. More...
 
Type m_type
 Notification type. More...
 
Wait_at m_wait
 Wait type set. More...
 
uint32_t m_blocked_state
 Blocked clone state if clone is blocked. More...
 
int m_error
 Saved error. More...
 

Detailed Description

Clone Notification handler.

Member Enumeration Documentation

◆ Type

enum class Clone_notify::Type
strong

Notification type.

Currently used by various DDL commands.

Enumerator
SPACE_CREATE 
SPACE_DROP 
SPACE_RENAME 
SPACE_IMPORT 
SPACE_ALTER_ENCRYPT 
SPACE_ALTER_ENCRYPT_GENERAL 
SPACE_ALTER_ENCRYPT_GENERAL_FLAGS 
SPACE_ALTER_INPLACE 
SPACE_ALTER_INPLACE_BULK 
SPACE_UNDO_DDL 
SYSTEM_REDO_DISABLE 

◆ Wait_at

enum class Clone_notify::Wait_at
strongprivate

Notification wait type set.

Enumerator
NONE 
ENTER 
STATE_CHANGE 
ABORT 

Constructor & Destructor Documentation

◆ Clone_notify() [1/2]

Clone_notify::Clone_notify ( Clone_notify::Type  type,
space_id_t  space,
bool  no_wait 
)

Constructor to initiate notification.

Parameters
[in]typenotification type
[in]spacetablespace ID for which notification is sent
[in]no_waitset error and return immediately if needs to wait

◆ ~Clone_notify()

Clone_notify::~Clone_notify ( )

Destructor to automatically end notification.

◆ Clone_notify() [2/2]

Clone_notify::Clone_notify ( Clone_notify )
delete

Disable copy construction.

Member Function Documentation

◆ failed()

bool Clone_notify::failed ( ) const
inline
Returns
true iff notification failed.

◆ get_error()

int Clone_notify::get_error ( ) const
inline
Returns
saved error code.

◆ get_mesg()

void Clone_notify::get_mesg ( bool  begin,
std::string &  mesg 
)

Get notification message for printing.

Parameters
[in]begintrue if notification begin otherwise end
[out]mesgnotification message

◆ operator=()

Clone_notify & Clone_notify::operator= ( Clone_notify const &  )
delete

Disable assignment.

Member Data Documentation

◆ m_blocked_state

uint32_t Clone_notify::m_blocked_state
private

Blocked clone state if clone is blocked.

◆ m_error

int Clone_notify::m_error
private

Saved error.

◆ m_space_id

space_id_t Clone_notify::m_space_id
private

Tablespace ID for which notification is sent.

◆ m_type

Type Clone_notify::m_type
private

Notification type.

◆ m_wait

Wait_at Clone_notify::m_wait
private

Wait type set.


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