\hypertarget{ompi_2mca_2allocator_2base_2base_8h}{\section{ompi/mca/allocator/base/base.h File Reference}
\label{ompi_2mca_2allocator_2base_2base_8h}\index{ompi/mca/allocator/base/base.\+h@{ompi/mca/allocator/base/base.\+h}}
}
{\ttfamily \#include \char`\"{}ompi\+\_\+config.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}opal/class/opal\+\_\+list.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}opal/mca/mca.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}ompi/mca/allocator/allocator.\+h\char`\"{}}\\*
\subsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structmca__allocator__base__selected__module__t}{mca\+\_\+allocator\+\_\+base\+\_\+selected\+\_\+module\+\_\+t}
\begin{DoxyCompactList}\small\item\em Structure which describes a selected module. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
\hypertarget{ompi_2mca_2allocator_2base_2base_8h_a8475e0a0fa47fe89d76918d81d2eeda9}{typedef struct \\*
\hyperlink{structmca__allocator__base__selected__module__t}{mca\+\_\+allocator\+\_\+base\+\_\+selected\+\_\+module\+\_\+t} \hyperlink{ompi_2mca_2allocator_2base_2base_8h_a8475e0a0fa47fe89d76918d81d2eeda9}{mca\+\_\+allocator\+\_\+base\+\_\+selected\+\_\+module\+\_\+t}}\label{ompi_2mca_2allocator_2base_2base_8h_a8475e0a0fa47fe89d76918d81d2eeda9}

\begin{DoxyCompactList}\small\item\em Convenience typedef. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{ompi_2mca_2allocator_2base_2base_8h_af5b6c1c57e408301c5bdb311c1ad982a}{O\+M\+P\+I\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C \hyperlink{ompi_2mca_2allocator_2base_2base_8h_af5b6c1c57e408301c5bdb311c1ad982a}{O\+B\+J\+\_\+\+C\+L\+A\+S\+S\+\_\+\+D\+E\+C\+L\+A\+R\+A\+T\+I\+O\+N} (\hyperlink{structmca__allocator__base__selected__module__t}{mca\+\_\+allocator\+\_\+base\+\_\+selected\+\_\+module\+\_\+t})}\label{ompi_2mca_2allocator_2base_2base_8h_af5b6c1c57e408301c5bdb311c1ad982a}

\begin{DoxyCompactList}\small\item\em Declaces \hyperlink{structmca__mpool__base__selected__module__t}{mca\+\_\+mpool\+\_\+base\+\_\+selected\+\_\+module\+\_\+t} as a class. \end{DoxyCompactList}\item 
\hypertarget{ompi_2mca_2allocator_2base_2base_8h_aca04ab0d9d944744885ed9ec1cb67568}{O\+M\+P\+I\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{ompi_2mca_2allocator_2base_2base_8h_aca04ab0d9d944744885ed9ec1cb67568}{mca\+\_\+allocator\+\_\+base\+\_\+open} (void)}\label{ompi_2mca_2allocator_2base_2base_8h_aca04ab0d9d944744885ed9ec1cb67568}

\begin{DoxyCompactList}\small\item\em \hyperlink{structFunction}{Function} for finding and opening either all M\+C\+A components, or the one that was specifically requested via a M\+C\+A parameter. \end{DoxyCompactList}\item 
O\+M\+P\+I\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{ompi_2mca_2allocator_2base_2base_8h_a46f8ccc41b971d58fe209804fe23b4bc}{mca\+\_\+allocator\+\_\+base\+\_\+close} (void)
\begin{DoxyCompactList}\small\item\em Closes all the remaining modules. \end{DoxyCompactList}\item 
O\+M\+P\+I\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C \\*
\hyperlink{allocator_8h_adba0f37f8491efef97cc54cc69966bb8}{mca\+\_\+allocator\+\_\+base\+\_\+component\+\_\+t} $\ast$ \hyperlink{ompi_2mca_2allocator_2base_2base_8h_add55055fc5d6b3aa419ce46451fd2242}{mca\+\_\+allocator\+\_\+component\+\_\+lookup} (const char $\ast$name)
\begin{DoxyCompactList}\small\item\em Traverses through the list of available components, calling their init functions until it finds the component that has the specified name. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Variables}
\begin{DoxyCompactItemize}
\item 
\hypertarget{ompi_2mca_2allocator_2base_2base_8h_a7ede24c284e37539c8252032ba2290b9}{O\+M\+P\+I\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C \hyperlink{structopal__list__t}{opal\+\_\+list\+\_\+t} \hyperlink{ompi_2mca_2allocator_2base_2base_8h_a7ede24c284e37539c8252032ba2290b9}{mca\+\_\+allocator\+\_\+base\+\_\+components}}\label{ompi_2mca_2allocator_2base_2base_8h_a7ede24c284e37539c8252032ba2290b9}

