\section{cirbuf Struct Reference}
\label{structcirbuf}\index{cirbuf@{cirbuf}}
{\tt \#include $<$cirbuf.h$>$}

\subsection*{Data Fields}
\begin{CompactItemize}
\item 
{\bf cirbuf\_\-uint} {\bf maxlen}
\item 
volatile {\bf cirbuf\_\-uint} {\bf start}
\item 
volatile {\bf cirbuf\_\-uint} {\bf end}
\item 
volatile {\bf cirbuf\_\-uint} {\bf len}
\item 
char $\ast$ {\bf buf}
\end{CompactItemize}


\subsection{Detailed Description}
This structure is the header of a \doxyref{cirbuf}{p.}{structcirbuf} type. 

Definition at line 50 of file cirbuf.h.

\subsection{Field Documentation}
\index{cirbuf@{cirbuf}!maxlen@{maxlen}}
\index{maxlen@{maxlen}!cirbuf@{cirbuf}}
\subsubsection[maxlen]{\setlength{\rightskip}{0pt plus 5cm}{\bf cirbuf\_\-uint} {\bf cirbuf::maxlen}}\label{structcirbuf_629995e389f170240751a38c8e03f092}


total len of the fifo (number of elements) 

Definition at line 51 of file cirbuf.h.

Referenced by cirbuf\_\-add\_\-buf\_\-head(), cirbuf\_\-add\_\-buf\_\-tail(), cirbuf\_\-align\_\-left(), cirbuf\_\-align\_\-right(), cirbuf\_\-del\_\-buf\_\-head(), cirbuf\_\-del\_\-buf\_\-tail(), cirbuf\_\-get\_\-buf\_\-head(), cirbuf\_\-get\_\-buf\_\-tail(), and cirbuf\_\-init().\index{cirbuf@{cirbuf}!start@{start}}
\index{start@{start}!cirbuf@{cirbuf}}
\subsubsection[start]{\setlength{\rightskip}{0pt plus 5cm}volatile {\bf cirbuf\_\-uint} {\bf cirbuf::start}}\label{structcirbuf_61df0dbd257611ae3fb2c5675a12c2f3}


indice of the first elt 

Definition at line 52 of file cirbuf.h.

Referenced by cirbuf\_\-add\_\-buf\_\-head(), cirbuf\_\-align\_\-left(), cirbuf\_\-align\_\-right(), cirbuf\_\-del\_\-buf\_\-head(), cirbuf\_\-get\_\-buf\_\-head(), cirbuf\_\-get\_\-buf\_\-tail(), cirbuf\_\-get\_\-head(), and cirbuf\_\-init().\index{cirbuf@{cirbuf}!end@{end}}
\index{end@{end}!cirbuf@{cirbuf}}
\subsubsection[end]{\setlength{\rightskip}{0pt plus 5cm}volatile {\bf cirbuf\_\-uint} {\bf cirbuf::end}}\label{structcirbuf_1c330df8e903a58bd6e8b60c1a019279}


indice of the last elt 

Definition at line 53 of file cirbuf.h.

Referenced by cirbuf\_\-add\_\-buf\_\-tail(), cirbuf\_\-align\_\-right(), cirbuf\_\-del\_\-buf\_\-tail(), cirbuf\_\-get\_\-buf\_\-head(), cirbuf\_\-get\_\-buf\_\-tail(), cirbuf\_\-get\_\-tail(), and cirbuf\_\-init().\index{cirbuf@{cirbuf}!len@{len}}
\index{len@{len}!cirbuf@{cirbuf}}
\subsubsection[len]{\setlength{\rightskip}{0pt plus 5cm}volatile {\bf cirbuf\_\-uint} {\bf cirbuf::len}}\label{structcirbuf_9495cc710150537a3b3e6195dcbb00ab}


current len of fifo 

Definition at line 54 of file cirbuf.h.

Referenced by cirbuf\_\-add\_\-buf\_\-head(), cirbuf\_\-add\_\-buf\_\-tail(), cirbuf\_\-del\_\-buf\_\-head(), cirbuf\_\-del\_\-buf\_\-tail(), and cirbuf\_\-init().\index{cirbuf@{cirbuf}!buf@{buf}}
\index{buf@{buf}!cirbuf@{cirbuf}}
\subsubsection[buf]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ {\bf cirbuf::buf}}\label{structcirbuf_941abd2ea3f939dd7d4b9f425b978e08}




Definition at line 55 of file cirbuf.h.

Referenced by cirbuf\_\-add\_\-buf\_\-head(), cirbuf\_\-add\_\-buf\_\-tail(), cirbuf\_\-get\_\-buf\_\-head(), cirbuf\_\-get\_\-buf\_\-tail(), cirbuf\_\-get\_\-head(), cirbuf\_\-get\_\-tail(), and cirbuf\_\-init().

The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item 
aversive\_\-10-03-12/modules/base/cirbuf/{\bf cirbuf.h}\end{CompactItemize}
