From 8d0760443693de3e6c2c181b29002b3951ce773c Mon Sep 17 00:00:00 2001 From: Esa Korhonen Date: Wed, 25 Jan 2017 15:53:57 +0200 Subject: [PATCH] Split maxscale.h to public and private parts This header defines some general functions and maxscale main() return values. Most of it is still public, but there were some functions which were moved to a core header. --- include/maxscale/maxscale.h | 37 +++++++----------- server/core/gateway.cc | 3 +- server/core/maxscale/maxscale.h | 38 +++++++++++++++++++ server/core/misc.c | 13 +------ server/modules/routing/debugcli/debugcmd.c | 3 +- server/modules/routing/maxinfo/maxinfo_exec.c | 1 + 6 files changed, 58 insertions(+), 37 deletions(-) create mode 100644 server/core/maxscale/maxscale.h diff --git a/include/maxscale/maxscale.h b/include/maxscale/maxscale.h index e6b1a0abf..6aca11d03 100644 --- a/include/maxscale/maxscale.h +++ b/include/maxscale/maxscale.h @@ -13,45 +13,34 @@ */ /** - * @file maxscale.h - * - * Some general definitions for MaxScale - * - * @verbatim - * Revision History - * - * Date Who Description - * 05/02/14 Mark Riddoch Initial implementation - * - * @endverbatim - */ + * @file include/maxscale/maxscale.h Some general definitions for MaxScale +*/ #include + #include MXS_BEGIN_DECLS /* Exit status for MaxScale */ -#define MAXSCALE_SHUTDOWN 0 /* Good shutdown */ -#define MAXSCALE_BADCONFIG 1 /* Configuration fiel error */ +#define MAXSCALE_SHUTDOWN 0 /* Normal shutdown */ +#define MAXSCALE_BADCONFIG 1 /* Configuration file error */ #define MAXSCALE_NOLIBRARY 2 /* No embedded library found */ -#define MAXSCALE_NOSERVICES 3 /* No servics are running */ -#define MAXSCALE_ALREADYRUNNING 4 /* MaxScale is already runing */ +#define MAXSCALE_NOSERVICES 3 /* No services could be started */ +#define MAXSCALE_ALREADYRUNNING 4 /* MaxScale is already running */ #define MAXSCALE_BADARG 5 /* Bad command line argument */ #define MAXSCALE_INTERNALERROR 6 /* Internal error, see error log */ -void maxscale_reset_starttime(void); +/** + * Return the time when MaxScale was started. + */ time_t maxscale_started(void); -int maxscale_uptime(void); /** - * Initiate shutdown of MaxScale. + * Return the time MaxScale has been running. * - * This functions informs all threads that they should stop the - * processing and exit. - * - * @return How many times maxscale_shutdown() has been called. + * @return The uptime in seconds. */ -int maxscale_shutdown(void); +int maxscale_uptime(void); MXS_END_DECLS diff --git a/server/core/gateway.cc b/server/core/gateway.cc index 4ebf277fe..8e943d6fe 100644 --- a/server/core/gateway.cc +++ b/server/core/gateway.cc @@ -70,11 +70,12 @@ #include #include "maxscale/config.h" +#include "maxscale/maxscale.h" #include "maxscale/modules.h" #include "maxscale/monitor.h" +#include "maxscale/poll.h" #include "maxscale/service.h" #include "maxscale/statistics.h" -#include "maxscale/poll.h" #define STRING_BUFFER_SIZE 1024 #define PIDFD_CLOSED -1 diff --git a/server/core/maxscale/maxscale.h b/server/core/maxscale/maxscale.h new file mode 100644 index 000000000..c38e4062d --- /dev/null +++ b/server/core/maxscale/maxscale.h @@ -0,0 +1,38 @@ +#pragma once +/* + * Copyright (c) 2016 MariaDB Corporation Ab + * + * Use of this software is governed by the Business Source License included + * in the LICENSE.TXT file and at www.mariadb.com/bsl. + * + * Change Date: 2019-07-01 + * + * On the date above, in accordance with the Business Source License, use + * of this software will be governed by version 2 or later of the General + * Public License. + */ + +/** + * @file core/maxscale/maxscale.h - The private maxscale general definitions + */ + +#include + +MXS_BEGIN_DECLS + +/** + * Initiate shutdown of MaxScale. + * + * This functions informs all threads that they should stop the + * processing and exit. + * + * @return How many times maxscale_shutdown() has been called. + */ +int maxscale_shutdown(void); + +/** + * Reset the start time from which the uptime is calculated. + */ +void maxscale_reset_starttime(void); + +MXS_END_DECLS diff --git a/server/core/misc.c b/server/core/misc.c index 4f1e31774..a7f75680c 100644 --- a/server/core/misc.c +++ b/server/core/misc.c @@ -12,31 +12,22 @@ */ #include + #include +#include "maxscale/maxscale.h" static time_t started; -/** - * Reset the start time from which the uptime is calculated. - */ void maxscale_reset_starttime(void) { started = time(0); } -/** - * Return the time when MaxScale was started. - */ time_t maxscale_started(void) { return started; } -/** - * Return the time MaxScale has been running. - * - * @return The uptime in seconds. - */ int maxscale_uptime() { return time(0) - started; diff --git a/server/modules/routing/debugcli/debugcmd.c b/server/modules/routing/debugcli/debugcmd.c index e615cbccb..7cac25c4a 100644 --- a/server/modules/routing/debugcli/debugcmd.c +++ b/server/modules/routing/debugcli/debugcmd.c @@ -75,10 +75,11 @@ #include #include "../../../core/maxscale/config_runtime.h" +#include "../../../core/maxscale/maxscale.h" #include "../../../core/maxscale/modules.h" #include "../../../core/maxscale/monitor.h" -#include "../../../core/maxscale/session.h" #include "../../../core/maxscale/poll.h" +#include "../../../core/maxscale/session.h" #define MAXARGS 12 diff --git a/server/modules/routing/maxinfo/maxinfo_exec.c b/server/modules/routing/maxinfo/maxinfo_exec.c index c284b963d..45edf3e6d 100644 --- a/server/modules/routing/maxinfo/maxinfo_exec.c +++ b/server/modules/routing/maxinfo/maxinfo_exec.c @@ -44,6 +44,7 @@ #include #include +#include "../../../core/maxscale/maxscale.h" #include "../../../core/maxscale/modules.h" #include "../../../core/maxscale/monitor.h" #include "../../../core/maxscale/poll.h"