MySQL  8.0.20
Source Code Documentation
get_synode_app_data.h
Go to the documentation of this file.
1 /* Copyright (c) 2018, 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 GET_SYNODE_APP_DATA_H
24 #define GET_SYNODE_APP_DATA_H
25 
26 #include "plugin/group_replication/libmysqlgcs/xdr_gen/xcom_vp.h" // synode_no_array, synode_app_data_array
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 /*
33  Error code for the xcom_get_synode_app_data command.
34  */
35 typedef enum {
42 
43 /**
44  Retrieves the application payloads decided on the given synodes.
45 
46  @param[in] synodes The desired synodes
47  @param[out] reply The application payloads of the requested synodes
48  @retval XCOM_GET_SYNODE_APP_DATA_OK If successful, and @c reply was written to
49  @retval XCOM_GET_SYNODE_APP_DATA_NOT_CACHED If we do not have some requested
50  synode's application payload
51  @retval XCOM_GET_SYNODE_APP_DATA_NOT_DECIDED If we haven't yet reached
52  consensus on some requested synode
53  @retval XCOM_GET_SYNODE_APP_DATA_NO_MEMORY If there was an error allocating
54  memory
55  @retval XCOM_GET_SYNODE_APP_DATA_ERROR If there was some unspecified error
56  */
57 xcom_get_synode_app_data_result xcom_get_synode_app_data(
58  synode_no_array const *const synodes, synode_app_data_array *const reply);
59 
60 #ifdef __cplusplus
61 }
62 #endif
63 
64 #endif /* GET_SYNODE_APP_DATA_H */
Definition: get_synode_app_data.h:39
xcom_get_synode_app_data_result
Definition: get_synode_app_data.h:35
Definition: get_synode_app_data.h:40
Definition: get_synode_app_data.h:37
Definition: get_synode_app_data.h:38
xcom_get_synode_app_data_result xcom_get_synode_app_data(synode_no_array const *const synodes, synode_app_data_array *const reply)
Retrieves the application payloads decided on the given synodes.
Definition: get_synode_app_data.c:43
Definition: get_synode_app_data.h:36