Na}{

File Content: `service_srv_session.h`

/*  Copyright (c) 2015, 2022, 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 also distributed 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 included with MySQL.

    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_SRV_SESSION_SERVICE_INCLUDED
#define MYSQL_SRV_SESSION_SERVICE_INCLUDED

/**
  @file
  Header file for the Server session service. This service is to provide
  of creating sessions with the server. These sessions can be furtherly used
  together with the Command service to execute commands in the server.
*/


#ifdef __cplusplus
class Srv_session;
typedef class Srv_session* MYSQL_SESSION;
#else
struct Srv_session;
typedef struct Srv_session* MYSQL_SESSION;
#endif

#ifndef MYSQL_ABI_CHECK
#include "mysql/plugin.h"  /* MYSQL_THD */
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef void (*srv_session_error_cb)(void *ctx,
                                     unsigned int sql_errno,
                                     const char *err_msg);

extern struct srv_session_service_st
{
  int (*init_session_thread)(const void *plugin);

  void (*deinit_session_thread)();

  MYSQL_SESSION (*open_session)(srv_session_error_cb error_cb,
                                void *plugix_ctx);

  int (*detach_session)(MYSQL_SESSION session);

  int (*close_session)(MYSQL_SESSION session);

  int (*server_is_available)();
} *srv_session_service;

#ifdef MYSQL_DYNAMIC_PLUGIN

#define srv_session_init_thread(plugin) \
        srv_session_service->init_session_thread((plugin))

#define srv_session_deinit_thread() \
        srv_session_service->deinit_session_thread()

#define srv_session_open(cb, ctx) \
        srv_session_service->open_session((cb), (ctx))

#define srv_session_detach(session) \
        srv_session_service->detach_session((session))

#define srv_session_close(session) \
        srv_session_service->close_session((session))

#define srv_session_server_is_available() \
        srv_session_service->server_is_available()

#else

/**
  Initializes the current physical thread to use with session service.

  Call this function ONLY in physical threads which are not initialized in
  any way by the server.

  @param plugin  Pointer to the plugin structure, passed to the plugin over
                 the plugin init function.

  @return
    0  success
    1  failure
*/
int srv_session_init_thread(const void *plugin);

/**
  Deinitializes the current physical thread to use with session service.


  Call this function ONLY in physical threads which were initialized using
  srv_session_init_thread().
*/
void srv_session_deinit_thread();

/**
  Opens a server session.

  In a thread not initialized by the server itself, this function should be
  called only after srv_session_init_thread() has already been called.

  @param error_cb    Default completion callback
  @param plugin_ctx  Plugin's context, opaque pointer that would
                     be provided to callbacks. Might be NULL.
  @return
    session   on success
    NULL      on failure
*/
MYSQL_SESSION srv_session_open(srv_session_error_cb cb, void *plugix_ctx);

/**
  Detaches a session from current physical thread.

  Detaches a previously attached session. Sessions are automatically attached
  when they are used with the Command service (command_service_run_command()).
  If the session is opened in a spawned thread, then it will stay attached
  after command_service_run_command() until another session is used in the
  same physical thread. The command services will detach the previously used
  session and attach the one to be used for execution.

  This function should be called in case the session has to be used in
  different physical thread. It will unbound the session from the current
  physical thread. After that the session can be used in a different thread.

  @param session  Session to detach

  @returns
    0  success
    1  failure
*/
int srv_session_detach(MYSQL_SESSION session);

/**
  Closes a previously opened session.

  @param session  Session to close

  @return
    0  success
    1  failure
*/
int srv_session_close(MYSQL_SESSION session);

/**
  Returns if the server is available (not booting or shutting down)

  @return
    0  not available
    1  available
*/
int srv_session_server_is_available();


#endif

#ifdef __cplusplus
}
#endif

#endif /* MYSQL_SRV_SESSION_SERVICE_INCLUDED */

Name	Size	Permission
psi	---	0755
client_authentication.h	1658 bytes	0644
client_plugin.h	7143 bytes	0644
client_plugin.h.pp	1988 bytes	0644
com_data.h	3515 bytes	0644
get_password.h	1601 bytes	0644
group_replication_priv.h	5138 bytes	0644
innodb_priv.h	2570 bytes	0644
mysql_lex_string.h	1505 bytes	0644
plugin.h	26707 bytes	0644
plugin_audit.h	17944 bytes	0644
plugin_audit.h.pp	14023 bytes	0644
plugin_audit.h.pp.lve	13897 bytes	0644
plugin_auth.h	5767 bytes	0644
plugin_auth.h.pp	5147 bytes	0644
plugin_auth_common.h	5529 bytes	0644
plugin_ftparser.h	8047 bytes	0644
plugin_ftparser.h.pp	4871 bytes	0644
plugin_group_replication.h	6072 bytes	0644
plugin_keyring.h	6694 bytes	0644
plugin_keyring.h.pp	4458 bytes	0644
plugin_trace.h	12551 bytes	0644
plugin_validate_password.h	1986 bytes	0644
service_command.h	13882 bytes	0644
service_locking.h	4737 bytes	0644
service_my_plugin_log.h	2082 bytes	0644
service_my_snprintf.h	3812 bytes	0644
service_mysql_alloc.h	3163 bytes	0644
service_mysql_keyring.h	2858 bytes	0644
service_mysql_password_policy.h	2840 bytes	0644
service_mysql_string.h	5758 bytes	0644
service_parser.h	9814 bytes	0644
service_rpl_transaction_ctx.h	2764 bytes	0644
service_rpl_transaction_write_set.h	3663 bytes	0644
service_rules_table.h	5499 bytes	0644
service_security_context.h	4467 bytes	0644
service_srv_session.h	5300 bytes	0644
service_srv_session_info.h	5646 bytes	0644
service_ssl_wrapper.h	5558 bytes	0644
service_thd_alloc.h	4734 bytes	0644
service_thd_engine_lock.h	1898 bytes	0644
service_thd_wait.h	4348 bytes	0644
service_thread_scheduler.h	3079 bytes	0644
services.h	2351 bytes	0644
services.h.pp	22307 bytes	0644
thread_pool_priv.h	6652 bytes	0644
thread_type.h	1787 bytes	0644

File Content: service_srv_session.h

File Content: `service_srv_session.h`