\hypertarget{class_qore_1_1_binary_input_stream}{}\section{Qore\+::Binary\+Input\+Stream Class Reference}
\label{class_qore_1_1_binary_input_stream}\index{Qore::BinaryInputStream@{Qore::BinaryInputStream}}


This class implements the \mbox{\hyperlink{class_qore_1_1_input_stream}{Input\+Stream}} interface for reading bytes from a \mbox{\hyperlink{basic_data_types_binary}{Binary}} variable.  




Inheritance diagram for Qore\+::Binary\+Input\+Stream\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=217pt]{class_qore_1_1_binary_input_stream__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_qore_1_1_binary_input_stream_aa9286e4b37edf0c8e7981d26f31c2a95}{constructor}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} src)
\begin{DoxyCompactList}\small\item\em Creates the \mbox{\hyperlink{class_qore_1_1_binary_input_stream}{Binary\+Input\+Stream}} based on the \mbox{\hyperlink{basic_data_types_binary}{Binary}} given. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{class_qore_1_1_binary_input_stream_af7f129b397b9b41479874b2dd0db8a8d}{peek}} ()
\begin{DoxyCompactList}\small\item\em Peeks the next byte available from the input stream; returns -\/1 if no more data available. \end{DoxyCompactList}\item 
\+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} \mbox{\hyperlink{class_qore_1_1_binary_input_stream_a8efc82cb091d29d856d638170fb046c0}{read}} (\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} limit)
\begin{DoxyCompactList}\small\item\em Reads bytes (up to a specified limit) from the input stream; returns \mbox{\hyperlink{group__null__and__nothing__constants_ga756badc783adcd6a850808b928e21af4}{N\+O\+T\+H\+I\+NG}} if there are no more bytes in the stream. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
This class implements the \mbox{\hyperlink{class_qore_1_1_input_stream}{Input\+Stream}} interface for reading bytes from a \mbox{\hyperlink{basic_data_types_binary}{Binary}} variable. 

\begin{DoxyParagraph}{Example\+: Binary\+Input\+Stream basic usage}

\begin{DoxyCode}{0}
\DoxyCodeLine{binary src = <2AFF04>;}
\DoxyCodeLine{BinaryInputStream bis(src);}
\DoxyCodeLine{*binary b;}
\DoxyCodeLine{\textcolor{keywordflow}{while} (b = bis.read(2)) \{}
\DoxyCodeLine{    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"read \%d\(\backslash\)n"}, \mbox{\hyperlink{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}{make\_hex\_string}}(b));}
\DoxyCodeLine{\}}
\DoxyCodeLine{}
\DoxyCodeLine{read 2AFF}
\DoxyCodeLine{read 04}
\end{DoxyCode}

\end{DoxyParagraph}
\begin{DoxyNote}{Note}
stream classes are not designed to be accessed from multiple threads; they have been implemented without locking for fast and efficient use when used from a single thread. For methods that would be unsafe to use in another thread, any use of such methods in threads other than the thread where the constructor was called will cause a {\ttfamily S\+T\+R\+E\+A\+M-\/\+T\+H\+R\+E\+A\+D-\/\+E\+R\+R\+OR} to be thrown, unless the stream is handed off to another thread using the \mbox{\hyperlink{class_qore_1_1_stream_base_a017fc847a42d5c670cb9640a94522666}{Stream\+Base\+::unassign\+Thread()}} method in the thread that currently owns the stream, and the \mbox{\hyperlink{class_qore_1_1_stream_base_ab6b33cb1944c46aca8e9984ddfd65452}{Stream\+Base\+::reassign\+Thread()}} method in the new thread.
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{class_qore_1_1_stream_reader}{Stream\+Reader}} for a class that can be used to \mbox{\hyperlink{class_qore_1_1_binary_input_stream_a8efc82cb091d29d856d638170fb046c0}{read}} various kinds of data from an \mbox{\hyperlink{class_qore_1_1_input_stream}{Input\+Stream}}
\end{DoxySeeAlso}
\begin{DoxySince}{Since}
Qore 0.\+8.\+13 
\end{DoxySince}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_qore_1_1_binary_input_stream_aa9286e4b37edf0c8e7981d26f31c2a95}\label{class_qore_1_1_binary_input_stream_aa9286e4b37edf0c8e7981d26f31c2a95}} 
\index{Qore::BinaryInputStream@{Qore::BinaryInputStream}!constructor@{constructor}}
\index{constructor@{constructor}!Qore::BinaryInputStream@{Qore::BinaryInputStream}}
\subsubsection{\texorpdfstring{constructor()}{constructor()}}
{\footnotesize\ttfamily Qore\+::\+Binary\+Input\+Stream\+::constructor (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{src }\end{DoxyParamCaption})}



