Qore Programming Language Reference Manual  0.9.4.5
Qore::BinaryOutputStream Class Reference

This class implements the OutputStream interface for writing bytes to a Binary buffer. More...

Inheritance diagram for Qore::BinaryOutputStream:

Public Member Methods

nothing close ()
 Closes the output stream and releases any resources. More...
 
 constructor ()
 Creates the BinaryOutputStream.
 
binary getData ()
 Returns the data written to the stream, clearing the internal buffer. More...
 
nothing write (binary data)
 Writes bytes to the output stream. More...
 
- Public Member Methods inherited from Qore::OutputStream
 constructor ()
 Constructor. More...
 
- Public Member Methods inherited from Qore::StreamBase
 constructor ()
 Throws an exception if called directly; this class can only be instantiated by builtin subclasses. More...
 
int getThreadId ()
 Get the currently assigned thread id or -1 if not assigned to any thread.
 
nothing reassignThread ()
 Reassigns current thread as thread used for stream manipulation. More...
 
nothing unassignThread ()
 Unassigns current thread as thread used for stream manipulation. More...
 

Detailed Description

This class implements the OutputStream interface for writing bytes to a Binary buffer.

Example: BinaryOutputStream basic usage
BinaryOutputStream bos();
bos.write(<0405>);
bos.write(<06>);
bos.getData(); # returns <040506>
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 STREAM-THREAD-ERROR to be thrown, unless the stream is handed off to another thread using the StreamBase::unassignThread() method in the thread that currently owns the stream, and the StreamBase::reassignThread() method in the new thread.
See also
StreamWriter for a class that can be used to write various kinds of data to an OutputStream
Since
Qore 0.8.13

Member Function Documentation

◆ close()

nothing Qore::BinaryOutputStream::close ( )
virtual

Closes the output stream and releases any resources.

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

Implements Qore::OutputStream.

◆ getData()

binary Qore::BinaryOutputStream::getData ( )

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

Returns
the data written to the BinaryOutputStream
Example:
BinaryOutputStream bos();
bos.write(<0405>);
bos.write(<06>);
bos.getData(); # returns <040506>
Exceptions
OUTPUT-STREAM-CLOSED-ERRORthe output stream has already been closed
STREAM-THREAD-ERRORthis exception is thrown if this method is called from any thread other than the thread that created the object

◆ write()

nothing Qore::BinaryOutputStream::write ( binary  data)
virtual

Writes bytes to the output stream.

Parameters
datathe data to write
Example:
BinaryOutputStream bos();
bos.write(<0405>);
bos.write(<06>);
bos.getData(); # returns <040506>
Exceptions
OUTPUT-STREAM-CLOSED-ERRORthe output stream has already been closed
STREAM-THREAD-ERRORthis exception is thrown if this method is called from any thread other than the thread that created the object

Implements Qore::OutputStream.