MySQL 9.5.0
Source Code Documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ClusterAwareDecorator Class Reference

Cluster (GR or AR)-aware decorator for MySQL Sessions. More...

#include <cluster_aware_session.h>

Public Member Functions

 ClusterAwareDecorator (mysqlrouter::ClusterMetadata &metadata, const std::string &cluster_initial_username, const std::string &cluster_initial_password, const std::string &cluster_initial_hostname, unsigned long cluster_initial_port, const std::string &cluster_initial_socket, unsigned long connection_timeout, std::set< MySQLErrorc > failure_codes={MySQLErrorc::kSuperReadOnly, MySQLErrorc::kLostConnection})
 
template<class R >
R failover_on_failure (std::function< R()> wrapped_func)
 Cluster (GR or AR) aware failover. More...
 
virtual ~ClusterAwareDecorator ()=default
 

Protected Member Functions

void connect (mysqlrouter::MySQLSession &session, const std::string &host, const unsigned port)
 

Protected Attributes

mysqlrouter::ClusterMetadata & metadata_
 
const std::string & cluster_initial_username_
 
const std::string & cluster_initial_password_
 
const std::string & cluster_initial_hostname_
 
unsigned long cluster_initial_port_
 
const std::string & cluster_initial_socket_
 
unsigned long connection_timeout_
 
std::set< MySQLErrorc > failure_codes_
 

Detailed Description

Cluster (GR or AR)-aware decorator for MySQL Sessions.

Constructor & Destructor Documentation

◆ ClusterAwareDecorator()

ClusterAwareDecorator::ClusterAwareDecorator ( mysqlrouter::ClusterMetadata &  metadata,
const std::string &  cluster_initial_username,
const std::string &  cluster_initial_password,
const std::string &  cluster_initial_hostname,
unsigned long  cluster_initial_port,
const std::string &  cluster_initial_socket,
unsigned long  connection_timeout,
std::set< MySQLErrorc >  failure_codes = {MySQLErrorc::kSuperReadOnly, MySQLErrorc::kLostConnection} 
)
inline

◆ ~ClusterAwareDecorator()

virtual ClusterAwareDecorator::~ClusterAwareDecorator ( )
virtualdefault

Member Function Documentation

◆ connect()

void ClusterAwareDecorator::connect ( mysqlrouter::MySQLSession &  session,
const std::string &  host,
const unsigned  port 
)
protected

◆ failover_on_failure()

template<class R >
R ClusterAwareDecorator::failover_on_failure ( std::function< R()>  wrapped_func)
inline

Cluster (GR or AR) aware failover.

Parameters
wrapped_funcfunction will be called

assumes:

  • actively connected mysql_ session
  • all nodes in the group have the same user/pass combination
  • wrapped_func throws MySQLSession::Error with .code in .failure_codes

Member Data Documentation

◆ cluster_initial_hostname_

const std::string& ClusterAwareDecorator::cluster_initial_hostname_
protected

◆ cluster_initial_password_

const std::string& ClusterAwareDecorator::cluster_initial_password_
protected

◆ cluster_initial_port_

unsigned long ClusterAwareDecorator::cluster_initial_port_
protected

◆ cluster_initial_socket_

const std::string& ClusterAwareDecorator::cluster_initial_socket_
protected

◆ cluster_initial_username_

const std::string& ClusterAwareDecorator::cluster_initial_username_
protected

◆ connection_timeout_

unsigned long ClusterAwareDecorator::connection_timeout_
protected

◆ failure_codes_

std::set<MySQLErrorc> ClusterAwareDecorator::failure_codes_
protected

◆ metadata_

mysqlrouter::ClusterMetadata& ClusterAwareDecorator::metadata_
protected
The documentation for this class was generated from the following files: