service_thread_scheduler.h

Go to the documentation of this file.

/*
  Copyright (c) 2010, 2024, 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 SERVICE_THREAD_SCHEDULER_INCLUDED
#define SERVICE_THREAD_SCHEDULER_INCLUDED
 
/**
  @file include/mysql/service_thread_scheduler.h
*/
 
struct Connection_handler_functions;
struct THD_event_functions;
 
extern "C" struct my_thread_scheduler_service {
  int (*connection_handler_set)(struct Connection_handler_functions *,
                                struct THD_event_functions *);
  int (*connection_handler_reset)();
} *my_thread_scheduler_service;
 
#ifdef MYSQL_DYNAMIC_PLUGIN
 
#define my_connection_handler_set(F, M) \
  my_thread_scheduler_service->connection_handler_set((F), (M))
#define my_connection_handler_reset() \
  my_thread_scheduler_service->connection_handler_reset()
 
#else
 
/**
   Instantiates Plugin_connection_handler based on the supplied
   Conection_handler_functions and sets it as the current
   connection handler.
 
   Also sets the THD_event_functions functions which will
   be called by the server when e.g. beginning a wait.
 
   Remembers the existing connection handler so that it can be restored later.
 
   @param chf  struct with functions to be called when e.g. handling
               new clients.
   @param tef  struct with functions to be called when events
               (e.g. lock wait) happens.
 
   @note Both pointers (i.e. not the structs themselves) will be copied,
         so the structs must not disappear.
 
   @note We don't support dynamically loading more than one connection handler.
 
   @retval 1  failure
   @retval 0  success
*/
int my_connection_handler_set(struct Connection_handler_functions *chf,
                              struct THD_event_functions *tef);
 
/**
   Destroys the current connection handler and restores the previous.
   Should only be called after calling my_connection_handler_set().
 
   @retval 1  failure
   @retval 0  success
*/
int my_connection_handler_reset();
 
#endif /* MYSQL_DYNAMIC_PLUGIN */
 
#endif /* SERVICE_THREAD_SCHEDULER_INCLUDED */