mysql5/mysql-5.7.27/sql/rpl_transaction_ctx.h

92 lines
2.5 KiB
C++

/* Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
#ifndef RPL_TRANSACTION_CTX_H
#define RPL_TRANSACTION_CTX_H
#include "my_global.h"
#include "mysql/service_rpl_transaction_ctx.h" // Transaction_termination_ctx
/**
Server side support to provide a service to plugins to report if
a given transaction should continue or be aborted.
Its value is reset on Transaction_ctx::cleanup().
Its value is set through service service_rpl_transaction_ctx.
*/
class Rpl_transaction_ctx
{
public:
Rpl_transaction_ctx();
virtual ~Rpl_transaction_ctx() {}
/**
Set transaction context, that is, notify the server that for
external reasons the ongoing transaction should continue or be
aborted.
See @file include/mysql/service_rpl_transaction_ctx.h
@param transaction_termination_ctx Transaction termination context
@return
@retval 0 success
@retval !=0 error
*/
int set_rpl_transaction_ctx(Transaction_termination_ctx transaction_termination_ctx);
/**
Get transaction outcome decision.
When both sidno and gno are equal or greater than zero,
transaction should continue.
By default sidno and gno are 0, transaction will continue.
@return
@retval true Transaction should abort
@retval false Transaction should continue
*/
bool is_transaction_rollback();
/**
Was GTID generated externally?
@return
@retval true GTID was generated.
@retval false GTID was not generated.
*/
bool is_generated_gtid();
/**
Get transaction sidno.
@return sidno sidno value.
*/
int get_sidno();
/**
Get transaction gno.
@return gno gno value.
*/
long long int get_gno();
/**
Reset transaction context to default values.
*/
void cleanup();
private:
Transaction_termination_ctx m_transaction_ctx;
};
#endif /* RPL_TRANSACTION_CTX_H */