#include <MariaDBConnection.h>

Inheritance diagram for database::mariadb::MariaDBConnection:

Collaboration diagram for database::mariadb::MariaDBConnection:

Public Member Functions
	MariaDBConnection (MariaDBClient *mariaDBClient, const MariaDBConnectionDetails &connectionDetails, const std::function< void(const MariaDBState &)> &onStateChanged)
	MariaDBConnection (const MariaDBConnection &)=delete
	~MariaDBConnection () override
MariaDBConnection &	operator= (const MariaDBConnection &)=delete
MariaDBCommandSequence &	execute_async (MariaDBCommandSequence &&commandSequence)
void	execute_sync (MariaDBCommand *mariaDBCommand)
void	commandStart (const utils::Timeval &currentTime)
void	commandContinue (int status)
void	commandCompleted ()
void	unmanaged ()

Protected Member Functions
void	checkStatus (int status)
void	readEvent () override
void	writeEvent () override
void	outOfBandEvent () override
void	readTimeout () override
void	writeTimeout () override
void	outOfBandTimeout () override
void	unobservedEvent () override

Private Attributes
MariaDBClient *	mariaDBClient = nullptr
MYSQL *	mysql = nullptr
const std::string	connectionName
std::deque< MariaDBCommandSequence >	commandSequenceQueue
MariaDBCommand *	currentCommand = nullptr
bool	connected = false
bool	closing = false
MariaDBCommandStartEvent	commandStartEvent
std::function< void(const MariaDBState &)>	onStateChanged

Additional Inherited Members
Private Member Functions inherited from core::eventreceiver::ReadEventReceiver
	ReadEventReceiver (const std::string &name, const utils::Timeval &timeout)
Private Member Functions inherited from core::DescriptorEventReceiver
	DescriptorEventReceiver (const std::string &name, DescriptorEventPublisher &descriptorEventPublisher, const utils::Timeval &timeout=TIMEOUT::DISABLE)
int	getRegisteredFd () const
bool	isEnabled () const
bool	isSuspended () const
void	setTimeout (const utils::Timeval &timeout)
utils::Timeval	getTimeout (const utils::Timeval &currentTime) const
void	checkTimeout (const utils::Timeval &currentTime)
bool	enable (int fd)
void	disable ()
void	suspend ()
void	resume ()
Private Member Functions inherited from core::EventReceiver
	EventReceiver (const std::string &name)
	EventReceiver (EventReceiver &)=delete
	EventReceiver (EventReceiver &&)=delete
EventReceiver &	operator= (EventReceiver &)=delete
EventReceiver &	operator= (EventReceiver &&)=delete
virtual void	destruct ()
void	span ()
void	relax ()
const std::string &	getName () const
virtual	~EventReceiver ()=default
Private Member Functions inherited from core::eventreceiver::WriteEventReceiver
	WriteEventReceiver (const std::string &name, const utils::Timeval &timeout)
Private Member Functions inherited from core::eventreceiver::ExceptionalConditionEventReceiver
	ExceptionalConditionEventReceiver (const std::string &name, const utils::Timeval &timeout=60)
Static Private Member Functions inherited from core::EventReceiver
static void	atNextTick (const std::function< void(void)> &callBack)

Detailed Description

Definition at line 88 of file MariaDBConnection.h.

Constructor & Destructor Documentation

◆ MariaDBConnection() [1/2]

database::mariadb::MariaDBConnection::MariaDBConnection	(	MariaDBClient *	mariaDBClient,
		const MariaDBConnectionDetails &	connectionDetails,
		const std::function< void(const MariaDBState &)> &	onStateChanged )

explicit

