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

#include <threaded_io_file.h>

Inheritance diagram for shaka::media::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

int64_t	Size () override

bool	Flush () override

bool	Seek (uint64_t position) override

bool	Tell (uint64_t *position) override

Public Member Functions inherited from shaka::media::File
const std::string &	file_name () const

Protected Member Functions
bool	Open () override
	Internal open. Should not be used directly.

Protected Member Functions inherited from shaka::media::File
	File (const std::string &file_name)

virtual	~File ()

Additional Inherited Members
Static Public Member Functions inherited from shaka::media::File
static File *	Open (const char file_name, const char mode)

static File *	OpenWithNoBuffering (const char file_name, const char mode)

static bool	Delete (const char *file_name)

static int64_t	GetFileSize (const char *file_name)

static bool	ReadFileToString (const char file_name, std::string contents)

static bool	Copy (const char from_file_name, const char to_file_name)

static int64_t	CopyFile (File source, File destination)

static int64_t	CopyFile (File source, File destination, int64_t max_copy)

Detailed Description

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

Definition at line 21 of file threaded_io_file.h.

Member Function Documentation

bool shaka::media::ThreadedIoFile::Close ( )

overridevirtual

Flush() and de-allocate resources associated with this file, and delete this File object. THIS IS THE ONE TRUE WAY TO DEALLOCATE THIS OBJECT.

Returns: true on success. For writable files, returning false MAY INDICATE DATA LOSS.

Implements shaka::media::File.

Definition at line 56 of file threaded_io_file.cc.

bool shaka::media::ThreadedIoFile::Flush ( )

overridevirtual

Flush the file so that recently written data will survive an application crash (but not necessarily an OS crash). For instance, in LocalFile the data is flushed into the OS but not necessarily to disk.