summaryrefslogtreecommitdiff
path: root/storage/xtradb/include/thr0loc.h
diff options
context:
space:
mode:
Diffstat (limited to 'storage/xtradb/include/thr0loc.h')
-rw-r--r--storage/xtradb/include/thr0loc.h31
1 files changed, 16 insertions, 15 deletions
diff --git a/storage/xtradb/include/thr0loc.h b/storage/xtradb/include/thr0loc.h
index 96ec13cc8e4..34c5232238d 100644
--- a/storage/xtradb/include/thr0loc.h
+++ b/storage/xtradb/include/thr0loc.h
@@ -16,7 +16,8 @@ Place, Suite 330, Boston, MA 02111-1307 USA
*****************************************************************************/
-/******************************************************
+/**************************************************//**
+@file include/thr0loc.h
The thread local storage
Created 10/5/1995 Heikki Tuuri
@@ -32,49 +33,49 @@ OS handle to the current thread, or its priority. */
#include "univ.i"
#include "os0thread.h"
-/********************************************************************
+/****************************************************************//**
Initializes the thread local storage module. */
UNIV_INTERN
void
thr_local_init(void);
/*================*/
-/***********************************************************************
+/*******************************************************************//**
Creates a local storage struct for the calling new thread. */
UNIV_INTERN
void
thr_local_create(void);
/*==================*/
-/***********************************************************************
+/*******************************************************************//**
Frees the local storage struct for the specified thread. */
UNIV_INTERN
void
thr_local_free(
/*===========*/
- os_thread_id_t id); /* in: thread id */
-/***********************************************************************
-Gets the slot number in the thread table of a thread. */
+ os_thread_id_t id); /*!< in: thread id */
+/*******************************************************************//**
+Gets the slot number in the thread table of a thread.
+@return slot number */
UNIV_INTERN
ulint
thr_local_get_slot_no(
/*==================*/
- /* out: slot number */
- os_thread_id_t id); /* in: thread id of the thread */
-/***********************************************************************
+ os_thread_id_t id); /*!< in: thread id of the thread */
+/*******************************************************************//**
Sets in the local storage the slot number in the thread table of a thread. */
UNIV_INTERN
void
thr_local_set_slot_no(
/*==================*/
- os_thread_id_t id, /* in: thread id of the thread */
- ulint slot_no);/* in: slot number */
-/***********************************************************************
+ os_thread_id_t id, /*!< in: thread id of the thread */
+ ulint slot_no);/*!< in: slot number */
+/*******************************************************************//**
Returns pointer to the 'in_ibuf' field within the current thread local
-storage. */
+storage.
+@return pointer to the in_ibuf field */
UNIV_INTERN
ibool*
thr_local_get_in_ibuf_field(void);
/*=============================*/
- /* out: pointer to the in_ibuf field */
/*************************************************************************
Return local hash table informations. */