%-*-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
%
% gcdict portion of Onyx Manual.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

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

The \classname{gcdict} functions implement the operators contained in
\onyxop{}{gcdict}{}.  Only the C API is documented here; see
Section~\ref{sec:gcdict} for operator semantics.

\subsubsection{API}
\begin{capi}
\label{gcdict_active}
\index{gcdict_active@\cfunc{gcdict\_active}{}}
\citem{\cfunc[void]{gcdict\_\htmlref{active}{gcdict:active}}{cw\_nxo\_t
*a\_thread}}
\label{gcdict_collect}
\index{gcdict_collect@\cfunc{gcdict\_collect}{}}
\citem{\cfunc[void]{gcdict\_\htmlref{collect}{gcdict:collect}}{cw\_nxo\_t
*a\_thread}}
\label{gcdict_period}
\index{gcdict_period@\cfunc{gcdict\_period}{}}
\citem{\cfunc[void]{gcdict\_\htmlref{period}{gcdict:period}}{cw\_nxo\_t
*a\_thread}}
\label{gcdict_setactive}
\index{gcdict_setactive@\cfunc{gcdict\_setactive}{}}
\citem{\cfunc[void]{gcdict\_\htmlref{setactive}{gcdict:setactive}}{cw\_nxo\_t
*a\_thread}}
\label{gcdict_setperiod}
\index{gcdict_setperiod@\cfunc{gcdict\_setperiod}{}}
\citem{\cfunc[void]{gcdict\_\htmlref{setperiod}{gcdict:setperiod}}{cw\_nxo\_t
*a\_thread}}
\label{gcdict_setthreshold}
\index{gcdict_setthreshold@\cfunc{gcdict\_setthreshold}{}}
\citem{\cfunc[void]{gcdict\_\htmlref{setthreshold}{gcdict:setthreshold}}{cw\_nxo\_t
*a\_thread}}
\label{gcdict_stats}
\index{gcdict_stats@\cfunc{gcdict\_stats}{}}
\citem{\cfunc[void]{gcdict\_\htmlref{stats}{gcdict:stats}}{cw\_nxo\_t
*a\_thread}}
\label{gcdict_threshold}
\index{gcdict_threshold@\cfunc{gcdict\_threshold}{}}
\citem{\cfunc[void]{gcdict\_\htmlref{threshold}{gcdict:threshold}}{cw\_nxo\_t
*a\_thread}}
	\begin{capilist}
	\item[Input(s): ]
		\begin{description}\item[]
		\item[a\_thread: ]
			Pointer to a thread.
		\end{description}
	\item[Output(s): ] None.
	\item[Exception(s): ]
		\begin{description}\item[]
		\item[\htmlref{CW\_ONYXX\_OOM}{CW_ONYXX_OOM}.]
		\end{description}
	\item[Description: ]
		C interfaces to Onyx operators that control garbage collection.
	\end{capilist}
\end{capi}
