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

Modified comments to be compatible with doxygen

Browse Source
This commit is contained in:
vraatikka
2013-12-13 19:32:10 +02:00
parent 97bc1ed042
commit 058d0f4492
5 changed files with 70 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -39,12 +39,12 @@ struct cli_session;
* each service that uses the CLI. * each service that uses the CLI.
*/ */
typedef struct cli_instance { typedef struct cli_instance {
SPINLOCK lock; /**< The instance spinlock */ SPINLOCK lock; /*< The instance spinlock */
SERVICE *service; /**< The debug cli service */ SERVICE *service; /*< The debug cli service */
struct cli_session struct cli_session
*sessions; /**< Linked list of sessions within this instance */ *sessions; /*< Linked list of sessions within this instance */
struct cli_instance struct cli_instance
*next; /**< The next pointer for the list of instances */ *next; /*< The next pointer for the list of instances */
} CLI_INSTANCE; } CLI_INSTANCE;
/** /**
@ -52,9 +52,9 @@ typedef struct cli_instance {
* the DEBUG CLI. * the DEBUG CLI.
*/ */
typedef struct cli_session { typedef struct cli_session {
char cmdbuf[80]; /**< The command buffer used to build up user commands */ char cmdbuf[80]; /*< The command buffer used to build up user commands */
SESSION *session; /**< The gateway session */ SESSION *session; /*< The gateway session */
struct cli_session struct cli_session
*next; /**< The next pointer for the list of sessions */ *next; /*< The next pointer for the list of sessions */
} CLI_SESSION; } CLI_SESSION;
#endif #endif

18
server/modules/include/httpd.h
View File

@ -53,13 +53,13 @@
* *
*/ */
typedef struct httpd_session { typedef struct httpd_session {
char user[HTTPD_USER_MAXLEN]; /**< username for authentication*/ char user[HTTPD_USER_MAXLEN]; /*< username for authentication*/
char *cookies; /**< all input cookies */ char *cookies; /*< all input cookies */
char hostname[HTTPD_HOSTNAME_MAXLEN]; /**< The hostname */ char hostname[HTTPD_HOSTNAME_MAXLEN]; /*< The hostname */
char useragent[HTTPD_USERAGENT_MAXLEN]; /**< The useragent */ char useragent[HTTPD_USERAGENT_MAXLEN]; /*< The useragent */
char method[HTTPD_METHOD_MAXLEN]; /**< The HTTPD Method */ char method[HTTPD_METHOD_MAXLEN]; /*< The HTTPD Method */
char *url; /**< the URL in the request */ char *url; /*< the URL in the request */
char *path_info; /**< the Pathinfo, starts with /, is the extra path segments after the document name */ char *path_info; /*< the Pathinfo, starts with /, is the extra path segments after the document name */
char *query_string; /**< the Query string, starts with ?, after path_info and document name */ char *query_string; /*< the Query string, starts with ?, after path_info and document name */
int headers_received; /**< All the headers has been received, if 1 */ int headers_received; /*< All the headers has been received, if 1 */
} HTTPD_session; } HTTPD_session;

28
server/modules/include/mysql_client_server_protocol.h
View File