Definition at line 63 of file MariaDBConnection.cpp.

        : ReadEventReceiver("MariaDBConnectionRead", core::DescriptorEventReceiver::TIMEOUT::DISABLE)
        , WriteEventReceiver("MariaDBConnectionWrite", core::DescriptorEventReceiver::TIMEOUT::DISABLE)
        , ExceptionalConditionEventReceiver("MariaDBConnectionExceptional", core::DescriptorEventReceiver::TIMEOUT::DISABLE)
        , mariaDBClient(mariaDBClient)
        , connectionName(connectionDetails.connectionName)
        , commandStartEvent("MariaDBCommandStartEvent", this)
        , onStateChanged(onStateChanged) {
        MariaDBLibrary::ensureInitialized();
 
        mysql = mysql_init(nullptr);
        mysql_options(mysql, MYSQL_OPT_NONBLOCK, nullptr);
 
        execute_async(std::move(MariaDBCommandSequence().execute_async(new database::mariadb::commands::async::MariaDBConnectCommand(
            connectionDetails,
            [this]() {
                if (mysql_errno(mysql) == 0) {
                    const int fd = mysql_get_socket(mysql);
 
                    if (ReadEventReceiver::enable(fd) && WriteEventReceiver::enable(fd) && ExceptionalConditionEventReceiver::enable(fd)) {
                        ReadEventReceiver::suspend();
                        WriteEventReceiver::suspend();
                        ExceptionalConditionEventReceiver::suspend();
 
                        connected = true;
                    } else {
                        if (ReadEventReceiver::isEnabled()) {
                            ReadEventReceiver::disable();
                        }
                        if (WriteEventReceiver::isEnabled()) {
                            WriteEventReceiver::disable();
                        }
                        if (ExceptionalConditionEventReceiver::isEnabled()) {
                            ExceptionalConditionEventReceiver::disable();
                        }
 
                        LOG(ERROR) << this->connectionName << " MariaDB: Descriptor not registered in SNode.C eventloop";
                    }
                }
            },
            [this]() {
                LOG(DEBUG) << this->connectionName << " MariaDB connect: success";
 
                this->onStateChanged({.connected = true});
            },
            [this](const std::string& errorString, unsigned int errorNumber) {
                LOG(WARNING) << this->connectionName << " MariaDB connect: error: " << errorString << " : " << errorNumber;
 
                this->onStateChanged({.error = errorNumber, .errorMessage = errorString});
            }))));
    }

References commandStartEvent, connectionName, database::mariadb::MariaDBConnectionDetails::connectionName, core::DescriptorEventReceiver::TIMEOUT::DISABLE, database::mariadb::MariaDBLibrary::ensureInitialized(), database::mariadb::MariaDBCommandSequence::execute_async(), execute_async(), mariaDBClient, database::mariadb::MariaDBCommandSequence::MariaDBCommandSequence(), and MariaDBConnection().

Referenced by MariaDBConnection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MariaDBConnection() [2/2]

database::mariadb::MariaDBConnection::MariaDBConnection ( const MariaDBConnection & )

delete

◆ ~MariaDBConnection()

database::mariadb::MariaDBConnection::~MariaDBConnection ( )

override

Definition at line 117 of file MariaDBConnection.cpp.

                                          {
        for (MariaDBCommandSequence& mariaDBCommandSequence : commandSequenceQueue) {
            for (MariaDBCommand* mariaDBCommand : mariaDBCommandSequence.sequence()) {
                if (core::SNodeC::state() == core::State::RUNNING && connected) {
                    mariaDBCommand->commandError(mysql_error(mysql), mysql_errno(mysql));
                }
 
                delete mariaDBCommand;
            }
        }
 
        if (mariaDBClient != nullptr) {
            mariaDBClient->connectionVanished();
        }
 
        if (mysql != nullptr) {
            mysql_close(mysql);
            mysql = nullptr;
        }
    }

References database::mariadb::MariaDBClient::connectionVanished(), and mariaDBClient.

Here is the call graph for this function:

Member Function Documentation

◆ checkStatus()

void database::mariadb::MariaDBConnection::checkStatus ( int status )

protected

