Orbit Framework 2.0.0
A high-performance asynchronous C++20 HTTP server framework.
Loading...
Searching...
No Matches
orbit::database::MysqlClient Class Reference

An asynchronous MySQL client using coroutines and a network Proactor. More...

#include <MysqlClient.hpp>

Collaboration diagram for orbit::database::MysqlClient:

Classes

struct  Config
 Configuration options for the MySQL client. More...
 
struct  ConnectAwaiter
 
struct  QueryAwaiter
 

Public Member Functions

 MysqlClient (network::Proactor &proactor, const Config &config)
 Constructs a new MysqlClient.
 
 ~MysqlClient ()
 
 MysqlClient (const MysqlClient &)=delete
 
MysqlClient & operator= (const MysqlClient &)=delete
 
ConnectAwaiter connect_async ()
 Connects to the MySQL database asynchronously.
 
QueryAwaiter query_async (std::string query)
 Executes a query asynchronously.
 
void close ()
 Closes the MySQL connection.
 
network::Proactor & get_proactor ()
 Gets the associated network proactor.
 
MYSQL * get_mysql ()
 Gets the underlying MySQL connection object.
 
std::string escape (const std::string &value)
 Escapes value for use inside a single-quoted SQL literal, using the connection's character set (mysql_real_escape_string).
 

Private Member Functions

void wait_for_status (int status, std::function< void()> callback)
 

Private Attributes

network::Proactor & proactor_
 
Config config_
 
MYSQL * mysql_ {nullptr}
 
bool connected_ {false}
 

Detailed Description

An asynchronous MySQL client using coroutines and a network Proactor.

Constructor & Destructor Documentation

◆ MysqlClient() [1/2]

orbit::database::MysqlClient::MysqlClient ( network::Proactor &  proactor,
const Config &  config 
)

Constructs a new MysqlClient.

Parameters
proactorThe network Proactor to use for async events.
configThe configuration settings for the MySQL connection.

◆ ~MysqlClient()

orbit::database::MysqlClient::~MysqlClient ( )

◆ MysqlClient() [2/2]

orbit::database::MysqlClient::MysqlClient ( const MysqlClient &  )
delete

Member Function Documentation

◆ close()

void orbit::database::MysqlClient::close ( )

Closes the MySQL connection.

◆ connect_async()

ConnectAwaiter orbit::database::MysqlClient::connect_async ( )

Connects to the MySQL database asynchronously.

Returns
A ConnectAwaiter that can be co_awaited.

◆ escape()

std::string orbit::database::MysqlClient::escape ( const std::string &  value)

Escapes value for use inside a single-quoted SQL literal, using the connection's character set (mysql_real_escape_string).

◆ get_mysql()

MYSQL * orbit::database::MysqlClient::get_mysql ( )
inline

Gets the underlying MySQL connection object.

Returns
Pointer to the MYSQL object.

◆ get_proactor()

network::Proactor & orbit::database::MysqlClient::get_proactor ( )
inline

Gets the associated network proactor.

Returns
Reference to the network Proactor.

◆ operator=()

MysqlClient & orbit::database::MysqlClient::operator= ( const MysqlClient &  )
delete

◆ query_async()

QueryAwaiter orbit::database::MysqlClient::query_async ( std::string  query)

Executes a query asynchronously.

Parameters
queryThe SQL query string.
Returns
A QueryAwaiter that can be co_awaited for the result.
auto result = co_await client.query_async("SELECT * FROM users");

◆ wait_for_status()

void orbit::database::MysqlClient::wait_for_status ( int  status,
std::function< void()>  callback 
)
private

Member Data Documentation

◆ config_

Config orbit::database::MysqlClient::config_
private

◆ connected_

bool orbit::database::MysqlClient::connected_ {false}
private

◆ mysql_

MYSQL* orbit::database::MysqlClient::mysql_ {nullptr}
private

◆ proactor_

network::Proactor& orbit::database::MysqlClient::proactor_
private

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