WvStreams
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
WvCircularBufStore Class Reference

The WvCircularBuf storage class. More...

#include <wvbufstore.h>

Inheritance diagram for WvCircularBufStore:
Inheritance graph
[legend]

Public Member Functions

 WvCircularBufStore (int _granularity, void *_data, size_t _avail, size_t _size, bool _autofree)
 
 WvCircularBufStore (int _granularity, size_t _size)
 
void * ptr () const
 
size_t size () const
 
bool get_autofree () const
 
void set_autofree (bool _autofree)
 
void reset (void *_data, size_t _avail, size_t _size, bool _autofree)
 
void setavail (size_t _avail)
 
void normalize ()
 
virtual size_t used () const
 
virtual size_t optgettable () const
 
virtual const void * get (size_t count)
 
virtual void unget (size_t count)
 
virtual size_t ungettable () const
 
virtual void zap ()
 
virtual size_t free () const
 
virtual size_t optallocable () const
 
virtual void * alloc (size_t count)
 
virtual void unalloc (size_t count)
 
virtual size_t unallocable () const
 
virtual void * mutablepeek (int offset, size_t count)
 
virtual bool isreadable () const
 
virtual void skip (size_t count)
 
virtual size_t peekable (int offset) const
 
virtual size_t optpeekable (int offset) const
 
virtual const void * peek (int offset, size_t count)
 
void move (void *buf, size_t count)
 
void copy (void *buf, int offset, size_t count)
 
virtual bool iswritable () const
 
void put (const void *data, size_t count)
 
void fastput (const void *data, size_t count)
 
void poke (const void *data, int offset, size_t count)
 
virtual void merge (WvBufStore &instore, size_t count)
 
void basicmerge (WvBufStore &instore, size_t count)
 

Protected Member Functions

size_t ensurecontiguous (int offset, size_t count, bool keephistory)
 Ensures that count new bytes can be read from or written to the buffer beginning at the specified offset as one large contiguous block.
 
virtual bool usessubbuffers () const
 Returns true if the buffer uses subbuffers for storage.
 
virtual size_t numsubbuffers () const
 Returns the number of subbuffers in the buffer.
 
virtual WvBufStorefirstsubbuffer () const
 Returns the first subbuffer.
 
virtual void appendsubbuffer (WvBufStore *buffer, bool autofree)
 Appends a subbuffer to the buffer.
 
virtual void prependsubbuffer (WvBufStore *buffer, bool autofree)
 Prepends a subbuffer to the buffer.
 
virtual bool unlinksubbuffer (WvBufStore *buffer, bool allowautofree)
 Unlinks the specified subbuffer.
 

Static Protected Member Functions

static void compact (void *data, size_t size, size_t head, size_t count)
 Compacts an array arranged as a circular buffer such that the specified region is moved to the beginning of the array.
 

Protected Attributes

void * data
 
size_t xsize
 
size_t head
 
size_t totalused
 
size_t totalinit
 
bool xautofree
 
int granularity
 

Detailed Description

The WvCircularBuf storage class.

Definition at line 320 of file wvbufstore.h.

Constructor & Destructor Documentation

◆ WvCircularBufStore() [1/2]

WvCircularBufStore::WvCircularBufStore ( int  _granularity,
void *  _data,
size_t  _avail,
size_t  _size,
bool  _autofree 
)

Definition at line 485 of file wvbufferstore.cc.

◆ WvCircularBufStore() [2/2]

WvCircularBufStore::WvCircularBufStore ( int  _granularity,
size_t  _size 
)

Definition at line 493 of file wvbufferstore.cc.

◆ ~WvCircularBufStore()

WvCircularBufStore::~WvCircularBufStore ( )
virtual

Definition at line 500 of file wvbufferstore.cc.

Member Function Documentation

◆ ptr()

void * WvCircularBufStore::ptr ( ) const
inline

Definition at line 335 of file wvbufstore.h.

◆ size()

size_t WvCircularBufStore::size ( ) const
inline

Definition at line 337 of file wvbufstore.h.

◆ get_autofree()

bool WvCircularBufStore::get_autofree ( ) const
inline

Definition at line 339 of file wvbufstore.h.

◆ set_autofree()

void WvCircularBufStore::set_autofree ( bool  _autofree)
inline

