#include <BufferedStream.h>
◆ BufferedStream()
grk::BufferedStream::BufferedStream |
( |
uint8_t * |
buffer, |
|
|
size_t |
buffer_size, |
|
|
bool |
l_is_input |
|
) |
| |
◆ ~BufferedStream()
grk::BufferedStream::~BufferedStream |
( |
| ) |
|
|
private |
◆ flush()
bool grk::BufferedStream::flush |
( |
| ) |
|
|
virtual |
Flush stream to disk.
- Returns
- true if the data could be flushed, otherwise false.
Implements grk::IBufferedStream.
References grk::grk_buf< T, A >::buf, buf_, buffered_bytes_, grk::grk_buf< T, A >::currPtr(), grk::GRK_ERROR(), GROK_STREAM_STATUS_ERROR, grk::grk_buf< T, A >::incrementOffset(), isMemStream(), grk::grk_buf< T, A >::offset, read_bytes_seekable_, status_, user_data_, and write_fn_.
Referenced by write(), write_seek(), and writeBytes().
◆ getImpl()
◆ getStatus()
uint32_t grk::BufferedStream::getStatus |
( |
void |
| ) |
|
◆ getUserData()
void * grk::BufferedStream::getUserData |
( |
void |
| ) |
|
◆ getWrapper()
grk_stream * grk::BufferedStream::getWrapper |
( |
void |
| ) |
|
◆ getZeroCopyPtr()
uint8_t * grk::BufferedStream::getZeroCopyPtr |
( |
| ) |
|
|
virtual |
◆ hasSeek()
bool grk::BufferedStream::hasSeek |
( |
void |
| ) |
|
|
virtual |
◆ invalidate_buffer()
void grk::BufferedStream::invalidate_buffer |
( |
| ) |
|
|
private |
◆ isMemStream()
bool grk::BufferedStream::isMemStream |
( |
| ) |
|
|
private |
◆ numBytesLeft()
uint64_t grk::BufferedStream::numBytesLeft |
( |
void |
| ) |
|
|
virtual |
◆ read()
size_t grk::BufferedStream::read |
( |
uint8_t * |
buffer, |
|
|
size_t |
p_size |
|
) |
| |
|
virtual |
Reads some bytes from the stream.
- Parameters
-
buffer | pointer to the data buffer that will receive the data. |
p_size | number of bytes to read. |
- Returns
- the number of bytes read
Implements grk::IBufferedStream.
References grk::grk_buf< T, A >::buf, buf_, buffered_bytes_, grk::grk_buf< T, A >::currPtr(), grk::GRK_ERROR(), GROK_STREAM_STATUS_END, grk::grk_buf< T, A >::incrementOffset(), invalidate_buffer(), grk::grk_buf< T, A >::len, read_bytes_seekable_, read_fn_, status_, stream_offset_, supportsZeroCopy(), user_data_, and user_data_length_.
◆ read_seek()
bool grk::BufferedStream::read_seek |
( |
uint64_t |
offset | ) |
|
|
private |
Absolute seek in read stream.
- Parameters
-
- Returns
- true if successful, otherwise false
References grk::grk_buf< T, A >::buf, buf_, buffered_bytes_, grk::grk_buf< T, A >::currPtr(), GROK_STREAM_STATUS_END, GROK_STREAM_STATUS_ERROR, grk::grk_buf< T, A >::incrementOffset(), invalidate_buffer(), read_bytes_seekable_, seek_fn_, status_, stream_offset_, user_data_, and user_data_length_.
Referenced by read_skip(), and seek().
◆ read_skip()
bool grk::BufferedStream::read_skip |
( |
int64_t |
p_size | ) |
|
|
private |
Skip bytes in read stream.
- Parameters
-
p_size | the number of bytes to skip. |
- Returns
- true if successful, otherwise false
References read_seek(), and stream_offset_.
Referenced by skip().
◆ seek()
bool grk::BufferedStream::seek |
( |
uint64_t |
offset | ) |
|
|
virtual |
◆ setReadFunction()
◆ setSeekFunction()
◆ setUserData()
◆ setUserDataLength()
void grk::BufferedStream::setUserDataLength |
( |
uint64_t |
len | ) |
|
◆ setWriteFunction()
◆ setZeroCopyReadFunction()
◆ skip()
bool grk::BufferedStream::skip |
( |
int64_t |
p_size | ) |
|
|
virtual |
◆ supportsZeroCopy()
bool grk::BufferedStream::supportsZeroCopy |
( |
| ) |
|
|
virtual |
◆ tell()
uint64_t grk::BufferedStream::tell |
( |
void |
| ) |
|
|
virtual |
◆ write()
template<typename TYPE >
bool grk::BufferedStream::write |
( |
TYPE |
value, |
|
|
uint8_t |
numBytes |
|
) |
| |
|
private |
References buf_, buffered_bytes_, grk::grk_buf< T, A >::currPtr(), flush(), grk::grk_write(), GROK_STREAM_STATUS_ERROR, isMemStream(), grk::grk_buf< T, A >::len, seek_fn_, status_, stream_offset_, user_data_, and writeIncrement().
◆ write24()
bool grk::BufferedStream::write24 |
( |
uint32_t |
value | ) |
|
|
virtual |
◆ write64()
bool grk::BufferedStream::write64 |
( |
uint64_t |
value | ) |
|
|
virtual |
◆ write_seek()
bool grk::BufferedStream::write_seek |
( |
uint64_t |
offset | ) |
|
|
private |
Absolute seek in write stream.
- Parameters
-
- Returns
- true if successful, otherwise false
References buf_, flush(), GROK_STREAM_STATUS_ERROR, invalidate_buffer(), isMemStream(), grk::grk_buf< T, A >::offset, seek_fn_, status_, stream_offset_, and user_data_.
Referenced by seek(), and write_skip().
◆ write_skip()
bool grk::BufferedStream::write_skip |
( |
int64_t |
p_size | ) |
|
|
private |
Skip bytes in write stream.
- Parameters
-
p_size | the number of bytes to skip. |
- Returns
- true if successful, otherwise false
References stream_offset_, and write_seek().
Referenced by skip().
◆ writeByte()
bool grk::BufferedStream::writeByte |
( |
uint8_t |
value | ) |
|
|
virtual |
◆ writeBytes()
size_t grk::BufferedStream::writeBytes |
( |
const uint8_t * |
buffer, |
|
|
size_t |
p_size |
|
) |
| |
|
virtual |
Write bytes to stream (no correction for endian!).
- Parameters
-
buffer | pointer to the data buffer holds the data to be written. |
p_size | number of bytes to write. |
- Returns
- the number of bytes written
Implements grk::IBufferedStream.
References buf_, buffered_bytes_, grk::grk_buf< T, A >::currPtr(), flush(), GROK_STREAM_STATUS_ERROR, isMemStream(), grk::grk_buf< T, A >::len, grk::grk_buf< T, A >::offset, status_, stream_offset_, user_data_, write_fn_, and writeIncrement().
Referenced by writeByte().
◆ writeIncrement()
void grk::BufferedStream::writeIncrement |
( |
size_t |
p_size | ) |
|
|
private |
◆ writeInt()
bool grk::BufferedStream::writeInt |
( |
uint32_t |
value | ) |
|
|
virtual |
◆ writeShort()
bool grk::BufferedStream::writeShort |
( |
uint16_t |
value | ) |
|
|
virtual |
◆ buf_
Referenced by BufferedStream(), flush(), getZeroCopyPtr(), invalidate_buffer(), isMemStream(), read(), read_seek(), write(), write_seek(), writeBytes(), writeIncrement(), and ~BufferedStream().
◆ buffered_bytes_
size_t grk::BufferedStream::buffered_bytes_ |
|
private |
◆ free_user_data_fn_
Pointer to function to free user_data_ (nullptr at initialization) when destroying the stream.
If pointer is nullptr the function is not called and the user_data_ is not freed (even if it isn't nullptr).
Referenced by setUserData(), and ~BufferedStream().
◆ GrkObjectWrapperImpl< BufferedStream >
◆ obj
◆ read_bytes_seekable_
size_t grk::BufferedStream::read_bytes_seekable_ |
|
private |
◆ read_fn_
◆ seek_fn_
◆ status_
uint32_t grk::BufferedStream::status_ |
|
private |
Stream status flags.
Referenced by flush(), getStatus(), invalidate_buffer(), read(), read_seek(), seek(), skip(), supportsZeroCopy(), write(), write_seek(), and writeBytes().
◆ stream_offset_
uint64_t grk::BufferedStream::stream_offset_ |
|
private |
◆ user_data_
void* grk::BufferedStream::user_data_ |
|
private |
◆ user_data_length_
uint64_t grk::BufferedStream::user_data_length_ |
|
private |
◆ write_fn_
◆ zero_copy_read_fn_
The documentation for this struct was generated from the following files: