rendezvous_8h.tex

在DM6446上实现了编码和解码功能

\hypertarget{rendezvous_8h}{
\subsection{rendezvous.h File Reference}
\label{rendezvous_8h}\index{rendezvous.h@{rendezvous.h}}
}


\subsubsection{Detailed Description}
This interface enables multiple threads to do their initialization in paralell before meeting up and start the main processing loops. 



\footnotesize\begin{verbatim}
 * ============================================================================
 * Copyright (c) Texas Instruments Inc 2007
 *
 * Use of this software is controlled by the terms and conditions found in the
 * license agreement under which this software has been supplied or provided.
 * ============================================================================
 * \end{verbatim}
\normalsize
 

Definition in file \hyperlink{rendezvous_8h-source}{rendezvous.h}.

{\tt \#include $<$pthread.h$>$}\par


Include dependency graph for rendezvous.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=98pt]{rendezvous_8h__incl}
\end{center}
\end{figure}
\subsubsection*{Data Structures}
\begin{CompactItemize}
\item 
struct \hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Obj}
\begin{CompactList}\small\item\em Object that stores the state. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Defines}
\begin{CompactItemize}
\item 
\#define \hyperlink{rendezvous_8h_74d7e929385b68fd353882b52073ac85}{RENDEZVOUS\_\-SUCCESS}~0
\begin{CompactList}\small\item\em Indicates that a Rendezvous API call completed successfully. \item\end{CompactList}\item 
\#define \hyperlink{rendezvous_8h_2e2073664f382e1da7e5217773ee5e72}{RENDEZVOUS\_\-FAILURE}~-1
\begin{CompactList}\small\item\em Indicates that a Rendezvous API call failed. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef \hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Obj} $\ast$ \hyperlink{rendezvous_8h_52cd4bd2c079ee8993508133c2171883}{Rendezvous\_\-Handle}
\begin{CompactList}\small\item\em Pointer to a rendezvous object. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Functions}
\begin{CompactItemize}
\item 
static void \hyperlink{rendezvous_8h_85a28a129245d5bce4dd474296dac81a}{Rendezvous\_\-open} (\hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Handle} h\-Rv, int count)
\begin{CompactList}\small\item\em Opens the Rendezvous object. Must be called before other API:s on a Rendezvous object. \item\end{CompactList}\item 
static void \hyperlink{rendezvous_8h_947044a2dfe1d3a12245e8db3a977ea4}{Rendezvous\_\-meet} (\hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Handle} h\-Rv)
\begin{CompactList}\small\item\em Called by a thread when it's initialization is done. This will register that this thread is done initializing, and will block the calling thread until the other threads are done initializing, after which all threads will be unblocked at once. \item\end{CompactList}\item 
static void \hyperlink{rendezvous_8h_09972ee7681b8a7c6b45f8d776a1314c}{Rendezvous\_\-force} (\hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Handle} h\-Rv)
\begin{CompactList}\small\item\em This call forces all threads blocking in Rendezvous\_\-meet to unblock no matter what the state of the Rendezvous object. Useful for error cleanup. \item\end{CompactList}\item 
static void \hyperlink{rendezvous_8h_1107ee752d0c312bac4aa8b36b32f7eb}{Rendezvous\_\-reset} (\hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Handle} h\-Rv)
\begin{CompactList}\small\item\em This call resets the Rendezvous object to it's original count at opening time. \item\end{CompactList}\item 
static void \hyperlink{rendezvous_8h_f39ff7c2547af4748c87ed73a6ed8ad9}{Rendezvous\_\-close} (\hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Handle} h\-Rv)
\begin{CompactList}\small\item\em Closes a previously opened Rendezvous object. \item\end{CompactList}\end{CompactItemize}


\subsubsection{Define Documentation}
\hypertarget{rendezvous_8h_74d7e929385b68fd353882b52073ac85}{
\index{rendezvous.h@{rendezvous.h}!RENDEZVOUS_SUCCESS@{RENDEZVOUS\_\-SUCCESS}}
\index{RENDEZVOUS_SUCCESS@{RENDEZVOUS\_\-SUCCESS}!rendezvous.h@{rendezvous.h}}
\paragraph[RENDEZVOUS\_\-SUCCESS]{\setlength{\rightskip}{0pt plus 5cm}\#define RENDEZVOUS\_\-SUCCESS~0}\hfill}
\label{rendezvous_8h_74d7e929385b68fd353882b52073ac85}


Indicates that a Rendezvous API call completed successfully. 



Definition at line 41 of file rendezvous.h.\hypertarget{rendezvous_8h_2e2073664f382e1da7e5217773ee5e72}{
\index{rendezvous.h@{rendezvous.h}!RENDEZVOUS_FAILURE@{RENDEZVOUS\_\-FAILURE}}
\index{RENDEZVOUS_FAILURE@{RENDEZVOUS\_\-FAILURE}!rendezvous.h@{rendezvous.h}}
\paragraph[RENDEZVOUS\_\-FAILURE]{\setlength{\rightskip}{0pt plus 5cm}\#define RENDEZVOUS\_\-FAILURE~-1}\hfill}
\label{rendezvous_8h_2e2073664f382e1da7e5217773ee5e72}


Indicates that a Rendezvous API call failed. 



Definition at line 46 of file rendezvous.h.

\subsubsection{Typedef Documentation}
\hypertarget{rendezvous_8h_52cd4bd2c079ee8993508133c2171883}{
\index{rendezvous.h@{rendezvous.h}!Rendezvous_Handle@{Rendezvous\_\-Handle}}
\index{Rendezvous_Handle@{Rendezvous\_\-Handle}!rendezvous.h@{rendezvous.h}}
\paragraph[Rendezvous\_\-Handle]{\setlength{\rightskip}{0pt plus 5cm}typedef \hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Obj}$\ast$ \hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Handle}}\hfill}
\label{rendezvous_8h_52cd4bd2c079ee8993508133c2171883}


Pointer to a rendezvous object. 



Definition at line 36 of file rendezvous.h.

\subsubsection{Function Documentation}
\hypertarget{rendezvous_8h_85a28a129245d5bce4dd474296dac81a}{
\index{rendezvous.h@{rendezvous.h}!Rendezvous_open@{Rendezvous\_\-open}}
\index{Rendezvous_open@{Rendezvous\_\-open}!rendezvous.h@{rendezvous.h}}
\paragraph[Rendezvous\_\-open]{\setlength{\rightskip}{0pt plus 5cm}static void Rendezvous\_\-open (\hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Handle} {\em h\-Rv}, int {\em count})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}\hfill}
\label{rendezvous_8h_85a28a129245d5bce4dd474296dac81a}


Opens the Rendezvous object. Must be called before other API:s on a Rendezvous object. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em h\-Rv}]Pointer to the rendezvous object to open. \item[{\em count}]Number of threads to synchronize initialization for. \end{description}
\end{Desc}


