hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move @file comment

Browse Source 
Where it exists, the @file comment has now been moved to be
consistently right after the license blurb.
This commit is contained in:
Johan Wikman
2016-10-14 13:20:52 +03:00
parent 1a978be6b6
commit c03b8079fd
18 changed files with 162 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
include/maxscale/config.h
View File

@ -14,12 +14,6 @@
* Public License.
*/
#include <maxscale/cdefs.h>
#include <maxscale/skygw_utils.h>
#include <sys/utsname.h>
#include <stdint.h>
#include <openssl/sha.h>
#include <maxscale/spinlock.h>
/**
* @file config.h The configuration handling elements
*
@ -36,6 +30,13 @@
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <maxscale/skygw_utils.h>
#include <sys/utsname.h>
#include <stdint.h>
#include <openssl/sha.h>
#include <maxscale/spinlock.h>
MXS_BEGIN_DECLS
#define DEFAULT_NBPOLLS 3 /**< Default number of non block polls before we block */

12
include/maxscale/dbusers.h
View File

@ -14,12 +14,6 @@
* Public License.
*/
#include <maxscale/cdefs.h>
#include <maxscale/service.h>
#include <arpa/inet.h>
MXS_BEGIN_DECLS
/**
* @file dbusers.h Extarct user information form the backend database
*
@ -36,6 +30,12 @@ MXS_BEGIN_DECLS
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <maxscale/service.h>
#include <arpa/inet.h>
MXS_BEGIN_DECLS
/* Refresh rate limits for load users from database */
#define USERS_REFRESH_TIME 30 /* Allowed time interval (in seconds) after last update*/
#define USERS_REFRESH_MAX_PER_TIME 4 /* Max number of load calls within the time interval */

41
include/maxscale/dcb.h
View File

@ -13,26 +13,6 @@
* of this software will be governed by version 2 or later of the General
* Public License.
*/
#include <maxscale/cdefs.h>
#include <maxscale/spinlock.h>
#include <maxscale/buffer.h>
#include <maxscale/listmanager.h>
#include <maxscale/gw_protocol.h>
#include <maxscale/gw_authenticator.h>
#include <maxscale/gw_ssl.h>
#include <maxscale/modinfo.h>
#include <maxscale/gwbitmask.h>
#include <maxscale/skygw_utils.h>
#include <netinet/in.h>
MXS_BEGIN_DECLS
#define ERRHANDLE
struct session;
struct server;
struct service;
struct servlistener;
/**
* @file dcb.h The Descriptor Control Block
@ -67,6 +47,27 @@ struct servlistener;
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <maxscale/spinlock.h>
#include <maxscale/buffer.h>
#include <maxscale/listmanager.h>
#include <maxscale/gw_protocol.h>
#include <maxscale/gw_authenticator.h>
#include <maxscale/gw_ssl.h>
#include <maxscale/modinfo.h>
#include <maxscale/gwbitmask.h>
#include <maxscale/skygw_utils.h>
#include <netinet/in.h>
MXS_BEGIN_DECLS
#define ERRHANDLE
struct session;
struct server;
struct service;
struct servlistener;
struct dcb;
/**

2
include/maxscale/gw_authenticator.h
View File

@ -15,7 +15,7 @@
*/
/**
* @file protocol.h
* @file gw_authenticator.h
*
* The authenticator module interface definitions for MaxScale
*

12
include/maxscale/gwbitmask.h
View File

@ -14,12 +14,6 @@
* Public License.
*/
#include <maxscale/cdefs.h>
#include <maxscale/spinlock.h>
#include <maxscale/limits.h>
MXS_BEGIN_DECLS
/**
* @file gwbitmask.h An implementation of an arbitrarily long bitmask
*
@ -33,6 +27,12 @@ MXS_BEGIN_DECLS
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <maxscale/spinlock.h>
#include <maxscale/limits.h>
MXS_BEGIN_DECLS
/* This number MUST an be exact multiple of 8 */
#define MXS_BITMASK_LENGTH (MXS_MAX_THREADS + 1) /**< Number of bits in the bitmask */

16
include/maxscale/modules.h
View File

@ -14,14 +14,6 @@
* Public License.
*/
#include <maxscale/cdefs.h>
#include <maxscale/dcb.h>
#include <maxscale/modinfo.h>
#include <maxscale/resultset.h>
#include <maxscale/skygw_debug.h>
MXS_BEGIN_DECLS
/**
* @file modules.h Utilities for loading modules
*
@ -41,6 +33,14 @@ MXS_BEGIN_DECLS
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <maxscale/dcb.h>
#include <maxscale/modinfo.h>
#include <maxscale/resultset.h>
#include <maxscale/skygw_debug.h>
MXS_BEGIN_DECLS
typedef struct modules
{
char *module; /**< The name of the module */

24
include/maxscale/monitor.h
View File

