Addition of dependencies to the makefile

New make target of "make depend"
Addition of doxygen building ability
Cleanup of docygen comment blocks
Initial telnetd protocol module structure
This commit is contained in:
Mark Riddoch
2013-06-17 14:03:05 +02:00
parent 876af46cdd
commit 1300c5d089
31 changed files with 2284 additions and 147 deletions

View File

@ -19,13 +19,18 @@
#include <dcb.h>
#include <buffer.h>
/*
/**
* @file mysql_backend.c - protcol module to connect to a backend MySQL database
*
* MySQL Protocol module for handling the protocol between the gateway
* and the backend MySQL database.
*
* @verbatim
* Revision History
* Date Who Description
* 14/06/2013 Mark Riddoch Initial version
*
* @endverbatim
*/
static char *version_str = "V1.0.0";
@ -35,18 +40,21 @@ extern int gw_write_backend_event(DCB *dcb, int epfd);
extern int MySQLWrite(DCB *dcb, GWBUF *queue);
extern int handle_event_errors_backend(DCB *dcb, int event);
/**
* The module object that defines the entry points to the protocol module.
*/
static GWPROTOCOL MyObject = {
gw_read_backend_event, /* Read - EPOLLIN handler */
MySQLWrite, /* Write - data from gateway */
gw_write_backend_event, /* WriteReady - EPOLLOUT handler */
handle_event_errors_backend, /* Error - EPOLLERR handler */
NULL, /* HangUp - EPOLLHUP handler */
NULL, /* Accept */
NULL, /* Connect */
NULL /* Close */
gw_read_backend_event, /**< Read - EPOLLIN handler */
MySQLWrite, /**< Write - data from gateway */
gw_write_backend_event, /**< WriteReady - EPOLLOUT handler */
handle_event_errors_backend, /**< Error - EPOLLERR handler */
NULL, /**< HangUp - EPOLLHUP handler */
NULL, /**< Accept */
NULL, /**< Connect */
NULL /**< Close */
};
/*
/**
* Implementation of the mandatory version entry point
*
* @return version string of the module
@ -57,7 +65,7 @@ version()
return version_str;
}
/*
/**
* The module initialisation routine, called when the module
* is first loaded.
*/
@ -67,7 +75,7 @@ ModuleInit()
fprintf(stderr, "Initial MySQL Client Protcol module.\n");
}
/*
/**
* The module entry point routine. It is this routine that
* must populate the structure that is referred to as the
* "module object", this is a structure with the set of