read_mode_handler.h

Go to the documentation of this file.

/* Copyright (c) 2015, 2024, Oracle and/or its affiliates.
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License, version 2.0,
   as published by the Free Software Foundation.
 
   This program is designed to work with certain software (including
   but not limited to OpenSSL) that is licensed under separate terms,
   as designated in a particular file or component or in included license
   documentation.  The authors of MySQL hereby grant you an additional
   permission to link the program and your derivative works with the
   separately licensed software that they have either included with
   the program or referenced in the documentation.
 
   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, version 2.0, 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 READ_MODE_HANDLER_INCLUDE
#define READ_MODE_HANDLER_INCLUDE
 
#include <string>
 
/**
  Enable the super read only mode in the server.
 
  @param reason explains why we set the mode
  @return the operation status
    @retval 0      OK
    @retval !=0    Error
*/
int enable_server_read_mode(const std::string &reason);
 
/**
  Disable the read only mode in the server.
 
  @return the operation status
    @retval 0      OK
    @retval !=0    Error
*/
int disable_server_read_mode();
 
/**
  Get read mode status from server.
 
  @param read_only_enabled          Update with value of read only mode
  @param super_read_only_enabled    Update with value of super read only mode
 
  @return the operation status
    @retval 0      OK
    @retval !=0    Error
*/
int get_read_mode_state(bool *read_only_enabled, bool *super_read_only_enabled);
 
/**
  Set read mode status from server.
 
  @param read_only_enabled          Value to set on read only mode
  @param super_read_only_enabled    Value to set on super read only mode
 
  @return the operation status
    @retval 0      OK
    @retval !=0    Error
*/
int set_read_mode_state(bool read_only_enabled, bool super_read_only_enabled);
 
#endif /* READ_MODE_HANDLER_INCLUDE */