7d51864402
Moved some typedefs to router.h and server.h, changed a few constants to these enums. Renamed some types in config.h to remove "Gateway". There are still some functions in the public header which are only used in core, but they seem to fit the theme of public functions so were not moved.
120 lines
4.0 KiB
C
120 lines
4.0 KiB
C
#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 router.h - The query router interface mechanisms
|
|
*
|
|
* Revision History
|
|
*
|
|
* Date Who Description
|
|
* 14/06/2013 Mark Riddoch Initial implementation
|
|
* 26/06/2013 Mark Riddoch Addition of router options and the diagnostic entry point
|
|
* 15/07/2013 Massimiliano Pinto Added clientReply entry point
|
|
* 16/07/2013 Massimiliano Pinto Added router commands values
|
|
* 22/10/2013 Massimiliano Pinto Added router errorReply entry point
|
|
* 27/10/2015 Martin Brampton Add RCAP_TYPE_NO_RSESSION
|
|
* 08/11/2016 Massimiliano Pinto Add destroyInstance() entry point
|
|
*
|
|
*/
|
|
|
|
#include <maxscale/cdefs.h>
|
|
#include <maxscale/routing.h>
|
|
#include <maxscale/service.h>
|
|
#include <maxscale/session.h>
|
|
#include <maxscale/buffer.h>
|
|
#include <stdint.h>
|
|
|
|
MXS_BEGIN_DECLS
|
|
|
|
/**
|
|
* The ROUTER handle points to module specific data, so the best we can do
|
|
* is to make it a void * externally.
|
|
*/
|
|
typedef void *ROUTER;
|
|
|
|
typedef enum error_action
|
|
{
|
|
ERRACT_NEW_CONNECTION = 0x001,
|
|
ERRACT_REPLY_CLIENT = 0x002
|
|
} error_action_t;
|
|
|
|
/**
|
|
* @verbatim
|
|
* The "module object" structure for a query router module
|
|
*
|
|
* The entry points are:
|
|
* createInstance Called by the service to create a new instance of the query router
|
|
* newSession Called to create a new user session within the query router
|
|
* closeSession Called when a session is closed
|
|
* routeQuery Called on each query that requires routing
|
|
* diagnostics Called to force the router to print diagnostic output
|
|
* clientReply Called to reply to client the data from one or all backends
|
|
* errorReply Called to reply to client errors with optional closeSession or make a request for
|
|
* a new backend connection
|
|
*
|
|
* @endverbatim
|
|
*
|
|
* @see load_module
|
|
*/
|
|
typedef struct router_object
|
|
{
|
|
ROUTER *(*createInstance)(SERVICE *service, char **options);
|
|
void *(*newSession)(ROUTER *instance, MXS_SESSION *session);
|
|
void (*closeSession)(ROUTER *instance, void *router_session);
|
|
void (*freeSession)(ROUTER *instance, void *router_session);
|
|
int32_t (*routeQuery)(ROUTER *instance, void *router_session, GWBUF *queue);
|
|
void (*diagnostics)(ROUTER *instance, DCB *dcb);
|
|
void (*clientReply)(ROUTER* instance, void* router_session, GWBUF* queue, DCB *backend_dcb);
|
|
void (*handleError)(ROUTER* instance,
|
|
void* router_session,
|
|
GWBUF* errmsgbuf,
|
|
DCB* backend_dcb,
|
|
error_action_t action,
|
|
bool* succp);
|
|
uint64_t (*getCapabilities)(void);
|
|
void (*destroyInstance)(ROUTER *instance);
|
|
} ROUTER_OBJECT;
|
|
|
|
/**
|
|
* The router module API version. Any change that changes the router API
|
|
* must update these versions numbers in accordance with the rules in
|
|
* modinfo.h.
|
|
*/
|
|
#define ROUTER_VERSION { 2, 0, 0 }
|
|
|
|
/**
|
|
* Specifies capabilities specific for routers. Common capabilities
|
|
* are defined by @c routing_capability_t.
|
|
*
|
|
* @see routing_capability_t
|
|
*
|
|
* @note The values of the capabilities here *must* be between 0x00010000
|
|
* and 0x80000000, that is, bits 16 to 31.
|
|
*/
|
|
typedef enum router_capability
|
|
{
|
|
RCAP_TYPE_NO_RSESSION = 0x00010000, /**< Router does not use router sessions */
|
|
RCAP_TYPE_NO_USERS_INIT = 0x00020000, /**< Prevent the loading of authenticator
|
|
users when the service is started */
|
|
} router_capability_t;
|
|
|
|
typedef enum
|
|
{
|
|
TYPE_UNDEFINED = 0,
|
|
TYPE_MASTER,
|
|
TYPE_ALL
|
|
} target_t;
|
|
|
|
MXS_END_DECLS
|