mirror of
https://github.com/MariaDB/server.git
synced 2026-10-23 18:49:29 +03:00
f4299f0bbf
Generated the plugin API headers using a shell script. Fixed some doxygen comment mistakes in the headers. Added a cmake conveninence target to generate the docs into $BUILD_DIR/docs Added a main page for the API docs. Included all of the existing group .md files into the CMake target Leveraged moxygen 2.1.11's fixes to produce the full API docs in a single go Removed the list of output .md files from the CMake target and switched to a stamp file to avoid unnecessary rebuilds of the docs when the list of .md files changes. Addressed various review comments.
83 lines
3.3 KiB
C
83 lines
3.3 KiB
C
#ifndef MYSQL_SERVICE_PROGRESS_REPORT_INCLUDED
|
|
/* Copyright (C) 2011 Monty Program Ab
|
|
|
|
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 Street, Fifth Floor, Boston, MA 02110-1335 USA */
|
|
|
|
/**
|
|
@file
|
|
This service allows plugins to report progress of long running operations
|
|
to the server. The progress report is visible in SHOW PROCESSLIST,
|
|
INFORMATION_SCHEMA.PROCESSLIST, and is sent to the client
|
|
if requested.
|
|
|
|
The functions are documented at
|
|
https://mariadb.com/docs/server/reference/product-development/mariadb-internals/using-mariadb-with-your-programs-api
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define thd_proc_info(thd, msg) set_thd_proc_info(thd, msg, \
|
|
__func__, __FILE__, __LINE__)
|
|
|
|
extern struct progress_report_service_st {
|
|
void (*thd_progress_init_func)(MYSQL_THD thd, unsigned int max_stage);
|
|
void (*thd_progress_report_func)(MYSQL_THD thd,
|
|
unsigned long long progress,
|
|
unsigned long long max_progress);
|
|
void (*thd_progress_next_stage_func)(MYSQL_THD thd);
|
|
void (*thd_progress_end_func)(MYSQL_THD thd);
|
|
const char *(*set_thd_proc_info_func)(MYSQL_THD, const char *info,
|
|
const char *func,
|
|
const char *file,
|
|
unsigned int line);
|
|
} *progress_report_service;
|
|
|
|
#ifdef MYSQL_DYNAMIC_PLUGIN
|
|
|
|
#define thd_progress_init(thd,max_stage) (progress_report_service->thd_progress_init_func((thd),(max_stage)))
|
|
#define thd_progress_report(thd, progress, max_progress) (progress_report_service->thd_progress_report_func((thd), (progress), (max_progress)))
|
|
#define thd_progress_next_stage(thd) (progress_report_service->thd_progress_next_stage_func(thd))
|
|
#define thd_progress_end(thd) (progress_report_service->thd_progress_end_func(thd))
|
|
#define set_thd_proc_info(thd,info,func,file,line) (progress_report_service->set_thd_proc_info_func((thd),(info),(func),(file),(line)))
|
|
|
|
#else
|
|
|
|
void thd_progress_init(MYSQL_THD thd, unsigned int max_stage);
|
|
/**
|
|
Report progress for long running operations
|
|
|
|
@param thd User thread connection handle
|
|
@param progress Where we are now
|
|
@param max_progress Progress will continue up to this
|
|
*/
|
|
void thd_progress_report(MYSQL_THD thd,
|
|
unsigned long long progress,
|
|
unsigned long long max_progress);
|
|
void thd_progress_next_stage(MYSQL_THD thd);
|
|
void thd_progress_end(MYSQL_THD thd);
|
|
const char *set_thd_proc_info(MYSQL_THD, const char * info, const char *func,
|
|
const char *file, unsigned int line);
|
|
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#define MYSQL_SERVICE_PROGRESS_REPORT_INCLUDED
|
|
#endif
|
|
|