Definition at line 341 of file wvbufstore.h.

◆ reset()

void WvCircularBufStore::reset ( void *  _data,
size_t  _avail,
size_t  _size,
bool  _autofree = false 
)

Definition at line 507 of file wvbufferstore.cc.

◆ setavail()

void WvCircularBufStore::setavail ( size_t  _avail)

Definition at line 520 of file wvbufferstore.cc.

◆ normalize()

void WvCircularBufStore::normalize ( )

Definition at line 636 of file wvbufferstore.cc.

◆ used()

size_t WvCircularBufStore::used ( ) const
virtual

Implements WvBufStore.

Definition at line 528 of file wvbufferstore.cc.

◆ optgettable()

size_t WvCircularBufStore::optgettable ( ) const
virtual

Reimplemented from WvBufStore.

Definition at line 534 of file wvbufferstore.cc.

◆ get()

const void * WvCircularBufStore::get ( size_t  count)
virtual

Implements WvBufStore.

Definition at line 543 of file wvbufferstore.cc.

◆ unget()

void WvCircularBufStore::unget ( size_t  count)
virtual

Implements WvBufStore.

Definition at line 555 of file wvbufferstore.cc.

◆ ungettable()

size_t WvCircularBufStore::ungettable ( ) const
virtual

Implements WvBufStore.

Definition at line 564 of file wvbufferstore.cc.

◆ zap()

void WvCircularBufStore::zap ( )
virtual

Implements WvBufStore.

Definition at line 570 of file wvbufferstore.cc.

◆ free()

size_t WvCircularBufStore::free ( ) const
virtual

Implements WvBufStore.

Definition at line 577 of file wvbufferstore.cc.

◆ optallocable()

size_t WvCircularBufStore::optallocable ( ) const
virtual

Reimplemented from WvBufStore.

Definition at line 583 of file wvbufferstore.cc.

◆ alloc()

void * WvCircularBufStore::alloc ( size_t  count)
virtual

Implements WvBufStore.

Definition at line 592 of file wvbufferstore.cc.

◆ unalloc()

void WvCircularBufStore::unalloc ( size_t  count)
virtual

Implements WvBufStore.

Definition at line 606 of file wvbufferstore.cc.

◆ unallocable()

size_t WvCircularBufStore::unallocable ( ) const
virtual

Implements WvBufStore.

Definition at line 615 of file wvbufferstore.cc.

◆ mutablepeek()

void * WvCircularBufStore::mutablepeek ( int  offset,
size_t  count 
)
virtual

Implements WvBufStore.

Definition at line 621 of file wvbufferstore.cc.

◆ ensurecontiguous()

size_t WvCircularBufStore::ensurecontiguous ( int  offset,
size_t  count,
bool  keephistory 
)
protected

Ensures that count new bytes can be read from or written to the buffer beginning at the specified offset as one large contiguous block.

"offset" is the offset "count" is the number of bytes "keephistory" is if true, does not purge unget history Returns: the offset of the first available byte

Definition at line 647 of file wvbufferstore.cc.

References compact().

◆ compact()

void WvCircularBufStore::compact ( void *  data,
size_t  size,
size_t  head,
size_t  count 
)
staticprotected

Compacts an array arranged as a circular buffer such that the specified region is moved to the beginning of the array.

"data" is the array base "size" is the size of the array "head" is the beginning of the region to keep "count" is the number of bytes in the region to keep

Definition at line 684 of file wvbufferstore.cc.

References MemOps::deletearray(), MemOps::newarray(), MemOps::swap(), and MemOps::uninit_move().

Referenced by ensurecontiguous().

◆ isreadable()

virtual bool WvBufStore::isreadable ( ) const
inlinevirtualinherited

Definition at line 47 of file wvbufstore.h.

◆ skip()

virtual void WvBufStore::skip ( size_t  count)
inlinevirtualinherited

Definition at line 53 of file wvbufstore.h.

◆ peekable()

size_t WvBufStore::peekable ( int  offset) const
virtualinherited

Definition at line 90 of file wvbufferstore.cc.

◆ optpeekable()

virtual size_t WvBufStore::optpeekable ( int  offset) const
inlinevirtualinherited

Definition at line 58 of file wvbufstore.h.

