mysql_runtime_warning.h

Go to the documentation of this file.

/* Copyright (c) 2025, Oracle and/or its affiliates.
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2.0,
as published by the Free Software Foundation.
 
This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation.  The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License, version 2.0, for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 
#ifndef MYSQL_RUNTIME_WARNING_H
#define MYSQL_RUNTIME_WARNING_H
 
#include <mysql/components/service.h>
#include <mysql/components/services/bits/thd.h>
//! @cond Doxygen_Suppress
#include <stdarg.h>
//! @endcond
 
/**
  @ingroup group_components_services_inventory
 
  This service defines the warning report function api.
 
  This allows reporting warning into the connected session THD.
*/
BEGIN_SERVICE_DEFINITION(mysql_runtime_warning)
/**
  It calls the server SQL warning generation function and adds the warning
  into the THD's error context.
 
  @param thd      Thd of a current session.
  @param error_id mysql server error number, used to get the warning
  description.
  @param args  variable argument list which has the warning message details.
*/
DECLARE_METHOD(void, emit, (MYSQL_THD thd, int error_id, ...));
 
/**
  It calls the server SQL warning generation function and adds the warning
  into the THD's error context.
 
  @param thd      Thd of a current session.
  @param error_id mysql server error number, used to get the warning
  description.
  @param args  variable argument list which has the warning message details.
*/
DECLARE_METHOD(void, emit_v, (MYSQL_THD thd, int error_id, va_list args));
 
END_SERVICE_DEFINITION(mysql_runtime_warning)
 
#endif /* MYSQL_RUNTIME_WARNING_H */