MySQL  8.0.20
Source Code Documentation
udf_descriptor.h
Go to the documentation of this file.
1 /* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
2 
3  This program is free software; you can redistribute it and/or modify
4  it under the terms of the GNU General Public License, version 2.0,
5  as published by the Free Software Foundation.
6 
7  This program is also distributed with certain software (including
8  but not limited to OpenSSL) that is licensed under separate terms,
9  as designated in a particular file or component or in included license
10  documentation. The authors of MySQL hereby grant you an additional
11  permission to link the program and your derivative works with the
12  separately licensed software that they have included with MySQL.
13 
14  This program is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  GNU General Public License, version 2.0, for more details.
18 
19  You should have received a copy of the GNU General Public License
20  along with this program; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22 
23 #ifndef PLUGIN_GR_INCLUDE_UDF_DESCRIPTOR_H
24 #define PLUGIN_GR_INCLUDE_UDF_DESCRIPTOR_H
25 
27 
28 /**
29  * Contains all the necessary data to register an UDF in MySQL.
30  */
32  char const *name;
37 
38  udf_descriptor(char const *udf_name, enum Item_result udf_result_type,
39  Udf_func_any udf_function, Udf_func_init udf_init,
40  Udf_func_deinit udf_deinit)
41  : name(udf_name),
42  result_type(udf_result_type),
43  main_function(udf_function),
44  init_function(udf_init),
45  deinit_function(udf_deinit) {}
46  udf_descriptor(udf_descriptor const &) = delete;
47  udf_descriptor(udf_descriptor &&other) = default;
48  udf_descriptor &operator=(udf_descriptor const &) = delete;
49  udf_descriptor &operator=(udf_descriptor &&other) = default;
50 };
51 
52 #endif /* PLUGIN_GR_INCLUDE_UDF_DESCRIPTOR_H */
Item_result
Type of the user defined function return slot and arguments.
Definition: udf_registration_types.h:38
udf_descriptor & operator=(udf_descriptor const &)=delete
void(* Udf_func_any)(void)
Definition: udf_registration_types.h:81
Udf_func_any main_function
Definition: udf_descriptor.h:34
Contains all the necessary data to register an UDF in MySQL.
Definition: udf_descriptor.h:31
enum Item_result result_type
Definition: udf_descriptor.h:33
bool(* Udf_func_init)(UDF_INIT *, UDF_ARGS *, char *)
Definition: udf_registration_types.h:80
void(* Udf_func_deinit)(UDF_INIT *)
Definition: udf_registration_types.h:79
udf_descriptor(char const *udf_name, enum Item_result udf_result_type, Udf_func_any udf_function, Udf_func_init udf_init, Udf_func_deinit udf_deinit)
Definition: udf_descriptor.h:38
Udf_func_deinit deinit_function
Definition: udf_descriptor.h:36
char const * name
Definition: udf_descriptor.h:32
Udf_func_init init_function
Definition: udf_descriptor.h:35