Definition at line 221 of file MariaDBConnection.cpp.

                                                  {
        if (connected) {
            if ((status & MYSQL_WAIT_READ) != 0) {
                if (ReadEventReceiver::isSuspended() && ReadEventReceiver::isEnabled()) {
                    ReadEventReceiver::resume();
                }
            } else if (!ReadEventReceiver::isSuspended()) {
                ReadEventReceiver::suspend();
            }
 
            if ((status & MYSQL_WAIT_WRITE) != 0) {
                if (WriteEventReceiver::isSuspended() && WriteEventReceiver::isEnabled()) {
                    WriteEventReceiver::resume();
                }
            } else if (!WriteEventReceiver::isSuspended()) {
                WriteEventReceiver::suspend();
            }
 
            if ((status & MYSQL_WAIT_EXCEPT) != 0) {
                if (ExceptionalConditionEventReceiver::isSuspended() && ExceptionalConditionEventReceiver::isEnabled()) {
                    ExceptionalConditionEventReceiver::resume();
                }
            } else if (!ExceptionalConditionEventReceiver::isSuspended()) {
                ExceptionalConditionEventReceiver::suspend();
            }
 
            if ((status & MYSQL_WAIT_TIMEOUT) != 0) {
                ReadEventReceiver::setTimeout(mysql_get_timeout_value(mysql));
                //                WriteEventReceiver::setTimeout(mysql_get_timeout_value(mysql));
                //                ExceptionalConditionEventReceiver::setTimeout(mysql_get_timeout_value(mysql));
            } else {
                ReadEventReceiver::setTimeout(core::DescriptorEventReceiver::TIMEOUT::DEFAULT);
                //                WriteEventReceiver::setTimeout(core::DescriptorEventReceiver::TIMEOUT::DEFAULT);
                //                ExceptionalConditionEventReceiver::setTimeout(core::DescriptorEventReceiver::TIMEOUT::DEFAULT);
            }
 
            if (status == 0) {
                if (mysql_errno(mysql) == 0) {
                    if (currentCommand->commandCompleted()) {
                        commandCompleted();
                    }
                } else {
                    currentCommand->commandError(mysql_error(mysql), mysql_errno(mysql));
                    commandCompleted();
                }
                commandStartEvent.span();
            }
        } else {
            currentCommand->commandError(mysql_error(mysql), mysql_errno(mysql));
            commandCompleted();
 
            delete this;
        }
    }

References database::mariadb::MariaDBCommand::commandCompleted(), commandCompleted(), database::mariadb::MariaDBCommand::commandError(), commandStartEvent, connected, currentCommand, core::DescriptorEventReceiver::TIMEOUT::DEFAULT, core::DescriptorEventReceiver::isEnabled(), core::DescriptorEventReceiver::isSuspended(), core::DescriptorEventReceiver::resume(), core::DescriptorEventReceiver::setTimeout(), core::EventReceiver::span(), and core::DescriptorEventReceiver::suspend().

Referenced by commandContinue(), and commandStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ commandCompleted()

void database::mariadb::MariaDBConnection::commandCompleted ( )

Definition at line 190 of file MariaDBConnection.cpp.

                                             {
        LOG(DEBUG) << connectionName << " MariaDB completed: " << currentCommand->commandInfo();
        commandSequenceQueue.front().commandCompleted();
 
        const bool sequenceEmpty = commandSequenceQueue.front().empty();
 
        delete currentCommand;
        currentCommand = nullptr;
 
        if (sequenceEmpty) {
            commandSequenceQueue.pop_front();
        }
    }

References database::mariadb::MariaDBCommand::commandInfo(), connectionName, and currentCommand.

Referenced by checkStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ commandContinue()

void database::mariadb::MariaDBConnection::commandContinue ( int status )

Definition at line 180 of file MariaDBConnection.cpp.

                                                      {
        if (currentCommand != nullptr) {
            checkStatus(currentCommand->commandContinue(status));
        } else if ((status & MYSQL_WAIT_READ) != 0 && commandSequenceQueue.empty()) {
            ReadEventReceiver::disable();
            WriteEventReceiver::disable();
            ExceptionalConditionEventReceiver::disable();
        }
    }

References checkStatus(), database::mariadb::MariaDBCommand::commandContinue(), currentCommand, and core::DescriptorEventReceiver::disable().

Referenced by outOfBandEvent(), outOfBandTimeout(), readEvent(), readTimeout(), writeEvent(), and writeTimeout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ commandStart()

void database::mariadb::MariaDBConnection::commandStart ( const utils::Timeval & currentTime )

Definition at line 161 of file MariaDBConnection.cpp.

                                                                        {
        if (!commandSequenceQueue.empty()) {
            currentCommand = commandSequenceQueue.front().nextCommand();
 
            LOG(DEBUG) << connectionName << " MariaDB start: " << currentCommand->commandInfo();
 
            currentCommand->setMariaDBConnection(this);
            checkStatus(currentCommand->commandStart(mysql, currentTime));
        } else if (mariaDBClient != nullptr) {
            if (ReadEventReceiver::isSuspended() && ReadEventReceiver::isEnabled()) {
                ReadEventReceiver::resume();
            }
        } else {
            ReadEventReceiver::disable();
            WriteEventReceiver::disable();
            ExceptionalConditionEventReceiver::disable();
        }
    }