@ -14,18 +14,6 @@
* Public License.
*/
#include <maxscale/cdefs.h>
#include <mysql.h>
#include <maxscale/server.h>
#include <maxscale/dcb.h>
#include <maxscale/log_manager.h>
#include <maxscale/resultset.h>
#include <maxscale/config.h>
#include <maxscale/externcmd.h>
#include <maxscale/secrets.h>
MXS_BEGIN_DECLS
/**
* @file monitor.h The interface to the monitor module
*
@ -48,6 +36,18 @@ MXS_BEGIN_DECLS
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <mysql.h>
#include <maxscale/server.h>
#include <maxscale/dcb.h>
#include <maxscale/log_manager.h>
#include <maxscale/resultset.h>
#include <maxscale/config.h>
#include <maxscale/externcmd.h>
#include <maxscale/secrets.h>
MXS_BEGIN_DECLS
/**
* The "Module Object" for a monitor module.
*

20
include/maxscale/pcre2.h
View File

@ -15,16 +15,6 @@
*
*/
#include <maxscale/cdefs.h>
#ifndef PCRE2_CODE_UNIT_WIDTH
#define PCRE2_CODE_UNIT_WIDTH 8
#endif
#include <pcre2.h>
MXS_BEGIN_DECLS
/**
* @file pcre2.h - Utility functions for regular expression matching
* with the bundled PCRE2 library.
@ -37,6 +27,16 @@ MXS_BEGIN_DECLS
* @endverbatim
*/
#include <maxscale/cdefs.h>
#ifndef PCRE2_CODE_UNIT_WIDTH
#define PCRE2_CODE_UNIT_WIDTH 8
#endif
#include <pcre2.h>
MXS_BEGIN_DECLS
typedef enum
{
MXS_PCRE2_MATCH,

17
include/maxscale/poll.h
View File

@ -14,14 +14,6 @@
* Public License.
*/
#include <maxscale/cdefs.h>
#include <maxscale/dcb.h>
#include <maxscale/gwbitmask.h>
#include <maxscale/resultset.h>
#include <sys/epoll.h>
MXS_BEGIN_DECLS
/**
* @file poll.h The poll related functionality
*
@ -34,6 +26,15 @@ MXS_BEGIN_DECLS
*
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <maxscale/dcb.h>
#include <maxscale/gwbitmask.h>
#include <maxscale/resultset.h>
#include <sys/epoll.h>
MXS_BEGIN_DECLS
#define MAX_EVENTS 1000
/**

5
include/maxscale/protocol/mysql.h
View File

@ -36,6 +36,7 @@
*
*/
#include <maxscale/cdefs.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
@ -65,6 +66,8 @@
#include <maxscale/gw.h>
#include <mysql.h>
MXS_BEGIN_DECLS
#define GW_MYSQL_VERSION "5.5.5-10.0.0 " MAXSCALE_VERSION "-maxscale"
#define GW_MYSQL_LOOP_TIMEOUT 300000000
#define GW_MYSQL_READ 0
@ -373,4 +376,6 @@ int mxs_mysql_send_ok(DCB *dcb, int sequence, int affected_rows, const char* mes
/** Check for OK packet */
bool mxs_mysql_is_ok_packet(GWBUF *buffer);
MXS_END_DECLS
#endif /** _MYSQL_PROTOCOL_H */

8
include/maxscale/server.h
View File

@ -14,10 +14,6 @@
* Public License.
*/
#include <maxscale/cdefs.h>
#include <maxscale/dcb.h>
#include <maxscale/resultset.h>
/**
* @file service.h
*
@ -47,6 +43,10 @@
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <maxscale/dcb.h>
#include <maxscale/resultset.h>
MXS_BEGIN_DECLS
#define MAX_SERVER_NAME_LEN 1024

33
include/maxscale/service.h
View File

@ -14,22 +14,6 @@
* Public License.
*/
#include <maxscale/cdefs.h>
#include <time.h>
#include <maxscale/gw_protocol.h>
#include <maxscale/spinlock.h>
#include <maxscale/dcb.h>
#include <maxscale/server.h>
#include <maxscale/listener.h>
#include <maxscale/filter.h>
#include <maxscale/hashtable.h>
#include <maxscale/resultset.h>
#include <maxscale/config.h>
#include <maxscale/queuemanager.h>
#include <openssl/crypto.h>
#include <openssl/ssl.h>
#include <openssl/err.h>
#include <openssl/dh.h>
/**
* @file service.h
*
@ -56,6 +40,23 @@
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <time.h>
#include <maxscale/gw_protocol.h>
#include <maxscale/spinlock.h>
#include <maxscale/dcb.h>
#include <maxscale/server.h>
#include <maxscale/listener.h>
#include <maxscale/filter.h>
#include <maxscale/hashtable.h>
#include <maxscale/resultset.h>
#include <maxscale/config.h>
#include <maxscale/queuemanager.h>
#include <openssl/crypto.h>
#include <openssl/ssl.h>
#include <openssl/err.h>
#include <openssl/dh.h>
MXS_BEGIN_DECLS
struct server;

16
include/maxscale/users.h
View File

@ -14,14 +14,6 @@
* Public License.
*/
#include <maxscale/cdefs.h>
#include <maxscale/hashtable.h>
#include <maxscale/dcb.h>
#include <maxscale/listener.h>
#include <openssl/sha.h>
MXS_BEGIN_DECLS
/**
* @file users.h The functions to manipulate the table of users maintained
* for each service
@ -38,6 +30,14 @@ MXS_BEGIN_DECLS
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <maxscale/hashtable.h>
#include <maxscale/dcb.h>
#include <maxscale/listener.h>
#include <openssl/sha.h>
MXS_BEGIN_DECLS
#define USERS_HASHTABLE_DEFAULT_SIZE 52
/**

15
server/modules/include/debugcli.h
View File

@ -15,13 +15,6 @@
* Public License.
*/
#include <maxscale/cdefs.h>
#include <maxscale/service.h>
#include <maxscale/session.h>
#include <maxscale/spinlock.h>
MXS_BEGIN_DECLS
/**
* @file debugcli.h The debug interface to the gateway
*
@ -33,6 +26,14 @@ MXS_BEGIN_DECLS
*
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <maxscale/service.h>
#include <maxscale/session.h>
#include <maxscale/spinlock.h>
MXS_BEGIN_DECLS
struct cli_session;
/**

22
server/modules/monitor/galeramon/galeramon.h
View File

@ -14,6 +14,17 @@
* Public License.
*/
/**
* @file galeramon.h - The Galera cluster monitor
*
* @verbatim
* Revision History
*
* Date Who Description
* 07/05/15 Markus Makela Initial Implementation of galeramon.h
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <stdio.h>
#include <stdlib.h>
@ -33,17 +44,6 @@
MXS_BEGIN_DECLS
/**
* @file galeramon.h - The Galera cluster monitor
*
* @verbatim
* Revision History
*
* Date Who Description
* 07/05/15 Markus Makela Initial Implementation of galeramon.h
* @endverbatim
*/
/**
* The handle for an instance of a Galera Monitor module
*/

40
server/modules/monitor/mysqlmon.h
View File

@ -14,6 +14,26 @@
* Public License.
*/
/**
* @file mysqlmon.h - The MySQL monitor
*
* @verbatim
* Revision History
*
* Date Who Description
* 08/07/13 Mark Riddoch Initial implementation
* 26/05/14 Massimiliano Pinto Default values for MONITOR_INTERVAL
* 28/05/14 Massimiliano Pinto Addition of new fields in MYSQL_MONITOR struct
* 24/06/14 Massimiliano Pinto Addition of master field in MYSQL_MONITOR struct and MONITOR_MAX_NUM_SLAVES
* 28/08/14 Massimiliano Pinto Addition of detectStaleMaster
* 30/10/14 Massimiliano Pinto Addition of disableMasterFailback
* 07/11/14 Massimiliano Pinto Addition of NetworkTimeout: connect, read, write
* 20/04/15 Guillaume Lefranc Addition of availableWhenDonor
* 22/04/15 Martin Brampton Addition of disableMasterRoleSetting
* 07/05/15 Markus Makela Addition of command execution on Master server failure
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <stdio.h>
#include <stdlib.h>
@ -34,26 +54,6 @@
MXS_BEGIN_DECLS
/**
* @file mysqlmon.h - The MySQL monitor
*
* @verbatim
* Revision History
*
* Date Who Description
* 08/07/13 Mark Riddoch Initial implementation
* 26/05/14 Massimiliano Pinto Default values for MONITOR_INTERVAL
* 28/05/14 Massimiliano Pinto Addition of new fields in MYSQL_MONITOR struct
* 24/06/14 Massimiliano Pinto Addition of master field in MYSQL_MONITOR struct and MONITOR_MAX_NUM_SLAVES
* 28/08/14 Massimiliano Pinto Addition of detectStaleMaster
* 30/10/14 Massimiliano Pinto Addition of disableMasterFailback
* 07/11/14 Massimiliano Pinto Addition of NetworkTimeout: connect, read, write
* 20/04/15 Guillaume Lefranc Addition of availableWhenDonor
* 22/04/15 Martin Brampton Addition of disableMasterRoleSetting
* 07/05/15 Markus Makela Addition of command execution on Master server failure
* @endverbatim
*/
#define MYSQLMON_DEFAULT_FAILCOUNT 5
/**

1
server/modules/routing/binlog/blr.h
View File

@ -38,6 +38,7 @@
*
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <maxscale/dcb.h>
#include <maxscale/buffer.h>

14
server/modules/routing/maxinfo/maxinfo.h
View File

@ -13,12 +13,6 @@
* of this software will be governed by version 2 or later of the General
* Public License.
*/
#include <maxscale/cdefs.h>
#include <maxscale/service.h>
#include <maxscale/session.h>
#include <maxscale/spinlock.h>
MXS_BEGIN_DECLS
/**
* @file maxinfo.h The MaxScale information schema provider
@ -31,6 +25,14 @@ MXS_BEGIN_DECLS
*
* @endverbatim
*/
#include <maxscale/cdefs.h>
#include <maxscale/service.h>
#include <maxscale/session.h>
#include <maxscale/spinlock.h>
MXS_BEGIN_DECLS
struct maxinfo_session;
/**