\hypertarget{OTF__RStream_8h}{\section{ompi/contrib/vt/vt/extlib/otf/otflib/\+O\+T\+F\+\_\+\+R\+Stream.h File Reference}
\label{OTF__RStream_8h}\index{ompi/contrib/vt/vt/extlib/otf/otflib/\+O\+T\+F\+\_\+\+R\+Stream.\+h@{ompi/contrib/vt/vt/extlib/otf/otflib/\+O\+T\+F\+\_\+\+R\+Stream.\+h}}
}


Provides read access to trace streams, which consist of multiple buffers.  


{\ttfamily \#include $<$stdlib.\+h$>$}\\*
{\ttfamily \#include $<$string.\+h$>$}\\*
{\ttfamily \#include $<$stdio.\+h$>$}\\*
{\ttfamily \#include \char`\"{}O\+T\+F\+\_\+inttypes.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}O\+T\+F\+\_\+\+File\+Manager.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}O\+T\+F\+\_\+\+R\+Buffer.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}O\+T\+F\+\_\+\+Filenames.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}O\+T\+F\+\_\+\+Handler\+Array.\+h\char`\"{}}\\*
\subsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structstruct__OTF__RStream}{struct\+\_\+\+O\+T\+F\+\_\+\+R\+Stream}
\end{DoxyCompactItemize}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
\hypertarget{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{typedef struct \hyperlink{structstruct__OTF__RStream}{struct\+\_\+\+O\+T\+F\+\_\+\+R\+Stream} \hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream}}\label{group__rstream_ga49ebb89cbfba57c1191d09210e353771}

\begin{DoxyCompactList}\small\item\em rstream object \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$ \hyperlink{group__rstream_gab4d7a66eb0c1bec13b3c8a94503a1192}{O\+T\+F\+\_\+\+R\+Stream\+\_\+open} (const char $\ast$name\+Stub, uint32\+\_\+t id, \hyperlink{group__fm_ga621c18447ec33f803cc270a9494b0685}{O\+T\+F\+\_\+\+File\+Manager} $\ast$manager)
\begin{DoxyCompactList}\small\item\em Create a new O\+T\+F\+\_\+\+R\+Stream instance. \end{DoxyCompactList}\item 
int \hyperlink{group__rstream_ga676bd8cc97af56bfe4c06c1d081202c5}{O\+T\+F\+\_\+\+R\+Stream\+\_\+close} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Close an O\+T\+F\+\_\+\+R\+Stream instance and all its related files. \end{DoxyCompactList}\item 
\hyperlink{structstruct__OTF__RBuffer}{O\+T\+F\+\_\+\+R\+Buffer} $\ast$ \hyperlink{group__rstream_ga22f3bb0bc274c984214c346c34bd7df2}{O\+T\+F\+\_\+\+R\+Stream\+\_\+get\+Def\+Buffer} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Returns the definition buffer of the according reader stream. \end{DoxyCompactList}\item 
\hyperlink{structstruct__OTF__RBuffer}{O\+T\+F\+\_\+\+R\+Buffer} $\ast$ \hyperlink{group__rstream_gad67350756e0b267a1a3d9ff1222c2dfe}{O\+T\+F\+\_\+\+R\+Stream\+\_\+set\+Def\+Buffer} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, \hyperlink{structstruct__OTF__RBuffer}{O\+T\+F\+\_\+\+R\+Buffer} $\ast$rbuffer)
\begin{DoxyCompactList}\small\item\em Forces the given definition buffer to the according reader stream. \end{DoxyCompactList}\item 
int \hyperlink{group__rstream_gaa1f0c839f015111a0d9558e0814eadb0}{O\+T\+F\+\_\+\+R\+Stream\+\_\+close\+Def\+Buffer} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Closes the stream definition buffer. \end{DoxyCompactList}\item 
\hyperlink{structstruct__OTF__RBuffer}{O\+T\+F\+\_\+\+R\+Buffer} $\ast$ \hyperlink{group__rstream_ga636ef44491a4aecf182c0411dbe71b5a}{O\+T\+F\+\_\+\+R\+Stream\+\_\+get\+Event\+Buffer} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Returns the event buffer of the according reader stream. \end{DoxyCompactList}\item 
int \hyperlink{group__rstream_ga5a1e34dd3823686adfc183fc4cef558f}{O\+T\+F\+\_\+\+R\+Stream\+\_\+close\+Event\+Buffer} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Closes the stream event buffer. \end{DoxyCompactList}\item 
\hyperlink{structstruct__OTF__RBuffer}{O\+T\+F\+\_\+\+R\+Buffer} $\ast$ \hyperlink{group__rstream_gaebe22f25a86375912c4db4e90d7cf1bd}{O\+T\+F\+\_\+\+R\+Stream\+\_\+get\+Snaps\+Buffer} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Returns the snapshots buffer of the according reader stream. \end{DoxyCompactList}\item 
int \hyperlink{group__rstream_ga1a28b1808896c218490da323c3eb9682}{O\+T\+F\+\_\+\+R\+Stream\+\_\+close\+Snaps\+Buffer} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Closes the stream snapshots buffer. \end{DoxyCompactList}\item 
\hyperlink{structstruct__OTF__RBuffer}{O\+T\+F\+\_\+\+R\+Buffer} $\ast$ \hyperlink{group__rstream_ga8e5bc3bca86fcab4197976d40824777f}{O\+T\+F\+\_\+\+R\+Stream\+\_\+get\+Stats\+Buffer} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Returns the statistics buffer of the according reader stream. \end{DoxyCompactList}\item 
int \hyperlink{group__rstream_ga632157507d70e5e585fcedcee57b72ec}{O\+T\+F\+\_\+\+R\+Stream\+\_\+close\+Stats\+Buffer} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Closes the stream statistics buffer. \end{DoxyCompactList}\item 
\hyperlink{structstruct__OTF__RBuffer}{O\+T\+F\+\_\+\+R\+Buffer} $\ast$ \hyperlink{group__rstream_ga39200e51cf9634d456ea6bd740ad0683}{O\+T\+F\+\_\+\+R\+Stream\+\_\+get\+Marker\+Buffer} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Returns the marker buffer of the according reader stream. \end{DoxyCompactList}\item 
int \hyperlink{group__rstream_ga6ba457d601341c30ba9c31ffad73cb63}{O\+T\+F\+\_\+\+R\+Stream\+\_\+close\+Marker\+Buffer} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Closes the stream marker buffer. \end{DoxyCompactList}\item 
void \hyperlink{group__rstream_ga25964919108452ab9b8ec93de4075a8a}{O\+T\+F\+\_\+\+R\+Stream\+\_\+set\+Buffer\+Sizes} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint32\+\_\+t size)
\begin{DoxyCompactList}\small\item\em Set the default buffer size for all buffers managed by this reader stream. \end{DoxyCompactList}\item 
uint32\+\_\+t \hyperlink{group__rstream_ga898905014217f6637eb89d05f7ee0c76}{O\+T\+F\+\_\+\+R\+Stream\+\_\+get\+Buffer\+Sizes} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Get the default buffer size for all buffers managed by this reader stream. \end{DoxyCompactList}\item 
void \hyperlink{group__rstream_ga20a788b3102af11860fa9aac92f7d47f}{O\+T\+F\+\_\+\+R\+Stream\+\_\+set\+Z\+Buffer\+Sizes} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint32\+\_\+t size)
\begin{DoxyCompactList}\small\item\em Set the default zbuffer size for all files managed by this reader stream. \end{DoxyCompactList}\item 
uint32\+\_\+t \hyperlink{group__rstream_gae54283534f51598864c681f68ac9a556}{O\+T\+F\+\_\+\+R\+Stream\+\_\+get\+Z\+Buffer\+Sizes} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Get the default zbuffer size for all files managed by this reader stream. \end{DoxyCompactList}\item 
void \hyperlink{group__rstream_ga3171a4e82be47c8129024504dbad14ea}{O\+T\+F\+\_\+\+R\+Stream\+\_\+set\+Record\+Limit} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint64\+\_\+t limit)
\begin{DoxyCompactList}\small\item\em Sets the maximum number of records delivered by a single call to O\+T\+F\+\_\+\+R\+Stream\+\_\+read\+X\+Y\+Z(). \end{DoxyCompactList}\item 
uint64\+\_\+t \hyperlink{group__rstream_gae97340bed536aa60c9966d66fcba1dfb}{O\+T\+F\+\_\+\+R\+Stream\+\_\+get\+Record\+Limit} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream)
\begin{DoxyCompactList}\small\item\em Returns the current record limit. \end{DoxyCompactList}\item 
uint64\+\_\+t \hyperlink{group__rstream_gae107476b480731bc8ed99209f2aa7838}{O\+T\+F\+\_\+\+R\+Stream\+\_\+read\+Definitions} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, \hyperlink{group__ha_ga25c9228aeaddda3577266eab8a986b27}{O\+T\+F\+\_\+\+Handler\+Array} $\ast$handlers)
\begin{DoxyCompactList}\small\item\em Reads all definitions from the stream. \end{DoxyCompactList}\item 
uint64\+\_\+t \hyperlink{group__rstream_ga23ac8c46c797510749535c5f2991d233}{O\+T\+F\+\_\+\+R\+Stream\+\_\+read\+Events} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, \hyperlink{group__ha_ga25c9228aeaddda3577266eab8a986b27}{O\+T\+F\+\_\+\+Handler\+Array} $\ast$handlers)
\begin{DoxyCompactList}\small\item\em Reads all events from the stream and calls the appropriated handler sorted by time. \end{DoxyCompactList}\item 
uint64\+\_\+t \hyperlink{group__rstream_ga7fedd69f9a05cb908c154ec92550b40a}{O\+T\+F\+\_\+\+R\+Stream\+\_\+read\+Snapshots} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, \hyperlink{group__ha_ga25c9228aeaddda3577266eab8a986b27}{O\+T\+F\+\_\+\+Handler\+Array} $\ast$handlers)
\begin{DoxyCompactList}\small\item\em Reads all snapshots from the stream. \end{DoxyCompactList}\item 
uint64\+\_\+t \hyperlink{group__rstream_ga544ffbec6d6c5224782080cd7cfefe8a}{O\+T\+F\+\_\+\+R\+Stream\+\_\+read\+Statistics} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, \hyperlink{group__ha_ga25c9228aeaddda3577266eab8a986b27}{O\+T\+F\+\_\+\+Handler\+Array} $\ast$handlers)
\begin{DoxyCompactList}\small\item\em Reads all statistics from the stream. \end{DoxyCompactList}\item 
uint64\+\_\+t \hyperlink{group__rstream_ga97e8c6a6f324e11d10dfbb4d91979f6c}{O\+T\+F\+\_\+\+R\+Stream\+\_\+read\+Marker} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, \hyperlink{group__ha_ga25c9228aeaddda3577266eab8a986b27}{O\+T\+F\+\_\+\+Handler\+Array} $\ast$handlers)
\begin{DoxyCompactList}\small\item\em Reads all markers from the stream. \end{DoxyCompactList}\item 
uint8\+\_\+t \hyperlink{group__rstream_gab431c685abea8d7b66020ef4306e8dd4}{O\+T\+F\+\_\+\+R\+Stream\+\_\+event\+Progress} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint64\+\_\+t $\ast$minimum, uint64\+\_\+t $\ast$current, uint64\+\_\+t $\ast$maximum)
\begin{DoxyCompactList}\small\item\em depricated. \end{DoxyCompactList}\item 
uint8\+\_\+t \hyperlink{group__rstream_gae3279096459a9dc575f61fa45bd8d216}{O\+T\+F\+\_\+\+R\+Stream\+\_\+snapshot\+Progress} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint64\+\_\+t $\ast$minimum, uint64\+\_\+t $\ast$current, uint64\+\_\+t $\ast$maximum)
\begin{DoxyCompactList}\small\item\em depricated. \end{DoxyCompactList}\item 
uint8\+\_\+t \hyperlink{group__rstream_gaa8ec131acf5fbd99e5facc2a25a8e562}{O\+T\+F\+\_\+\+R\+Stream\+\_\+statistic\+Progress} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint64\+\_\+t $\ast$minimum, uint64\+\_\+t $\ast$current, uint64\+\_\+t $\ast$maximum)
\begin{DoxyCompactList}\small\item\em depricated. \end{DoxyCompactList}\item 
uint8\+\_\+t \hyperlink{group__rstream_gab28fedd2bf3255f525082350ef5541d1}{O\+T\+F\+\_\+\+R\+Stream\+\_\+event\+Time\+Progress} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint64\+\_\+t $\ast$minimum, uint64\+\_\+t $\ast$current, uint64\+\_\+t $\ast$maximum)
\begin{DoxyCompactList}\small\item\em Delivers a progress report for reading events. \end{DoxyCompactList}\item 
uint8\+\_\+t \hyperlink{group__rstream_ga01c49c8fa847762a1bd5b5a1b05ae89d}{O\+T\+F\+\_\+\+R\+Stream\+\_\+snapshot\+Time\+Progress} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint64\+\_\+t $\ast$minimum, uint64\+\_\+t $\ast$current, uint64\+\_\+t $\ast$maximum)
\begin{DoxyCompactList}\small\item\em Delivers a progress report for reading snapshots. \end{DoxyCompactList}\item 
uint8\+\_\+t \hyperlink{group__rstream_gac2b5a5a9bcd55ec8a5a933af0e5e5702}{O\+T\+F\+\_\+\+R\+Stream\+\_\+statistic\+Time\+Progress} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint64\+\_\+t $\ast$minimum, uint64\+\_\+t $\ast$current, uint64\+\_\+t $\ast$maximum)
\begin{DoxyCompactList}\small\item\em Delivers a progress report for reading statistics. \end{DoxyCompactList}\item 
uint8\+\_\+t \hyperlink{group__rstream_ga637e654ff86ad4ec842142fbdfb1bc37}{O\+T\+F\+\_\+\+R\+Stream\+\_\+event\+Bytes\+Progress} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint64\+\_\+t $\ast$minimum, uint64\+\_\+t $\ast$current, uint64\+\_\+t $\ast$maximum)
\begin{DoxyCompactList}\small\item\em Delivers a progress report for reading events. \end{DoxyCompactList}\item 
uint8\+\_\+t \hyperlink{group__rstream_gaec8e71fb3b0420f77b9ac65e1b2d164d}{O\+T\+F\+\_\+\+R\+Stream\+\_\+snapshot\+Bytes\+Progress} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint64\+\_\+t $\ast$minimum, uint64\+\_\+t $\ast$current, uint64\+\_\+t $\ast$maximum)
\begin{DoxyCompactList}\small\item\em Delivers a progress report for reading snapshots. \end{DoxyCompactList}\item 
uint8\+\_\+t \hyperlink{group__rstream_ga74495242ae8c2f3a8c09f1c3ec217017}{O\+T\+F\+\_\+\+R\+Stream\+\_\+statistic\+Bytes\+Progress} (\hyperlink{group__rstream_ga49ebb89cbfba57c1191d09210e353771}{O\+T\+F\+\_\+\+R\+Stream} $\ast$rstream, uint64\+\_\+t $\ast$minimum, uint64\+\_\+t $\ast$current, uint64\+\_\+t $\ast$maximum)
\begin{DoxyCompactList}\small\item\em Delivers a progress report for reading statistics. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Provides read access to trace streams, which consist of multiple buffers. 