References checkStatus(), database::mariadb::MariaDBCommand::commandInfo(), database::mariadb::MariaDBCommand::commandStart(), connectionName, currentCommand, core::DescriptorEventReceiver::disable(), core::DescriptorEventReceiver::isEnabled(), core::DescriptorEventReceiver::isSuspended(), mariaDBClient, core::DescriptorEventReceiver::resume(), and database::mariadb::MariaDBCommand::setMariaDBConnection().

Referenced by database::mariadb::MariaDBCommandStartEvent::onEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute_async()

MariaDBCommandSequence & database::mariadb::MariaDBConnection::execute_async ( MariaDBCommandSequence && commandSequence )

Definition at line 138 of file MariaDBConnection.cpp.

                                                                                                     {
        if (currentCommand == nullptr && commandSequenceQueue.empty()) {
            commandStartEvent.span();
        }
 
        commandSequenceQueue.emplace_back(std::move(commandSequence));
 
        return commandSequenceQueue.back();
    }

References commandStartEvent, and core::EventReceiver::span().

Referenced by database::mariadb::MariaDBClient::execute_async(), and MariaDBConnection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute_sync()

void database::mariadb::MariaDBConnection::execute_sync ( MariaDBCommand * mariaDBCommand )

Definition at line 148 of file MariaDBConnection.cpp.

                                                                       {
        mariaDBCommand->commandStart(mysql, utils::Timeval::currentTime());
 
        if (mysql_errno(mysql) == 0) {
            if (mariaDBCommand->commandCompleted()) {
            }
        } else {
            mariaDBCommand->commandError(mysql_error(mysql), mysql_errno(mysql));
        }
 
        delete mariaDBCommand;
    }

References database::mariadb::MariaDBCommand::commandCompleted(), database::mariadb::MariaDBCommand::commandError(), database::mariadb::MariaDBCommand::commandStart(), and utils::Timeval::currentTime().

Referenced by database::mariadb::MariaDBClient::execute_sync().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

MariaDBConnection & database::mariadb::MariaDBConnection::operator= ( const MariaDBConnection & )

delete

◆ outOfBandEvent()

void database::mariadb::MariaDBConnection::outOfBandEvent ( )

overrideprotectedvirtual

Implements core::eventreceiver::ExceptionalConditionEventReceiver.

Definition at line 284 of file MariaDBConnection.cpp.

                                           {
        commandContinue(MYSQL_WAIT_EXCEPT);
    }

References commandContinue().

Here is the call graph for this function:

◆ outOfBandTimeout()

void database::mariadb::MariaDBConnection::outOfBandTimeout ( )

overrideprotectedvirtual

Reimplemented from core::eventreceiver::ExceptionalConditionEventReceiver.

Definition at line 296 of file MariaDBConnection.cpp.

                                             {
        commandContinue(MYSQL_WAIT_TIMEOUT);
    }

References commandContinue().

Here is the call graph for this function:

◆ readEvent()

void database::mariadb::MariaDBConnection::readEvent ( )

overrideprotectedvirtual

Implements core::eventreceiver::ReadEventReceiver.

Definition at line 276 of file MariaDBConnection.cpp.

                                      {
        commandContinue(MYSQL_WAIT_READ);
    }

References commandContinue().

Here is the call graph for this function:

◆ readTimeout()

void database::mariadb::MariaDBConnection::readTimeout ( )

overrideprotectedvirtual

Reimplemented from core::eventreceiver::ReadEventReceiver.

Definition at line 288 of file MariaDBConnection.cpp.

                                        {
        commandContinue(MYSQL_WAIT_TIMEOUT);
    }

References commandContinue().

Here is the call graph for this function:

◆ unmanaged()

void database::mariadb::MariaDBConnection::unmanaged ( )

Definition at line 204 of file MariaDBConnection.cpp.

                                      {
        mariaDBClient = nullptr;
        closing = true;
 
        if (currentCommand == nullptr && commandSequenceQueue.empty()) {
            if (ReadEventReceiver::isEnabled()) {
                ReadEventReceiver::disable();
            }
            if (WriteEventReceiver::isEnabled()) {
                WriteEventReceiver::disable();
            }
            if (ExceptionalConditionEventReceiver::isEnabled()) {
                ExceptionalConditionEventReceiver::disable();
            }
        }
    }

