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

#include <io_cache.h>

Public Member Functions
	IoCache (uint64_t cache_size)

uint64_t	Read (void *buffer, uint64_t size)

uint64_t	Write (const void *buffer, uint64_t size)

void	Clear ()
	Empties the cache.

void	Close ()

bool	closed ()

void	Reopen ()
	Reopens the cache. Any data still in the cache will be lost.

uint64_t	BytesCached ()

uint64_t	BytesFree ()

void	WaitUntilEmptyOrClosed ()
	Waits until the cache is empty or has been closed.

Detailed Description

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

Definition at line 20 of file io_cache.h.

Constructor & Destructor Documentation

◆ IoCache()

shaka::IoCache::IoCache ( uint64_t cache_size )

explicit

Definition at line 19 of file io_cache.cc.

◆ ~IoCache()

shaka::IoCache::~IoCache ( )

Definition at line 29 of file io_cache.cc.

Member Function Documentation

◆ BytesCached()

uint64_t shaka::IoCache::BytesCached ( )

Returns the number of bytes in the cache.

Returns: the number of bytes in the cache.

Definition at line 119 of file io_cache.cc.

◆ BytesFree()

uint64_t shaka::IoCache::BytesFree ( )

Returns the number of free bytes in the cache.

Returns: the number of free bytes in the cache.

Definition at line 124 of file io_cache.cc.

◆ Clear()

void shaka::IoCache::Clear ( )

Empties the cache.

Definition at line 98 of file io_cache.cc.

◆ Close()

void shaka::IoCache::Close ( )

Close the cache. This will call any blocking calls to unblock, and the cache won't be usable until Reopened.

Definition at line 105 of file io_cache.cc.

◆ closed()

bool shaka::IoCache::closed ( )

inline

Returns: true if the cache is closed, false otherwise.

Definition at line 50 of file io_cache.h.

◆ Read()

uint64_t shaka::IoCache::Read	(	void *	buffer,
		uint64_t	size
	)

Read data from the cache. This function may block until there is data in the cache.

Parameters

buffer	is a buffer into which to read the data from the cache.
size	is the size of buffer.

Returns: the number of bytes read into buffer, or 0 if the call unblocked because the cache has been closed and is empty.

Definition at line 33 of file io_cache.cc.

◆ Reopen()

void shaka::IoCache::Reopen ( )

Reopens the cache. Any data still in the cache will be lost.

Definition at line 112 of file io_cache.cc.

◆ WaitUntilEmptyOrClosed()

void shaka::IoCache::WaitUntilEmptyOrClosed ( )

Waits until the cache is empty or has been closed.

Definition at line 139 of file io_cache.cc.

◆ Write()

uint64_t shaka::IoCache::Write	(	const void *	buffer,
		uint64_t	size
	)

Write data to the cache. This function may block until there is enough room in the cache.