Definition at line 54 of file rendezvous.h.

References Rendezvous\_\-Obj::cond, Rendezvous\_\-Obj::count, Rendezvous\_\-Obj::mutex, and Rendezvous\_\-Obj::orig.\hypertarget{rendezvous_8h_947044a2dfe1d3a12245e8db3a977ea4}{
\index{rendezvous.h@{rendezvous.h}!Rendezvous_meet@{Rendezvous\_\-meet}}
\index{Rendezvous_meet@{Rendezvous\_\-meet}!rendezvous.h@{rendezvous.h}}
\paragraph[Rendezvous\_\-meet]{\setlength{\rightskip}{0pt plus 5cm}static void Rendezvous\_\-meet (\hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Handle} {\em h\-Rv})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}\hfill}
\label{rendezvous_8h_947044a2dfe1d3a12245e8db3a977ea4}


Called by a thread when it's initialization is done. This will register that this thread is done initializing, and will block the calling thread until the other threads are done initializing, after which all threads will be unblocked at once. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em h\-Rv}]Pointer to a previously opened Rendezvous object. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]RENDEZVOUS\_\-SUCCESS for success or RENDEZVOUS\_\-FAILURE for failure. \end{Desc}


Definition at line 71 of file rendezvous.h.

References Rendezvous\_\-Obj::cond, Rendezvous\_\-Obj::count, and Rendezvous\_\-Obj::mutex.\hypertarget{rendezvous_8h_09972ee7681b8a7c6b45f8d776a1314c}{
\index{rendezvous.h@{rendezvous.h}!Rendezvous_force@{Rendezvous\_\-force}}
\index{Rendezvous_force@{Rendezvous\_\-force}!rendezvous.h@{rendezvous.h}}
\paragraph[Rendezvous\_\-force]{\setlength{\rightskip}{0pt plus 5cm}static void Rendezvous\_\-force (\hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Handle} {\em h\-Rv})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}\hfill}
\label{rendezvous_8h_09972ee7681b8a7c6b45f8d776a1314c}


This call forces all threads blocking in Rendezvous\_\-meet to unblock no matter what the state of the Rendezvous object. Useful for error cleanup. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em h\-Rv}]Pointer to a previously opened Rendezvous object. \end{description}
\end{Desc}


Definition at line 91 of file rendezvous.h.

References Rendezvous\_\-Obj::cond, Rendezvous\_\-Obj::count, and Rendezvous\_\-Obj::mutex.\hypertarget{rendezvous_8h_1107ee752d0c312bac4aa8b36b32f7eb}{
\index{rendezvous.h@{rendezvous.h}!Rendezvous_reset@{Rendezvous\_\-reset}}
\index{Rendezvous_reset@{Rendezvous\_\-reset}!rendezvous.h@{rendezvous.h}}
\paragraph[Rendezvous\_\-reset]{\setlength{\rightskip}{0pt plus 5cm}static void Rendezvous\_\-reset (\hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Handle} {\em h\-Rv})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}\hfill}
\label{rendezvous_8h_1107ee752d0c312bac4aa8b36b32f7eb}


This call resets the Rendezvous object to it's original count at opening time. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em h\-Rv}]Pointer to a previously opened Rendezvous object. \end{description}
\end{Desc}


Definition at line 104 of file rendezvous.h.

References Rendezvous\_\-Obj::count, Rendezvous\_\-Obj::mutex, and Rendezvous\_\-Obj::orig.\hypertarget{rendezvous_8h_f39ff7c2547af4748c87ed73a6ed8ad9}{
\index{rendezvous.h@{rendezvous.h}!Rendezvous_close@{Rendezvous\_\-close}}
\index{Rendezvous_close@{Rendezvous\_\-close}!rendezvous.h@{rendezvous.h}}
\paragraph[Rendezvous\_\-close]{\setlength{\rightskip}{0pt plus 5cm}static void Rendezvous\_\-close (\hyperlink{struct_rendezvous___obj}{Rendezvous\_\-Handle} {\em h\-Rv})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}\hfill}
\label{rendezvous_8h_f39ff7c2547af4748c87ed73a6ed8ad9}


Closes a previously opened Rendezvous object. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em h\-Rv}]Pointer to the rendezvous object to close. \end{description}
\end{Desc}


Definition at line 115 of file rendezvous.h.

References Rendezvous\_\-Obj::cond, and Rendezvous\_\-Obj::mutex.