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
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::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::File
	File (const std::string &file_name)
virtual	~File ()

Additional Inherited Members
Static Public Member Functions inherited from shaka::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	WriteStringToFile (const char *file_name, const std::string &contents)
static bool	WriteFileAtomically (const char *file_name, const 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)
static bool	IsLocalRegularFile (const char *file_name)
static std::string	MakeCallbackFileName (const BufferCallbackParams &callback_params, const std::string &name)
static bool	ParseCallbackFileName (const std::string &callback_file_name, const BufferCallbackParams **callback_params, std::string *name)

Detailed Description

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

Definition at line 20 of file threaded_io_file.h.

Member Function Documentation

Close()

bool shaka::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::File.

Definition at line 55 of file threaded_io_file.cc.

Flush()

bool shaka::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.

Returns

true on success, false otherwise.

Implements shaka::File.

Definition at line 107 of file threaded_io_file.cc.

Read()

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

overridevirtual

Read data and return it in buffer.

Parameters

[out]	buffer	points to a block of memory with a size of at least length bytes.
	length	indicates number of bytes to be read.

Returns

Number of bytes read, or a value < 0 on error. Zero on end-of-file, or if 'length' is zero.

Implements shaka::File.

Definition at line 70 of file threaded_io_file.cc.

Seek()

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

overridevirtual

Seek to the specifield position in the file.

Parameters

position

is the position to seek to.

Returns

true on success, false otherwise.

Implements shaka::File.

Definition at line 120 of file threaded_io_file.cc.

Size()

int64_t shaka::ThreadedIoFile::Size ( )

overridevirtual

Returns

Size of the file in bytes. A return value less than zero indicates a problem getting the size.

Implements shaka::File.

Definition at line 101 of file threaded_io_file.cc.

Tell()

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

overridevirtual

Get the current file position.

Parameters

position

is a pointer to contain the current file position upon successful return.

Returns

true on succcess, false otherwise.

Implements shaka::File.

Definition at line 152 of file threaded_io_file.cc.

Write()

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

overridevirtual

Write block of data.

Parameters

buffer	points to a block of memory with at least length bytes.
length	indicates number of bytes to write.

Returns

Number of bytes written, or a value < 0 on error.

Implements shaka::File.

Definition at line 86 of file threaded_io_file.cc.

---

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

• packager/file/threaded_io_file.h
• packager/file/threaded_io_file.cc