Added doxygen documentation

This commit is contained in:
Mark Riddoch 2013-06-26 09:44:40 +02:00
parent 1595725494
commit 0113088af6

View File

@ -36,36 +36,36 @@
struct dcb;
/*
/**
* MySQL Protocol specific state data
*/
typedef struct {
int fd; /* The socket descriptor */
struct dcb *descriptor; /* The DCB of the socket we are running on */
int state; /* Current descriptor state */
char scramble[MYSQL_SCRAMBLE_LEN]; /* server scramble, created or received */
uint32_t server_capabilities; /* server capabilities, created or received */
uint32_t client_capabilities; /* client capabilities, created or received */
unsigned long tid; /* MySQL Thread ID, in handshake */
int fd; /**< The socket descriptor */
struct dcb *descriptor; /**< The DCB of the socket we are running on */
int state; /**< Current descriptor state */
char scramble[MYSQL_SCRAMBLE_LEN]; /**< server scramble, created or received */
uint32_t server_capabilities; /**< server capabilities, created or received */
uint32_t client_capabilities; /**< client capabilities, created or received */
unsigned long tid; /**< MySQL Thread ID, in handshake */
} MySQLProtocol;
/*
/**
* MySQL session specific data
*
*/
typedef struct mysql_session {
uint8_t client_sha1[MYSQL_SCRAMBLE_LEN]; /* SHA1(passowrd) */
char user[MYSQL_USER_MAXLEN]; /* username */
char db[MYSQL_DATABASE_MAXLEN]; /* database */
uint8_t client_sha1[MYSQL_SCRAMBLE_LEN]; /**< SHA1(passowrd) */
char user[MYSQL_USER_MAXLEN]; /**< username */
char db[MYSQL_DATABASE_MAXLEN]; /**< database */
} MYSQL_session;
/* MySQL Protocol States */
#define MYSQL_ALLOC 0 /* Allocate data */
#define MYSQL_AUTH_SENT 1 /* Authentication handshake has been sent */
#define MYSQL_AUTH_RECV 2 /* Received user, password, db and capabilities */
#define MYSQL_AUTH_FAILED 3 /* Auth failed, return error packet */
#define MYSQL_IDLE 4 /* Auth done. Protocol is idle, waiting for statements */
#define MYSQL_ROUTING 5 /* The received command has been routed to backend(s) */
#define MYSQL_WAITING_RESULT 6 /* Waiting for result set */
#define MYSQL_ALLOC 0 /**< Allocate data */
#define MYSQL_AUTH_SENT 1 /**< Authentication handshake has been sent */
#define MYSQL_AUTH_RECV 2 /**< Received user, password, db and capabilities */
#define MYSQL_AUTH_FAILED 3 /**< Auth failed, return error packet */
#define MYSQL_IDLE 4 /**< Auth done. Protocol is idle, waiting for statements */
#define MYSQL_ROUTING 5 /**< The received command has been routed to backend(s) */
#define MYSQL_WAITING_RESULT 6 /**< Waiting for result set */
#endif