\begin{DoxyCompactList}\small\item\em The list of all the selected components. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Function Documentation}
\hypertarget{ompi_2mca_2allocator_2base_2base_8h_a46f8ccc41b971d58fe209804fe23b4bc}{\index{ompi/mca/allocator/base/base.\+h@{ompi/mca/allocator/base/base.\+h}!mca\+\_\+allocator\+\_\+base\+\_\+close@{mca\+\_\+allocator\+\_\+base\+\_\+close}}
\index{mca\+\_\+allocator\+\_\+base\+\_\+close@{mca\+\_\+allocator\+\_\+base\+\_\+close}!ompi/mca/allocator/base/base.\+h@{ompi/mca/allocator/base/base.\+h}}
\subsubsection[{mca\+\_\+allocator\+\_\+base\+\_\+close}]{\setlength{\rightskip}{0pt plus 5cm}O\+M\+P\+I\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int mca\+\_\+allocator\+\_\+base\+\_\+close (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}\label{ompi_2mca_2allocator_2base_2base_8h_a46f8ccc41b971d58fe209804fe23b4bc}


Closes all the remaining modules. 


\begin{DoxyRetVals}{Return values}
{\em O\+M\+P\+I\+\_\+\+S\+U\+C\+C\+E\+S\+S} & \\
\hline
\end{DoxyRetVals}


References mca\+\_\+allocator\+\_\+base\+\_\+components, and mca\+\_\+allocator\+\_\+base\+\_\+output.

\hypertarget{ompi_2mca_2allocator_2base_2base_8h_add55055fc5d6b3aa419ce46451fd2242}{\index{ompi/mca/allocator/base/base.\+h@{ompi/mca/allocator/base/base.\+h}!mca\+\_\+allocator\+\_\+component\+\_\+lookup@{mca\+\_\+allocator\+\_\+component\+\_\+lookup}}
\index{mca\+\_\+allocator\+\_\+component\+\_\+lookup@{mca\+\_\+allocator\+\_\+component\+\_\+lookup}!ompi/mca/allocator/base/base.\+h@{ompi/mca/allocator/base/base.\+h}}
\subsubsection[{mca\+\_\+allocator\+\_\+component\+\_\+lookup}]{\setlength{\rightskip}{0pt plus 5cm}O\+M\+P\+I\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C {\bf mca\+\_\+allocator\+\_\+base\+\_\+component\+\_\+t}$\ast$ mca\+\_\+allocator\+\_\+component\+\_\+lookup (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{name}
\end{DoxyParamCaption}
)}}\label{ompi_2mca_2allocator_2base_2base_8h_add55055fc5d6b3aa419ce46451fd2242}


Traverses through the list of available components, calling their init functions until it finds the component that has the specified name. 

It then returns the found component.


\begin{DoxyParams}{Parameters}
{\em name} & the name of the component that is being searched for. \\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em mca\+\_\+allocator\+\_\+base\+\_\+component\+\_\+t$\ast$} & pointer to the requested component \\
\hline
{\em N\+U\+L\+L} & if the requested component is not found \\
\hline
\end{DoxyRetVals}


References mca\+\_\+allocator\+\_\+base\+\_\+component\+\_\+2\+\_\+0\+\_\+0\+\_\+t\+::allocator\+\_\+version, mca\+\_\+base\+\_\+component\+\_\+2\+\_\+0\+\_\+0\+\_\+t\+::mca\+\_\+component\+\_\+name, opal\+\_\+list\+\_\+get\+\_\+end(), opal\+\_\+list\+\_\+get\+\_\+first(), and opal\+\_\+list\+\_\+get\+\_\+next.

