AudioDataLib::ByteStream Class Reference

This is the base class for all types of byte streams used in the library. More...

#include <ByteStream.h>

Inheritance diagram for AudioDataLib::ByteStream:

Public Member Functions
	ByteStream ()
virtual	~ByteStream ()
virtual uint64_t	WriteBytesToStream (const uint8_t *buffer, uint64_t bufferSize)=0
virtual uint64_t	ReadBytesFromStream (uint8_t *buffer, uint64_t bufferSize)=0
virtual uint64_t	PeekBytesFromStream (uint8_t *buffer, uint64_t bufferSize)
virtual uint64_t	GetSize () const =0
virtual bool	CanRead ()=0
virtual bool	CanWrite ()=0
template<typename T >
bool	ReadType (T *value)
template<typename T >
bool	WriteType (const T *value)

Detailed Description

This is the base class for all types of byte streams used in the library.

Some derivatives are read-only, write-only, or read-write. Consequently, not all interface methods are supported by all derivatives.

Constructor & Destructor Documentation

ByteStream()

ByteStream::ByteStream

(

)

~ByteStream()

ByteStream::~ByteStream ( )

virtual

Member Function Documentation

CanRead()

virtual bool AudioDataLib::ByteStream::CanRead ( )

pure virtual

Indicate whether there is data available to be read from the stream.

Implemented in AudioDataLib::FileInputStream, AudioDataLib::FileOutputStream, AudioDataLib::ReadOnlyBufferStream, AudioDataLib::WriteOnlyBufferStream, AudioDataLib::AudioStream, AudioDataLib::ThreadSafeAudioStream, and AudioDataLib::MemoryStream.

CanWrite()

virtual bool AudioDataLib::ByteStream::CanWrite ( )

pure virtual

Indicate whether it is possible to write additional data to the stream.

Implemented in AudioDataLib::FileInputStream, AudioDataLib::FileOutputStream, AudioDataLib::ReadOnlyBufferStream, AudioDataLib::WriteOnlyBufferStream, AudioDataLib::AudioStream, AudioDataLib::ThreadSafeAudioStream, and AudioDataLib::MemoryStream.

GetSize()

virtual uint64_t AudioDataLib::ByteStream::GetSize ( ) const

pure virtual

Return the amount of data (in bytes) currently stored in the stream.

Implemented in AudioDataLib::FileInputStream, AudioDataLib::FileOutputStream, AudioDataLib::ReadOnlyBufferStream, AudioDataLib::WriteOnlyBufferStream, AudioDataLib::AudioStream, AudioDataLib::ThreadSafeAudioStream, and AudioDataLib::MemoryStream.

PeekBytesFromStream()

uint64_t ByteStream::PeekBytesFromStream ( uint8_t * buffer, uint64_t bufferSize )

virtual

Read from this stream into the given buffer, but unlike ReadBytesFromStream, do not modify the stream. That is, a subsequent read from the stream will read from the same location.

Parameters

[out]	buffer	This is a pointer to an array where bytes read from the stream will be written.
[in]	bufferSize	This is the size in bytes of the given array.

Returns

The number of bytes actually read from the stream and written to the given buffer is returned.

Reimplemented in AudioDataLib::ReadOnlyBufferStream.

ReadBytesFromStream()

virtual uint64_t AudioDataLib::ByteStream::ReadBytesFromStream ( uint8_t * buffer, uint64_t bufferSize )

pure virtual

Read from this stream into the given buffer.

Parameters

[out]	buffer	This is a pointer to an array where bytes read from the stream will be written.
[in]	bufferSize	This is the size in bytes of the given array.

Returns

The number of bytes actually read from the stream and written to the given buffer is returned.

Implemented in AudioDataLib::FileInputStream, AudioDataLib::FileOutputStream, AudioDataLib::ReadOnlyBufferStream, AudioDataLib::WriteOnlyBufferStream, AudioDataLib::AudioStream, AudioDataLib::ThreadSafeAudioStream, and AudioDataLib::MemoryStream.

ReadType()

template<typename T >

bool AudioDataLib::ByteStream::ReadType ( T * value )

inline

Read an amount of data from the stream equal to the size of the given type. Byte-swapping may be a consideration here. Note that a failed read could still be a partial read. In other words, the stream can get modified even if the read fails.

WriteBytesToStream()

virtual uint64_t AudioDataLib::ByteStream::WriteBytesToStream ( const uint8_t * buffer, uint64_t bufferSize )

pure virtual

Write the given buffer to this stream.

Parameters

[in]	buffer	This is a pointer to the array of bytes to write to the stream.
[in]	bufferSize	This is the size of the given array in bytes.

Returns

The number of bytes actually written to the stream is returned.

Implemented in AudioDataLib::FileInputStream, AudioDataLib::FileOutputStream, AudioDataLib::ReadOnlyBufferStream, AudioDataLib::WriteOnlyBufferStream, AudioDataLib::AudioStream, AudioDataLib::ThreadSafeAudioStream, and AudioDataLib::MemoryStream.

WriteType()

template<typename T >

bool AudioDataLib::ByteStream::WriteType ( const T * value )

inline

Write an amount of data to the stream equal to the size of the given type. Byte-swapping may be a consideration here. Note that a failed write could still be a partial write. In other words, the stream can get modified even if the write fails.

---

The documentation for this class was generated from the following files:

• Source/Library/ByteStream.h
• Source/Library/ByteStream.cpp