Creates the \mbox{\hyperlink{class_qore_1_1_binary_input_stream}{Binary\+Input\+Stream}} based on the \mbox{\hyperlink{basic_data_types_binary}{Binary}} given. 


\begin{DoxyParams}{Parameters}
{\em src} & the \mbox{\hyperlink{basic_data_types_binary}{Binary}} to read bytes from \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_qore_1_1_binary_input_stream_af7f129b397b9b41479874b2dd0db8a8d}\label{class_qore_1_1_binary_input_stream_af7f129b397b9b41479874b2dd0db8a8d}} 
\index{Qore::BinaryInputStream@{Qore::BinaryInputStream}!peek@{peek}}
\index{peek@{peek}!Qore::BinaryInputStream@{Qore::BinaryInputStream}}
\subsubsection{\texorpdfstring{peek()}{peek()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::\+Binary\+Input\+Stream\+::peek (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Peeks the next byte available from the input stream; returns -\/1 if no more data available. 

\begin{DoxyReturn}{Returns}
the next byte available from the input stream or -\/1 if no more data is available
\end{DoxyReturn}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}{0}
\DoxyCodeLine{binary src = <2AFF04>;}
\DoxyCodeLine{BinaryInputStream is(src);}
\DoxyCodeLine{\mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"peek: \%d\(\backslash\)n"}, is.peek());}
\DoxyCodeLine{*binary b = is.read(3);}
\DoxyCodeLine{\mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"peek: \%d\(\backslash\)n"}, is.peek());}
\DoxyCodeLine{}
\DoxyCodeLine{peek 42}
\DoxyCodeLine{peek -1}
\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em S\+T\+R\+E\+A\+M-\/\+T\+H\+R\+E\+A\+D-\/\+E\+R\+R\+OR} & this exception is thrown if this method is called from any thread other than the thread that created the object \\
\hline
\end{DoxyExceptions}


Implements \mbox{\hyperlink{class_qore_1_1_input_stream_a165db4108c3a1f4bbb6b619972fd131c}{Qore\+::\+Input\+Stream}}.

\mbox{\Hypertarget{class_qore_1_1_binary_input_stream_a8efc82cb091d29d856d638170fb046c0}\label{class_qore_1_1_binary_input_stream_a8efc82cb091d29d856d638170fb046c0}} 
\index{Qore::BinaryInputStream@{Qore::BinaryInputStream}!read@{read}}
\index{read@{read}!Qore::BinaryInputStream@{Qore::BinaryInputStream}}
\subsubsection{\texorpdfstring{read()}{read()}}
{\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} Qore\+::\+Binary\+Input\+Stream\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}}}]{limit }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reads bytes (up to a specified limit) from the input stream; returns \mbox{\hyperlink{group__null__and__nothing__constants_ga756badc783adcd6a850808b928e21af4}{N\+O\+T\+H\+I\+NG}} if there are no more bytes in the stream. 


\begin{DoxyParams}{Parameters}
{\em limit} & the maximum number of bytes to read \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the read bytes (the length is between 1 and \`{}limit\`{} inclusive) or \mbox{\hyperlink{group__null__and__nothing__constants_ga756badc783adcd6a850808b928e21af4}{N\+O\+T\+H\+I\+NG}} if no more bytes are available
\end{DoxyReturn}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}{0}
\DoxyCodeLine{binary src = <2AFF04>;}
\DoxyCodeLine{BinaryInputStream is(src);}
\DoxyCodeLine{*binary b;}
\DoxyCodeLine{\textcolor{keywordflow}{while} (b = is.read(2)) \{}
\DoxyCodeLine{    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"read \%s\(\backslash\)n"}, \mbox{\hyperlink{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}{make\_hex\_string}}(b));}
\DoxyCodeLine{\}}
\DoxyCodeLine{}
\DoxyCodeLine{read 2aff}
\DoxyCodeLine{read 04}
\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em I\+N\+P\+U\+T-\/\+S\+T\+R\+E\+A\+M-\/\+E\+R\+R\+OR} & {\itshape limit} is not positive \\
\hline
{\em S\+T\+R\+E\+A\+M-\/\+T\+H\+R\+E\+A\+D-\/\+E\+R\+R\+OR} & this exception is thrown if this method is called from any thread other than the thread that created the object \\
\hline
\end{DoxyExceptions}


Implements \mbox{\hyperlink{class_qore_1_1_input_stream_a74ba0bc85bb86988a0f8b3255d1dbf01}{Qore\+::\+Input\+Stream}}.

