Shaka Packager SDK
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
shaka::ThreadedIoFile Class Reference

Declaration of class which implements a thread-safe circular buffer. More...

#include <threaded_io_file.h>

Inheritance diagram for shaka::ThreadedIoFile:

Public Types

enum  Mode { kInputMode , kOutputMode }
 

Public Member Functions

 ThreadedIoFile (std::unique_ptr< File, FileCloser > internal_file, Mode mode, uint64_t io_cache_size, uint64_t io_block_size)
 
File implementation overrides.
bool Close () override
 
int64_t Read (void *buffer, uint64_t length) override
 
int64_t Write (const void *buffer, uint64_t length) override
 
void CloseForWriting () override
 
int64_t Size () override
 
bool Flush () override
 
bool Seek (uint64_t position) override
 
bool Tell (uint64_t *position) override
 

Protected Member Functions

bool Open () override
 

Detailed Description

Declaration of class which implements a thread-safe circular buffer.

Definition at line 23 of file threaded_io_file.h.

Member Enumeration Documentation

◆ Mode

enum shaka::ThreadedIoFile::Mode

Definition at line 25 of file threaded_io_file.h.

Constructor & Destructor Documentation

◆ ThreadedIoFile()

shaka::ThreadedIoFile::ThreadedIoFile ( std::unique_ptr< File, FileCloser internal_file,
Mode  mode,
uint64_t  io_cache_size,
uint64_t  io_block_size 
)

Definition at line 15 of file threaded_io_file.cc.

◆ ~ThreadedIoFile()

shaka::ThreadedIoFile::~ThreadedIoFile ( )
overrideprotected

Definition at line 34 of file threaded_io_file.cc.

Member Function Documentation

◆ Close()

bool shaka::ThreadedIoFile::Close ( )
override

Definition at line 49 of file threaded_io_file.cc.

◆ CloseForWriting()

void shaka::ThreadedIoFile::CloseForWriting ( )
override

Definition at line 95 of file threaded_io_file.cc.

◆ Flush()

bool shaka::ThreadedIoFile::Flush ( )
override

Definition at line 103 of file threaded_io_file.cc.

◆ Open()

bool shaka::ThreadedIoFile::Open ( )
overrideprotected

Definition at line 36 of file threaded_io_file.cc.

◆ Read()

int64_t shaka::ThreadedIoFile::Read ( void *  buffer,
uint64_t  length 
)
override

Definition at line 64 of file threaded_io_file.cc.

◆ Seek()

bool shaka::ThreadedIoFile::Seek ( uint64_t  position)
override

Definition at line 122 of file threaded_io_file.cc.

◆ Size()

int64_t shaka::ThreadedIoFile::Size ( )
override

Definition at line 97 of file threaded_io_file.cc.

◆ Tell()

bool shaka::ThreadedIoFile::Tell ( uint64_t *  position)
override

Definition at line 154 of file threaded_io_file.cc.

◆ Write()

int64_t shaka::ThreadedIoFile::Write ( const void *  buffer,
uint64_t  length 
)
override

Definition at line 80 of file threaded_io_file.cc.


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