MySQL 8.3.0
Source Code Documentation
My_xp_cond Class Referenceabstract

Abstract class used to wrap condition for various implementations. More...

#include <my_xp_cond.h>

Inheritance diagram for My_xp_cond:
[legend]

Public Member Functions

virtual int init (PSI_cond_key key)=0
 Initialize cond. More...
 
virtual int destroy ()=0
 Destroy cond. More...
 
virtual int timed_wait (mysql_mutex_t *mutex, const struct timespec *abstime)=0
 Wait for cond to be signaled during some time before unlocking mutex. More...
 
virtual int wait (mysql_mutex_t *mutex)=0
 Wait for cond to be signaled to unlock mutex. More...
 
virtual int signal ()=0
 Signal cond. More...
 
virtual int broadcast ()=0
 Broadcast cond. More...
 
virtual mysql_cond_tget_native_cond ()=0
 Get reference to native cond. More...
 
virtual ~My_xp_cond ()=default
 

Detailed Description

Abstract class used to wrap condition for various implementations.

A typical use case of cond is:

cond->init(cond_PSI_key);
cond->signal();
Definition: my_xp_cond.h:135
Abstract class used to wrap condition for various implementations.
Definition: my_xp_cond.h:46
virtual int init(PSI_cond_key key)=0
Initialize cond.
virtual int signal()=0
Signal cond.

Constructor & Destructor Documentation

◆ ~My_xp_cond()

virtual My_xp_cond::~My_xp_cond ( )
virtualdefault

Member Function Documentation

◆ broadcast()

virtual int My_xp_cond::broadcast ( )
pure virtual

Broadcast cond.

Returns
success status

Implemented in My_xp_cond_server.

◆ destroy()

virtual int My_xp_cond::destroy ( )
pure virtual

Destroy cond.

Returns
success status

Implemented in My_xp_cond_server.

◆ get_native_cond()

virtual mysql_cond_t * My_xp_cond::get_native_cond ( )
pure virtual

Get reference to native cond.

Returns
native cond

Implemented in My_xp_cond_server.

◆ init()

virtual int My_xp_cond::init ( PSI_cond_key  key)
pure virtual

Initialize cond.

Parameters
keycond instrumentation key
Returns
success status

Implemented in My_xp_cond_server.

◆ signal()

virtual int My_xp_cond::signal ( )
pure virtual

Signal cond.

Returns
success status

Implemented in My_xp_cond_server.

◆ timed_wait()

virtual int My_xp_cond::timed_wait ( mysql_mutex_t mutex,
const struct timespec *  abstime 
)
pure virtual

Wait for cond to be signaled during some time before unlocking mutex.

Parameters
mutexmutex to unlock
abstimetime to wait
Returns
success status

Implemented in My_xp_cond_server.

◆ wait()

virtual int My_xp_cond::wait ( mysql_mutex_t mutex)
pure virtual

Wait for cond to be signaled to unlock mutex.

Parameters
mutexmutex to unlock
Returns
success status

Implemented in My_xp_cond_server.


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