References closing, core::DescriptorEventReceiver::disable(), core::DescriptorEventReceiver::isEnabled(), and mariaDBClient.

Referenced by database::mariadb::MariaDBClient::~MariaDBClient().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unobservedEvent()

void database::mariadb::MariaDBConnection::unobservedEvent ( )

overrideprotectedvirtual

Implements core::Observer.

Definition at line 300 of file MariaDBConnection.cpp.

                                            {
        if (!closing) {
            LOG(ERROR) << connectionName << " MariaDB: Lost connection";
        }
 
        if (mariaDBClient != nullptr) {
            onStateChanged({});
        }
 
        delete this;
    }

References closing, connectionName, and mariaDBClient.

◆ writeEvent()

void database::mariadb::MariaDBConnection::writeEvent ( )

overrideprotectedvirtual

Implements core::eventreceiver::WriteEventReceiver.

Definition at line 280 of file MariaDBConnection.cpp.

                                       {
        commandContinue(MYSQL_WAIT_WRITE);
    }

References commandContinue().

Here is the call graph for this function:

◆ writeTimeout()

void database::mariadb::MariaDBConnection::writeTimeout ( )

overrideprotectedvirtual

Reimplemented from core::eventreceiver::WriteEventReceiver.

Definition at line 292 of file MariaDBConnection.cpp.

                                         {
        commandContinue(MYSQL_WAIT_TIMEOUT);
    }

References commandContinue().

Here is the call graph for this function:

Member Data Documentation

◆ closing

bool database::mariadb::MariaDBConnection::closing = false

private

Definition at line 133 of file MariaDBConnection.h.

Referenced by unmanaged(), and unobservedEvent().

◆ commandSequenceQueue

std::deque<MariaDBCommandSequence> database::mariadb::MariaDBConnection::commandSequenceQueue

private

Definition at line 129 of file MariaDBConnection.h.

◆ commandStartEvent

MariaDBCommandStartEvent database::mariadb::MariaDBConnection::commandStartEvent

private

Definition at line 135 of file MariaDBConnection.h.

Referenced by checkStatus(), execute_async(), and MariaDBConnection().

◆ connected

bool database::mariadb::MariaDBConnection::connected = false

private

Definition at line 132 of file MariaDBConnection.h.

Referenced by checkStatus().

◆ connectionName

const std::string database::mariadb::MariaDBConnection::connectionName

private

Definition at line 127 of file MariaDBConnection.h.

Referenced by commandCompleted(), commandStart(), MariaDBConnection(), and unobservedEvent().

◆ currentCommand

MariaDBCommand* database::mariadb::MariaDBConnection::currentCommand = nullptr

private

Definition at line 131 of file MariaDBConnection.h.

Referenced by checkStatus(), commandCompleted(), commandContinue(), and commandStart().

◆ mariaDBClient

MariaDBClient* database::mariadb::MariaDBConnection::mariaDBClient = nullptr

private

Definition at line 125 of file MariaDBConnection.h.

Referenced by commandStart(), MariaDBConnection(), unmanaged(), unobservedEvent(), and ~MariaDBConnection().

◆ mysql

MYSQL* database::mariadb::MariaDBConnection::mysql = nullptr

private

Definition at line 126 of file MariaDBConnection.h.

◆ onStateChanged

std::function<void(const MariaDBState&)> database::mariadb::MariaDBConnection::onStateChanged

private

Definition at line 137 of file MariaDBConnection.h.

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

database/mariadb/MariaDBConnection.h
database/mariadb/MariaDBConnection.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MariaDBConnection() [1/2]

◆ MariaDBConnection() [2/2]

◆ ~MariaDBConnection()

Member Function Documentation

◆ checkStatus()

◆ commandCompleted()

◆ commandContinue()

◆ commandStart()

◆ execute_async()

◆ execute_sync()

◆ operator=()

◆ outOfBandEvent()

◆ outOfBandTimeout()

◆ readEvent()

◆ readTimeout()

◆ unmanaged()

◆ unobservedEvent()

◆ writeEvent()

◆ writeTimeout()

Member Data Documentation

◆ closing

◆ commandSequenceQueue

◆ commandStartEvent

◆ connected

◆ connectionName

◆ currentCommand

◆ mariaDBClient

◆ mysql

◆ onStateChanged