@ -104,17 +104,17 @@ typedef struct {
#if defined(SS_DEBUG) #if defined(SS_DEBUG)
skygw_chk_t protocol_chk_top; skygw_chk_t protocol_chk_top;
#endif #endif
int fd; /* The socket descriptor */ int fd; /*< The socket descriptor */
struct dcb *owner_dcb; /** The DCB of the socket struct dcb *owner_dcb; /*< The DCB of the socket
* we are running on */ * we are running on */
mysql_pstate_t state; /** Current protocol state */ mysql_pstate_t state; /*< Current protocol state */
uint8_t scramble[MYSQL_SCRAMBLE_LEN]; /** server scramble, uint8_t scramble[MYSQL_SCRAMBLE_LEN]; /*< server scramble,
* created or received */ * created or received */
uint32_t server_capabilities; /** server capabilities, uint32_t server_capabilities; /*< server capabilities,
* created or received */ * created or received */
uint32_t client_capabilities; /** client capabilities, uint32_t client_capabilities; /*< client capabilities,
* created or received */ * created or received */
unsigned long tid; /** MySQL Thread ID, in unsigned long tid; /*< MySQL Thread ID, in
* handshake */ * handshake */
#if defined(SS_DEBUG) #if defined(SS_DEBUG)
skygw_chk_t protocol_chk_tail; skygw_chk_t protocol_chk_tail;
@ -126,14 +126,14 @@ typedef struct {
* *
*/ */
typedef struct mysql_session { typedef struct mysql_session {
uint8_t client_sha1[MYSQL_SCRAMBLE_LEN]; /* SHA1(passowrd) */ uint8_t client_sha1[MYSQL_SCRAMBLE_LEN]; /*< SHA1(passowrd) */
char user[MYSQL_USER_MAXLEN+1]; /* username */ char user[MYSQL_USER_MAXLEN+1]; /*< username */
char db[MYSQL_DATABASE_MAXLEN+1]; /* database */ char db[MYSQL_DATABASE_MAXLEN+1]; /*< database */
} MYSQL_session; } MYSQL_session;
/* Protocol packing macros. */ /** Protocol packing macros. */
#define gw_mysql_set_byte2(__buffer, __int) do { \ #define gw_mysql_set_byte2(__buffer, __int) do { \
(__buffer)[0]= (uint8_t)((__int) & 0xFF); \ (__buffer)[0]= (uint8_t)((__int) & 0xFF); \
(__buffer)[1]= (uint8_t)(((__int) >> 8) & 0xFF); } while (0) (__buffer)[1]= (uint8_t)(((__int) >> 8) & 0xFF); } while (0)
@ -147,7 +147,7 @@ typedef struct mysql_session {
(__buffer)[2]= (uint8_t)(((__int) >> 16) & 0xFF); \ (__buffer)[2]= (uint8_t)(((__int) >> 16) & 0xFF); \
(__buffer)[3]= (uint8_t)(((__int) >> 24) & 0xFF); } while (0) (__buffer)[3]= (uint8_t)(((__int) >> 24) & 0xFF); } while (0)
/* Protocol unpacking macros. */ /** Protocol unpacking macros. */
#define gw_mysql_get_byte2(__buffer) \ #define gw_mysql_get_byte2(__buffer) \
(uint16_t)((__buffer)[0] | \ (uint16_t)((__buffer)[0] | \
((__buffer)[1] << 8)) ((__buffer)[1] << 8))
@ -170,7 +170,7 @@ typedef struct mysql_session {
((uint64_t)(__buffer)[6] << 48) | \ ((uint64_t)(__buffer)[6] << 48) | \
((uint64_t)(__buffer)[7] << 56)) ((uint64_t)(__buffer)[7] << 56))
/* MySQL protocol constants */ /** MySQL protocol constants */
typedef enum typedef enum
{ {
GW_MYSQL_CAPABILITIES_NONE= 0, GW_MYSQL_CAPABILITIES_NONE= 0,
@ -223,7 +223,7 @@ typedef enum
), ),
} gw_mysql_capabilities_t; } gw_mysql_capabilities_t;
/* Basic mysql commands */ /** Basic mysql commands */
#define MYSQL_COM_CHANGE_USER 0x11 #define MYSQL_COM_CHANGE_USER 0x11
#define MYSQL_COM_QUIT 0x1 #define MYSQL_COM_QUIT 0x1
#define MYSQL_COM_INIT_DB 0x2 #define MYSQL_COM_INIT_DB 0x2

32
server/modules/include/readconnection.h
View File