◆ peek()

virtual const void * WvBufStore::peek ( int  offset,
size_t  count 
)
inlinevirtualinherited

Definition at line 60 of file wvbufstore.h.

◆ move()

void WvBufStore::move ( void *  buf,
size_t  count 
)
inherited

Definition at line 111 of file wvbufferstore.cc.

◆ copy()

void WvBufStore::copy ( void *  buf,
int  offset,
size_t  count 
)
inherited

Definition at line 128 of file wvbufferstore.cc.

◆ iswritable()

virtual bool WvBufStore::iswritable ( ) const
inlinevirtualinherited

Definition at line 70 of file wvbufstore.h.

◆ put()

void WvBufStore::put ( const void *  data,
size_t  count 
)
inherited

Definition at line 146 of file wvbufferstore.cc.

◆ fastput()

void WvBufStore::fastput ( const void *  data,
size_t  count 
)
inherited

Definition at line 163 of file wvbufferstore.cc.

◆ poke()

void WvBufStore::poke ( const void *  data,
int  offset,
size_t  count 
)
inherited

Definition at line 170 of file wvbufferstore.cc.

◆ merge()

void WvBufStore::merge ( WvBufStore instore,
size_t  count 
)
virtualinherited

Definition at line 198 of file wvbufferstore.cc.

◆ basicmerge()

void WvBufStore::basicmerge ( WvBufStore instore,
size_t  count 
)
inherited

Definition at line 229 of file wvbufferstore.cc.

◆ usessubbuffers()

virtual bool WvBufStore::usessubbuffers ( ) const
inlineprotectedvirtualinherited

Returns true if the buffer uses subbuffers for storage.

Reimplemented in WvLinkedBufferStore.

Definition at line 96 of file wvbufstore.h.

◆ numsubbuffers()

virtual size_t WvBufStore::numsubbuffers ( ) const
inlineprotectedvirtualinherited

Returns the number of subbuffers in the buffer.

Reimplemented in WvLinkedBufferStore.

Definition at line 100 of file wvbufstore.h.

◆ firstsubbuffer()

virtual WvBufStore * WvBufStore::firstsubbuffer ( ) const
inlineprotectedvirtualinherited

Returns the first subbuffer.

Returns: the buffer or NULL if none or not supported

Reimplemented in WvLinkedBufferStore.

Definition at line 107 of file wvbufstore.h.

◆ appendsubbuffer()

virtual void WvBufStore::appendsubbuffer ( WvBufStore buffer,
bool  autofree 
)
inlineprotectedvirtualinherited

Appends a subbuffer to the buffer.

Reimplemented in WvLinkedBufferStore.

Definition at line 111 of file wvbufstore.h.

◆ prependsubbuffer()

virtual void WvBufStore::prependsubbuffer ( WvBufStore buffer,
bool  autofree 
)
inlineprotectedvirtualinherited

Prepends a subbuffer to the buffer.

Reimplemented in WvLinkedBufferStore.

Definition at line 115 of file wvbufstore.h.

◆ unlinksubbuffer()

virtual bool WvBufStore::unlinksubbuffer ( WvBufStore buffer,
bool  allowautofree 
)
inlineprotectedvirtualinherited

Unlinks the specified subbuffer.

Only autofrees the buffer if allowautofree == true. Returns: the autofree flag for the buffer

Reimplemented in WvLinkedBufferStore.

Definition at line 123 of file wvbufstore.h.

Member Data Documentation

◆ data

void* WvCircularBufStore::data
protected

Definition at line 323 of file wvbufstore.h.

◆ xsize

size_t WvCircularBufStore::xsize
protected

Definition at line 324 of file wvbufstore.h.

◆ head

size_t WvCircularBufStore::head
protected

Definition at line 325 of file wvbufstore.h.

◆ totalused

size_t WvCircularBufStore::totalused
protected

Definition at line 326 of file wvbufstore.h.

◆ totalinit

size_t WvCircularBufStore::totalinit
protected

Definition at line 327 of file wvbufstore.h.

◆ xautofree

bool WvCircularBufStore::xautofree
protected

Definition at line 328 of file wvbufstore.h.

◆ granularity

int WvBufStore::granularity
protectedinherited

Definition at line 33 of file wvbufstore.h.


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