MySQL 8.0.31
Source Code Documentation
audit_api_message_service.h
Go to the documentation of this file.
1/* Copyright (c) 2018, 2022, Oracle and/or its affiliates.
2
3This program is free software; you can redistribute it and/or modify
4it under the terms of the GNU General Public License, version 2.0,
5as published by the Free Software Foundation.
6
7This program is also distributed with certain software (including
8but not limited to OpenSSL) that is licensed under separate terms,
9as designated in a particular file or component or in included license
10documentation. The authors of MySQL hereby grant you an additional
11permission to link the program and your derivative works with the
12separately licensed software that they have included with MySQL.
13
14This program is distributed in the hope that it will be useful,
15but WITHOUT ANY WARRANTY; without even the implied warranty of
16MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17GNU General Public License, version 2.0, for more details.
18
19You should have received a copy of the GNU General Public License
20along with this program; if not, write to the Free Software
21Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22
23#ifndef AUDIT_API_MESSAGE_H
24#define AUDIT_API_MESSAGE_H
25
29
30BEGIN_SERVICE_DEFINITION(mysql_audit_api_message)
31
32/**
33 Method that emits Audit API message event.
34
35 @param type Message event type.
36 @param component Component name.
37 @param component_length Component name length.
38 @param producer Producer name.
39 @param producer_length Producer name length.
40 @param message Message.
41 @param message_length Message length.
42 @param key_value_map Key-value map pointer. The function does not
43 perform key values uniqueness.
44 @param key_value_map_length Key-value map length;
45
46 @return This method always generates false no matter, whether the message
47 event is consumed by the audit plugin or not.
48*/
50 const char *component, size_t component_length,
51 const char *producer, size_t producer_length,
52 const char *message, size_t message_length,
54 size_t key_value_map_length));
55
56END_SERVICE_DEFINITION(mysql_audit_api_message)
57
58#endif /* AUDIT_API_MESSAGE_H */
static char * emit(UDF_INIT *initid, UDF_ARGS *args, char *result, unsigned long *length, unsigned char *null_value, unsigned char *error)
UDF function itself.
Definition: audit_api_message_emit.cc:428
mysql_event_message_subclass_t
Events for MYSQL_AUDIT_MESSAGE_CLASS event class.
Definition: plugin_audit_message_types.h:40
required string type
Definition: replication_group_member_actions.proto:33
#define END_SERVICE_DEFINITION(name)
A macro to end the last Service definition started with the BEGIN_SERVICE_DEFINITION macro.
Definition: service.h:90
#define BEGIN_SERVICE_DEFINITION(name)
Declares a new Service.
Definition: service.h:85
#define DECLARE_BOOL_METHOD(name, args)
Declares a method that returns bool as a part of the Service definition.
Definition: service.h:111
Structure that stores key-value pair of the MYSQL_AUDIT_MESSAGE_CLASS event class.
Definition: plugin_audit_message_types.h:63