@ -37,8 +37,8 @@
* that is required for each of the backend servers. * that is required for each of the backend servers.
*/ */
typedef struct backend { typedef struct backend {
SERVER *server; /**< The server itself */ SERVER *server; /*< The server itself */
int current_connection_count; /**< Number of connections to the server */ int current_connection_count; /*< Number of connections to the server */
} BACKEND; } BACKEND;
/** /**
@ -48,11 +48,11 @@ typedef struct router_client_session {
#if defined(SS_DEBUG) #if defined(SS_DEBUG)
skygw_chk_t rses_chk_top; skygw_chk_t rses_chk_top;
#endif #endif
SPINLOCK rses_lock; /**< protects rses_deleted */ SPINLOCK rses_lock; /*< protects rses_deleted */
int rses_versno; /**< even = no active update, else odd */ int rses_versno; /*< even = no active update, else odd */
bool rses_closed; /**< true when closeSession is called */ bool rses_closed; /*< true when closeSession is called */
BACKEND *backend; /**< Backend used by the client session */ BACKEND *backend; /*< Backend used by the client session */
DCB *backend_dcb; /**< DCB Connection to the backend */ DCB *backend_dcb; /*< DCB Connection to the backend */
struct router_client_session struct router_client_session
*next; *next;
#if defined(SS_DEBUG) #if defined(SS_DEBUG)
@ -64,8 +64,8 @@ typedef struct router_client_session {
* The statistics for this router instance * The statistics for this router instance
*/ */
typedef struct { typedef struct {
int n_sessions; /**< Number sessions created */ int n_sessions; /*< Number sessions created */
int n_queries; /**< Number of queries forwarded */ int n_queries; /*< Number of queries forwarded */
} ROUTER_STATS; } ROUTER_STATS;
@ -73,13 +73,13 @@ typedef struct {
* The per instance data for the router. * The per instance data for the router.
*/ */
typedef struct router_instance { typedef struct router_instance {
SERVICE *service; /**< Pointer to the service using this router */ SERVICE *service; /*< Pointer to the service using this router */
ROUTER_CLIENT_SES *connections; /**< Link list of all the client connections */ ROUTER_CLIENT_SES *connections; /*< Link list of all the client connections */
SPINLOCK lock; /**< Spinlock for the instance data */ SPINLOCK lock; /*< Spinlock for the instance data */
BACKEND **servers; /**< List of backend servers */ BACKEND **servers; /*< List of backend servers */
unsigned int bitmask; /**< Bitmask to apply to server->status */ unsigned int bitmask; /*< Bitmask to apply to server->status */
unsigned int bitvalue; /**< Required value of server->status */ unsigned int bitvalue; /*< Required value of server->status */
ROUTER_STATS stats; /**< Statistics for this router */ ROUTER_STATS stats; /*< Statistics for this router */
struct router_instance struct router_instance
*next; *next;
} ROUTER_INSTANCE; } ROUTER_INSTANCE;

48
server/modules/include/readwritesplit.h
View File

@ -24,7 +24,7 @@
* @verbatim * @verbatim
* Revision History * Revision History
* *
* Tässä mitään historioita.. * bazaar..
* *
* @endverbatim * @endverbatim
*/ */
@ -37,8 +37,8 @@
* that is required for each of the backend servers. * that is required for each of the backend servers.
*/ */
typedef struct backend { typedef struct backend {
SERVER* backend_server; /**< The server itself */ SERVER* backend_server; /*< The server itself */
int backend_conn_count; /**< Number of connections to the server */ int backend_conn_count; /*< Number of connections to the server */
} BACKEND; } BACKEND;
/** /**
@ -48,13 +48,13 @@ typedef struct router_client_session {
#if defined(SS_DEBUG) #if defined(SS_DEBUG)
skygw_chk_t rses_chk_top; skygw_chk_t rses_chk_top;
#endif #endif
SPINLOCK rses_lock; /**< protects rses_deleted */ SPINLOCK rses_lock; /*< protects rses_deleted */
int rses_versno; /**< even = no active update, else odd */ int rses_versno; /*< even = no active update, else odd */
bool rses_closed; /**< true when closeSession is called */ bool rses_closed; /*< true when closeSession is called */
BACKEND* be_slave; /**< Slave backend used by client session */ BACKEND* be_slave; /*< Slave backend used by client session */
BACKEND* be_master; /**< Master backend used by client session */ BACKEND* be_master; /*< Master backend used by client session */
DCB* slave_dcb; /**< Slave connection */ DCB* slave_dcb; /*< Slave connection */
DCB* master_dcb; /**< Master connection */ DCB* master_dcb; /*< Master connection */
struct router_client_session* next; struct router_client_session* next;
#if defined(SS_DEBUG) #if defined(SS_DEBUG)
skygw_chk_t rses_chk_tail; skygw_chk_t rses_chk_tail;
@ -65,11 +65,11 @@ typedef struct router_client_session {
* The statistics for this router instance * The statistics for this router instance
*/ */
typedef struct { typedef struct {
int n_sessions; /**< Number sessions created */ int n_sessions; /*< Number sessions created */
int n_queries; /**< Number of queries forwarded */ int n_queries; /*< Number of queries forwarded */
int n_master; /**< Number of stmts sent to master */ int n_master; /*< Number of stmts sent to master */
int n_slave; /**< Number of stmts sent to slave */ int n_slave; /*< Number of stmts sent to slave */
int n_all; /**< Number of stmts sent to all */ int n_all; /*< Number of stmts sent to all */
} ROUTER_STATS; } ROUTER_STATS;
@ -77,15 +77,15 @@ typedef struct {
* The per instance data for the router. * The per instance data for the router.
*/ */
typedef struct router_instance { typedef struct router_instance {
SERVICE* service; /**< Pointer to service */ SERVICE* service; /*< Pointer to service */
ROUTER_CLIENT_SES* connections; /**< List of client connections */ ROUTER_CLIENT_SES* connections; /*< List of client connections */
SPINLOCK lock; /**< Lock for the instance data */ SPINLOCK lock; /*< Lock for the instance data */
BACKEND** servers; /**< Backend servers */ BACKEND** servers; /*< Backend servers */
BACKEND* master; /**< NULL or pointer */ BACKEND* master; /*< NULL or pointer */
unsigned int bitmask; /**< Bitmask to apply to server->status */ unsigned int bitmask; /*< Bitmask to apply to server->status */
unsigned int bitvalue; /**< Required value of server->status */ unsigned int bitvalue; /*< Required value of server->status */
ROUTER_STATS stats; /**< Statistics for this router */ ROUTER_STATS stats; /*< Statistics for this router */
struct router_instance* next; /**< Next router on the list */ struct router_instance* next; /*< Next router on the list */
} ROUTER_INSTANCE; } ROUTER_INSTANCE;