%-*-mode:latex-*-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Copyright (C) 1996-2004 Jason Evans <jasone@canonware.com>.
% All rights reserved.
% 
% Redistribution and use in source and binary forms, with or without
% modification, are permitted provided that the following conditions
% are met:
% 1. Redistributions of source code must retain the above copyright
%    notice(s), this list of conditions and the following disclaimer
%    unmodified other than the allowable addition of one or more
%    copyright notices.
% 2. Redistributions in binary form must reproduce the above copyright
%    notice(s), this list of conditions and the following disclaimer in
%    the documentation and/or other materials provided with the
%    distribution.
% 
% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
% EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
% PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
% BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
% WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
% OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
% EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Version: Onyx 5.1.1
%
% tsd portion of Onyx Manual.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\subsection{tsd}
\label{tsd}
\index{tsd@\classname{tsd}{}}

The \classname{tsd} class implements thread-specific data.  A \classname{tsd}
instance can be created, then any number of threads can use that same instance
to store and retrieve a thread-specific pointer to data.

\subsubsection{API}
\begin{capi}
\label{tsd_new}
\index{tsd_new@\cfunc{tsd\_new}{}}
\citem{\cfunc[void]{tsd\_new}{cw\_tsd\_t *a\_tsd, void (*a\_func)(void *)}}
	\begin{capilist}
	\item[Input(s): ]
		\begin{description}\item[]
		\item[a\_tsd: ]
			Pointer to space for a \classname{tsd}.
		\item[a\_func: ]
			Pointer to a cleanup function, or NULL.
		\end{description}
	\item[Output(s): ] None.
	\item[Exception(s): ] None.
	\item[Description: ]
		Constructor.
	\end{capilist}
\label{tsd_delete}
\index{tsd_delete@\cfunc{tsd\_delete}{}}
\citem{\cfunc[void]{tsd\_delete}{cw\_tsd\_t *a\_tsd}}
	\begin{capilist}
	\item[Input(s): ]
		\begin{description}\item[]
		\item[a\_tsd: ]
			Pointer to a \classname{tsd}.
		\end{description}
	\item[Output(s): ] None.
	\item[Exception(s): ] None.
	\item[Description: ]
		Destructor.
	\end{capilist}
\label{tsd_get}
\index{tsd_get@\cfunc{tsd\_get}{}}
\citem{\cfunc[void *]{tsd\_get}{cw\_tsd\_t *a\_tsd}}
	\begin{capilist}
	\item[Input(s): ]
		\begin{description}\item[]
		\item[a\_tsd: ]
			Pointer to a \classname{tsd}.
		\end{description}
	\item[Output(s): ]
		\begin{description}\item[]
		\item[retval: ]
			Pointer to thread-specific data.
		\end{description}
	\item[Exception(s): ] None.
	\item[Description: ]
		Get thread-specific data pointer.
	\end{capilist}
\label{tsd_set}
\index{tsd_set@\cfunc{tsd\_set}{}}
\citem{\cfunc[void]{tsd\_set}{cw\_tsd\_t *a\_tsd, void *a\_val}}
	\begin{capilist}
	\item[Input(s): ]
		\begin{description}\item[]
		\item[a\_tsd: ]
			Pointer to a \classname{tsd}.
		\item[a\_val: ]
			Pointer to thread-specific data.
		\end{description}
	\item[Output(s): ] None.
	\item[Exception(s): ] None.
	\item[Description: ]
		Set thread-specific data pointer.
	\end{capilist}
\end{capi}
