MySQL  8.0.17
Source Code Documentation
mysql_backup_lock.h
Go to the documentation of this file.
1 /* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
2 
3  This program is free software; you can redistribute it and/or modify
4  it under the terms of the GNU General Public License, version 2.0,
5  as published by the Free Software Foundation.
6 
7  This program is also distributed with certain software (including
8  but not limited to OpenSSL) that is licensed under separate terms,
9  as designated in a particular file or component or in included license
10  documentation. The authors of MySQL hereby grant you an additional
11  permission to link the program and your derivative works with the
12  separately licensed software that they have included with MySQL.
13 
14  This program is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  GNU General Public License, version 2.0, for more details.
18 
19  You should have received a copy of the GNU General Public License
20  along with this program; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22 
23 #ifndef MYSQL_BACKUP_LOCK_INCLUDED
24 #define MYSQL_BACKUP_LOCK_INCLUDED
25 
28 
29 /**
30  Service API to acquire shared Backup Lock.
31 
32  @param opaque_thd Current thread context.
33  @param lock_kind Kind of lock to acquire - BACKUP_LOCK_SERVICE_DEFAULT
34  or weaker.
35  @param lock_timeout Number of seconds to wait before giving up.
36 
37  @return Operation status.
38  @retval false Success
39  @retval true Failure
40 */
41 
43  (MYSQL_THD opaque_thd,
45  unsigned long lock_timeout));
46 
47 /**
48  Service API to release Backup Lock.
49 
50  @param opaque_thd Current thread context.
51 
52  @return Operation status.
53  @retval false Success
54  @retval true Failure
55 */
56 
58 
59 #endif /* COMPONENTS_MYSQL_SERVER_MYSQL_BACKUP_LOCK_H_ */
Specifies macros to define Components.
#define DEFINE_BOOL_METHOD(name, args)
mysql_service_status_t mysql_release_backup_lock(THD *opaque_thd) noexcept
Service API to release Backup Lock.
Definition: backup_lock_service.cc:54
enum_backup_lock_service_lock_kind
Kind of Backup Lock to be acquired.
Definition: backup_lock_service.h:34
#define MYSQL_THD
Definition: backup_lock_service.h:40
mysql_service_status_t mysql_acquire_backup_lock(THD *opaque_thd, enum enum_backup_lock_service_lock_kind lock_kind, unsigned long lock_timeout) noexcept
Service API to acquire shared Backup Lock.
Definition: backup_lock_service.cc:36