\hypertarget{class_qore_1_1_binary_output_stream}{}\doxysection{Qore\+::Binary\+Output\+Stream Class Reference}
\label{class_qore_1_1_binary_output_stream}\index{Qore::BinaryOutputStream@{Qore::BinaryOutputStream}}


This class implements the \mbox{\hyperlink{class_qore_1_1_output_stream}{Output\+Stream}} interface for writing bytes to a \mbox{\hyperlink{basic_data_types_binary}{Binary}} buffer.  




Inheritance diagram for Qore\+::Binary\+Output\+Stream\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=226pt]{class_qore_1_1_binary_output_stream__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
nothing \mbox{\hyperlink{class_qore_1_1_binary_output_stream_a660343ffb7925b59d56d822d3e201092}{close}} ()
\begin{DoxyCompactList}\small\item\em Closes the output stream and releases any resources. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_qore_1_1_binary_output_stream_aa96c8329fc9c3ae03811c8c5638c6244}\label{class_qore_1_1_binary_output_stream_aa96c8329fc9c3ae03811c8c5638c6244}} 
\mbox{\hyperlink{class_qore_1_1_binary_output_stream_aa96c8329fc9c3ae03811c8c5638c6244}{constructor}} ()
\begin{DoxyCompactList}\small\item\em Creates the \mbox{\hyperlink{class_qore_1_1_binary_output_stream}{Binary\+Output\+Stream}}. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} \mbox{\hyperlink{class_qore_1_1_binary_output_stream_a2b6b7a9094ed574dbf8aa1ee21375272}{get\+Data}} ()
\begin{DoxyCompactList}\small\item\em Returns the data written to the stream, clearing the internal buffer. \end{DoxyCompactList}\item 
nothing \mbox{\hyperlink{class_qore_1_1_binary_output_stream_a3c73ee311cea8c73d7dc25c041fc98d4}{write}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} data)
\begin{DoxyCompactList}\small\item\em Writes bytes to the output stream. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
This class implements the \mbox{\hyperlink{class_qore_1_1_output_stream}{Output\+Stream}} interface for writing bytes to a \mbox{\hyperlink{basic_data_types_binary}{Binary}} buffer. 

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

\begin{DoxyCode}{0}
\DoxyCodeLine{BinaryOutputStream bos();}
\DoxyCodeLine{bos.write(<0405>);}
\DoxyCodeLine{bos.write(<06>);}
\DoxyCodeLine{bos.getData();      \textcolor{comment}{\# returns <040506>}}

\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 STREAM-\/\+THREAD-\/\+ERROR} 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_writer}{Stream\+Writer}} for a class that can be used to \mbox{\hyperlink{class_qore_1_1_binary_output_stream_a3c73ee311cea8c73d7dc25c041fc98d4}{write}} various kinds of data to an \mbox{\hyperlink{class_qore_1_1_output_stream}{Output\+Stream}}
\end{DoxySeeAlso}
\begin{DoxySince}{Since}
Qore 0.\+8.\+13 
\end{DoxySince}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_qore_1_1_binary_output_stream_a660343ffb7925b59d56d822d3e201092}\label{class_qore_1_1_binary_output_stream_a660343ffb7925b59d56d822d3e201092}} 
\index{Qore::BinaryOutputStream@{Qore::BinaryOutputStream}!close@{close}}
\index{close@{close}!Qore::BinaryOutputStream@{Qore::BinaryOutputStream}}
\doxysubsubsection{\texorpdfstring{close()}{close()}}
{\footnotesize\ttfamily nothing Qore\+::\+Binary\+Output\+Stream\+::close (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Closes the output stream and releases any resources. 

Any methods called on a closed output stream will throw an exception. 

Implements \mbox{\hyperlink{class_qore_1_1_output_stream_a2125e17612767b9636554b282638e883}{Qore\+::\+Output\+Stream}}.

\mbox{\Hypertarget{class_qore_1_1_binary_output_stream_a2b6b7a9094ed574dbf8aa1ee21375272}\label{class_qore_1_1_binary_output_stream_a2b6b7a9094ed574dbf8aa1ee21375272}} 
\index{Qore::BinaryOutputStream@{Qore::BinaryOutputStream}!getData@{getData}}
\index{getData@{getData}!Qore::BinaryOutputStream@{Qore::BinaryOutputStream}}
\doxysubsubsection{\texorpdfstring{getData()}{getData()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} Qore\+::\+Binary\+Output\+Stream\+::get\+Data (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns the data written to the stream, clearing the internal buffer. 

\begin{DoxyReturn}{Returns}
the data written to the \mbox{\hyperlink{class_qore_1_1_binary_output_stream}{Binary\+Output\+Stream}}
\end{DoxyReturn}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}{0}
\DoxyCodeLine{BinaryOutputStream bos();}
\DoxyCodeLine{bos.write(<0405>);}
\DoxyCodeLine{bos.write(<06>);}
\DoxyCodeLine{bos.getData();      \textcolor{comment}{\# returns <040506>}}

\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em OUTPUT-\/\+STREAM-\/\+CLOSED-\/\+ERROR} & the output stream has already been closed \\
\hline
{\em STREAM-\/\+THREAD-\/\+ERROR} & this exception is thrown if this method is called from any thread other than the thread that created the object \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{class_qore_1_1_binary_output_stream_a3c73ee311cea8c73d7dc25c041fc98d4}\label{class_qore_1_1_binary_output_stream_a3c73ee311cea8c73d7dc25c041fc98d4}} 
\index{Qore::BinaryOutputStream@{Qore::BinaryOutputStream}!write@{write}}
\index{write@{write}!Qore::BinaryOutputStream@{Qore::BinaryOutputStream}}
\doxysubsubsection{\texorpdfstring{write()}{write()}}
{\footnotesize\ttfamily nothing Qore\+::\+Binary\+Output\+Stream\+::write (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Writes bytes to the output stream. 


\begin{DoxyParams}{Parameters}
{\em data} & the data to write\\
\hline
\end{DoxyParams}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}{0}
\DoxyCodeLine{BinaryOutputStream bos();}
\DoxyCodeLine{bos.write(<0405>);}
\DoxyCodeLine{bos.write(<06>);}
\DoxyCodeLine{bos.getData();      \textcolor{comment}{\# returns <040506>}}

\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em OUTPUT-\/\+STREAM-\/\+CLOSED-\/\+ERROR} & the output stream has already been closed \\
\hline
{\em STREAM-\/\+THREAD-\/\+ERROR} & 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_output_stream_a9054b0475c4829d10f956d8f6df6f2ac}{Qore\+::\+Output\+Stream}}.

