client_plugin.h File Reference

#include <stdarg.h>
#include <stdlib.h>
#include <mysql/plugin_auth_common.h>

Include dependency graph for client_plugin.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	st_mysql_client_plugin
struct	st_mysql_client_plugin_AUTHENTICATION

Macros
#define	MYSQL_CLIENT_PLUGIN_INCLUDED
#define	MYSQL_CLIENT_reserved1   0
#define	MYSQL_CLIENT_reserved2   1
#define	MYSQL_CLIENT_AUTHENTICATION_PLUGIN   2
#define	MYSQL_CLIENT_AUTHENTICATION_PLUGIN_INTERFACE_VERSION   0x0100
#define	MYSQL_CLIENT_MAX_PLUGINS   3
#define	mysql_declare_client_plugin(X)
#define	mysql_end_client_plugin   }
#define	MYSQL_CLIENT_PLUGIN_HEADER

Functions
struct st_mysql_client_plugin *	mysql_load_plugin (struct st_mysql *mysql, const char *name, int type, int argc,...)
struct st_mysql_client_plugin *	mysql_load_plugin_v (struct st_mysql *mysql, const char *name, int type, int argc, va_list args)
struct st_mysql_client_plugin *	mysql_client_find_plugin (struct st_mysql *mysql, const char *name, int type)
struct st_mysql_client_plugin *	mysql_client_register_plugin (struct st_mysql *mysql, struct st_mysql_client_plugin *plugin)
int	mysql_plugin_options (struct st_mysql_client_plugin *plugin, const char *option, const void *value)

Detailed Description

MySQL Client Plugin API

This file defines the API for plugins that work on the client side

Definition in file client_plugin.h.

Macro Definition Documentation

#define MYSQL_CLIENT_PLUGIN_HEADER

Value:

int type;                                             \
  unsigned int interface_version;                       \
  const char *name;                                     \
  const char *author;                                   \
  const char *desc;                                     \
  unsigned int version[3];                              \
  const char *license;                                  \
  void *mysql_api;                                      \
  int (*init)(char *, size_t, int, va_list);            \
  int (*deinit)();                                      \
  int (*options)(const char *option, const void *);

Definition at line 48 of file client_plugin.h.

#define mysql_declare_client_plugin

(

X

)

Value:

MYSQL_PLUGIN_EXPORT struct st_mysql_client_plugin_ ## X        \
        _mysql_client_plugin_declaration_ = {   \
          MYSQL_CLIENT_ ## X ## _PLUGIN,        \
          MYSQL_CLIENT_ ## X ## _PLUGIN_INTERFACE_VERSION,

Definition at line 40 of file client_plugin.h.

Function Documentation

struct st_mysql_client_plugin* mysql_client_find_plugin ( struct st_mysql *  mysql, const char *  name, int  type  )

read

finds an already loaded plugin by name, or loads it, if necessary

Parameters

mysql	MYSQL structure.
name	a name of the plugin to load
type	type of plugin that should be loaded

Return values

a	pointer to the plugin, or NULL in case of a failure

Definition at line 478 of file client_plugin.c.

Here is the call graph for this function:

struct st_mysql_client_plugin* mysql_client_register_plugin ( struct st_mysql *  mysql, struct st_mysql_client_plugin *  plugin  )

read

adds a plugin structure to the list of loaded plugins

This is useful if an application has the necessary functionality (for example, a special load data handler) statically linked into the application binary. It can use this function to register the plugin directly, avoiding the need to factor it out into a shared object.

Parameters

mysql	MYSQL structure. It is only used for error reporting
plugin	an st_mysql_client_plugin structure to register

Return values

a	pointer to the plugin, or NULL in case of a failure

Definition at line 319 of file client_plugin.c.

struct st_mysql_client_plugin* mysql_load_plugin ( struct st_mysql *  mysql, const char *  name, int  type, int  argc,   ...  )

read

loads a plugin and initializes it

Parameters

mysql	MYSQL structure.
name	a name of the plugin to load
type	type of plugin that should be loaded, -1 to disable type check
argc	number of arguments to pass to the plugin initialization function
...	arguments for the plugin initialization function

Return values

a	pointer to the loaded plugin, or NULL in case of a failure

Definition at line 466 of file client_plugin.c.

Here is the call graph for this function:

Here is the caller graph for this function:

struct st_mysql_client_plugin* mysql_load_plugin_v ( struct st_mysql *  mysql, const char *  name, int  type, int  argc, va_list  args  )

read

loads a plugin and initializes it, taking va_list as an argument

This is the same as mysql_load_plugin, but take va_list instead of a list of arguments.

Parameters

mysql	MYSQL structure.
name	a name of the plugin to load
type	type of plugin that should be loaded, -1 to disable type check
argc	number of arguments to pass to the plugin initialization function
args	arguments for the plugin initialization function

Return values

a	pointer to the loaded plugin, or NULL in case of a failure

Definition at line 344 of file client_plugin.c.

Here is the caller graph for this function:

int mysql_plugin_options	(	struct st_mysql_client_plugin *	plugin,
		const char *	option,
		const void *	value
	)

set plugin options

Can be used to set extra options and affect behavior for a plugin. This function may be called multiple times to set several options

Parameters

plugin	an st_mysql_client_plugin structure
option	a string which specifies the option to set
value	value for the option.

Return values

0	on success, 1 in case of failure

Definition at line 508 of file client_plugin.c.