Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

WvLinkedBufferStore Class Reference

#include <wvbufstore.h>

Inherits WvBufStore.

Inherited by WvDynBufStore.

Collaboration diagram for WvLinkedBufferStore:

[legend]
List of all members.

Detailed Description

The WvLinkedBuffer storage class.

A buffer store built out of a list of other buffers linked together. Buffers may be appended or prepended to the list at any time, at which point they act as slaves for the master buffer. Slaves may be expunged from the list at any time when the master buffer determines that they are of no further use.

This is mostly useful for building other buffer storage classes.

Definition at line 399 of file wvbufstore.h.

Public Member Functions

 WvLinkedBufferStore (int _granularity)
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 size_t optpeekable (int offset) 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 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

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.

virtual WvBufStorenewbuffer (size_t minsize)
 Called when a new buffer must be allocated to coalesce chunks.

virtual void recyclebuffer (WvBufStore *buffer)
 Called when a buffer with autofree is removed from the list.

int search (WvBufStoreList::Iter &it, int offset) const
 Searches for the buffer containing the offset.

WvBufStorecoalesce (WvBufStoreList::Iter &it, size_t count)
 Coalesces a sequence of buffers.


Protected Attributes

WvBufStoreList list
size_t totalused
size_t maxungettable
int granularity


Constructor & Destructor Documentation

WvLinkedBufferStore::WvLinkedBufferStore int  _granularity  )  [explicit]
 

Definition at line 739 of file wvbufferstore.cc.

References WvLinkedBufferStore().

Referenced by WvLinkedBufferStore().


Member Function Documentation

void * WvLinkedBufferStore::alloc size_t  count  )  [virtual]
 

Implements WvBufStore.

Reimplemented in WvDynBufStore.

Definition at line 922 of file wvbufferstore.cc.

References alloc(), list, and totalused.

Referenced by alloc().

void WvLinkedBufferStore::appendsubbuffer WvBufStore buffer,
bool  autofree
[protected, virtual]
 

Appends a subbuffer to the buffer.

Reimplemented from WvBufStore.

Definition at line 763 of file wvbufferstore.cc.

References appendsubbuffer(), list, totalused, and WvBufStore::used().

Referenced by appendsubbuffer().

void WvBufStore::basicmerge WvBufStore instore,
size_t  count
[inherited]
 

Definition at line 229 of file wvbufferstore.cc.

References WvBufStore::alloc(), WvBufStore::basicmerge(), WvBufStore::get(), memops, WvBufStore::optallocable(), WvBufStore::optgettable(), and WvBufStore::unalloc().

Referenced by WvBufStore::basicmerge(), and WvBufStore::merge().

WvBufStore * WvLinkedBufferStore::coalesce WvBufStoreList::Iter &  it,
size_t  count
[protected]
 

Coalesces a sequence of buffers.

"it" is the iterator pointing to the first buffer "count" is the required number of contiguous used bytes Returns: the composite buffer

Definition at line 1042 of file wvbufferstore.cc.

References WvBufStore::alloc(), coalesce(), WvBufStore::free(), list, WvBufStore::merge(), newbuffer(), WvBufStore::skip(), totalused, WvBufStore::unget(), WvBufStore::ungettable(), ungettable(), and WvBufStore::used().

Referenced by coalesce(), get(), and mutablepeek().

void WvBufStore::copy void *  buf,
int  offset,
size_t  count
[inherited]
 

Definition at line 128 of file wvbufferstore.cc.

References WvBufStore::copy(), memops, WvBufStore::optpeekable(), and WvBufStore::peek().

Referenced by WvBufStore::copy(), and WvBufBaseCommonImpl< unsigned >::copy().

void WvBufStore::fastput const void *  data,
size_t  count
[inherited]
 

Definition at line 163 of file wvbufferstore.cc.

References WvBufStore::alloc(), WvBufStore::fastput(), and memops.

Referenced by WvBufStore::fastput(), and WvBufBaseCommonImpl< unsigned >::put().

WvBufStore * WvLinkedBufferStore::firstsubbuffer  )  const [protected, virtual]
 

Returns the first subbuffer.

Returns: the buffer or NULL if none or not supported

Reimplemented from WvBufStore.

Definition at line 757 of file wvbufferstore.cc.

References list.

size_t WvLinkedBufferStore::free  )  const [virtual]
 

Implements WvBufStore.

Reimplemented in WvDynBufStore.

Definition at line 906 of file wvbufferstore.cc.

References list.

Referenced by WvDynBufStore::alloc().

const void * WvLinkedBufferStore::get size_t  count  )  [virtual]
 

Implements WvBufStore.

Definition at line 817 of file wvbufferstore.cc.

References coalesce(), WvBufStore::get(), get(), list, maxungettable, totalused, and WvBufStore::used().

Referenced by get().

virtual bool WvBufStore::isreadable  )  const [inline, virtual, inherited]
 

Reimplemented in WvBufCursorStore, and WvWriteOnlyBufferStoreMixin< WvReadOnlyBufferStoreMixin< WvBufStore > >.

Definition at line 45 of file wvbufstore.h.

Referenced by WvBufCursorStore::isreadable(), and WvBufBaseCommonImpl< unsigned >::isreadable().

virtual bool WvBufStore::iswritable  )  const [inline, virtual, inherited]
 

Reimplemented in WvBufCursorStore, and WvReadOnlyBufferStoreMixin< WvBufStore >.

Definition at line 68 of file wvbufstore.h.

Referenced by WvBufCursorStore::iswritable().

void WvBufStore::merge WvBufStore instore,
size_t  count
[virtual, inherited]
 

Reimplemented in WvReadOnlyBufferStoreMixin< WvBufStore >.

Definition at line 198 of file wvbufferstore.cc.

References WvBufStore::appendsubbuffer(), WvBufStore::basicmerge(), WvBufStore::firstsubbuffer(), WvBufStore::merge(), WvBufStore::unlinksubbuffer(), WvBufStore::used(), and WvBufStore::usessubbuffers().

Referenced by coalesce(), WvBufStore::merge(), and WvBufBaseCommonImpl< unsigned >::merge().

void WvBufStore::move void *  buf,
size_t  count
[inherited]
 

Definition at line 111 of file wvbufferstore.cc.

References WvBufStore::get(), memops, WvBufStore::move(), and WvBufStore::optgettable().

Referenced by WvBufStore::move(), and WvBufBaseCommonImpl< unsigned >::move().

void * WvLinkedBufferStore::mutablepeek int  offset,
size_t  count
[virtual]
 

Implements WvBufStore.

Definition at line 977 of file wvbufferstore.cc.

References coalesce(), list, WvBufStore::mutablepeek(), mutablepeek(), WvBufStore::peekable(), and search().

Referenced by mutablepeek().

WvBufStore * WvLinkedBufferStore::newbuffer size_t  minsize  )  [protected, virtual]
 

Called when a new buffer must be allocated to coalesce chunks.

"minsize" is the minimum size for the new buffer Returns: the new buffer

Reimplemented in WvDynBufStore.

Definition at line 996 of file wvbufferstore.cc.

References newbuffer(), and roundup().

Referenced by coalesce(), and newbuffer().

size_t WvLinkedBufferStore::numsubbuffers  )  const [protected, virtual]
 

Returns the number of subbuffers in the buffer.

Reimplemented from WvBufStore.

Definition at line 751 of file wvbufferstore.cc.

References list.

size_t WvLinkedBufferStore::optallocable  )  const [virtual]
 

Reimplemented from WvBufStore.

Reimplemented in WvDynBufStore.

Definition at line 914 of file wvbufferstore.cc.

References list.

Referenced by WvDynBufStore::optallocable().

size_t WvLinkedBufferStore::optgettable  )  const [virtual]
 

Reimplemented from WvBufStore.

Definition at line 805 of file wvbufferstore.cc.

References list.

size_t WvLinkedBufferStore::optpeekable int  offset  )  const [virtual]
 

Reimplemented from WvBufStore.

Definition at line 965 of file wvbufferstore.cc.

References list, WvBufStore::optpeekable(), optpeekable(), and search().

Referenced by optpeekable().

virtual const void* WvBufStore::peek int  offset,
size_t  count
[inline, virtual, inherited]
 

Reimplemented in WvConstInPlaceBufStore, WvBufCursorStore, and WvWriteOnlyBufferStoreMixin< WvReadOnlyBufferStoreMixin< WvBufStore > >.

Definition at line 58 of file wvbufstore.h.

References WvBufStore::mutablepeek(), and WvBufStore::peek().

Referenced by WvBufStore::copy(), WvBufCursorStore::get(), WvBufStore::peek(), WvBufCursorStore::peek(), and WvBufBaseCommonImpl< unsigned >::peek().

size_t WvBufStore::peekable int  offset  )  const [virtual, inherited]
 

Reimplemented in WvBufCursorStore, and WvWriteOnlyBufferStoreMixin< WvReadOnlyBufferStoreMixin< WvBufStore > >.

Definition at line 90 of file wvbufferstore.cc.

References WvBufStore::peekable(), WvBufStore::ungettable(), and WvBufStore::used().

Referenced by mutablepeek(), WvBufStore::optpeekable(), WvBufBaseCommonImpl< unsigned >::optpeekable(), WvBufStore::peekable(), and WvBufBaseCommonImpl< unsigned >::peekable().

void WvBufStore::poke const void *  data,
int  offset,
size_t  count
[inherited]
 

Definition at line 170 of file wvbufferstore.cc.

References memops, WvBufStore::mutablepeek(), WvBufStore::optpeekable(), WvBufStore::poke(), WvBufStore::put(), and WvBufStore::used().

Referenced by WvBufStore::poke(), and WvBufBaseCommonImpl< unsigned >::poke().

void WvLinkedBufferStore::prependsubbuffer WvBufStore buffer,
bool  autofree
[protected, virtual]
 

Prepends a subbuffer to the buffer.

Reimplemented from WvBufStore.

Definition at line 771 of file wvbufferstore.cc.

References list, maxungettable, prependsubbuffer(), totalused, and WvBufStore::used().

Referenced by prependsubbuffer().

void WvBufStore::put const void *  data,
size_t  count
[inherited]
 

Definition at line 146 of file wvbufferstore.cc.

References WvBufStore::alloc(), memops, WvBufStore::optallocable(), and WvBufStore::put().

Referenced by WvBufStore::poke(), WvBufStore::put(), and WvBufBaseCommonImpl< unsigned >::put().

void WvLinkedBufferStore::recyclebuffer WvBufStore buffer  )  [protected, virtual]
 

Called when a buffer with autofree is removed from the list.

This function is not called during object destruction.

"buffer" is the buffer to be destroyed

Definition at line 1004 of file wvbufferstore.cc.

References recyclebuffer().

Referenced by recyclebuffer().

int WvLinkedBufferStore::search WvBufStoreList::Iter &  it,
int  offset
const [protected]
 

Searches for the buffer containing the offset.

"it" is the iterator updated to point to buffer found, or to an invalid region if the offset is invalid "offset" is the offset for which to search Returns: the corrected offset within the buffer at it.ptr()

Definition at line 1010 of file wvbufferstore.cc.

References search(), WvBufStore::ungettable(), and WvBufStore::used().

Referenced by mutablepeek(), optpeekable(), and search().

virtual void WvBufStore::skip size_t  count  )  [inline, virtual, inherited]
 

Reimplemented in WvBufCursorStore, and WvWriteOnlyBufferStoreMixin< WvReadOnlyBufferStoreMixin< WvBufStore > >.

Definition at line 51 of file wvbufstore.h.

References WvBufStore::skip().

Referenced by coalesce(), WvBufStore::skip(), and WvBufBaseCommonImpl< unsigned >::skip().

void WvLinkedBufferStore::unalloc size_t  count  )  [virtual]
 

Implements WvBufStore.

Definition at line 932 of file wvbufferstore.cc.

References list, totalused, WvBufStore::unalloc(), unalloc(), and WvBufStore::unallocable().

Referenced by unalloc().

size_t WvLinkedBufferStore::unallocable  )  const [virtual]
 

Implements WvBufStore.

Definition at line 959 of file wvbufferstore.cc.

References totalused.

void WvLinkedBufferStore::unget size_t  count  )  [virtual]
 

Implements WvBufStore.

Definition at line 858 of file wvbufferstore.cc.

References list, maxungettable, totalused, and unget().

Referenced by unget().

size_t WvLinkedBufferStore::ungettable  )  const [virtual]
 

Implements WvBufStore.

Definition at line 872 of file wvbufferstore.cc.

References list, maxungettable, and totalused.

Referenced by coalesce().

bool WvLinkedBufferStore::unlinksubbuffer WvBufStore buffer,
bool  allowautofree
[protected, virtual]
 

Unlinks the specified subbuffer.

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

Reimplemented from WvBufStore.

Definition at line 780 of file wvbufferstore.cc.

References list, maxungettable, totalused, unlinksubbuffer(), and WvBufStore::used().

Referenced by unlinksubbuffer().

size_t WvLinkedBufferStore::used  )  const [virtual]
 

Implements WvBufStore.

Definition at line 798 of file wvbufferstore.cc.

References list, and totalused.

Referenced by WvDynBufStore::newbuffer().

bool WvLinkedBufferStore::usessubbuffers  )  const [protected, virtual]
 

Returns true if the buffer uses subbuffers for storage.

Reimplemented from WvBufStore.

Definition at line 745 of file wvbufferstore.cc.

void WvLinkedBufferStore::zap  )  [virtual]
 

Implements WvBufStore.

Definition at line 896 of file wvbufferstore.cc.

References list, maxungettable, and totalused.


Member Data Documentation

int WvBufStore::granularity [protected, inherited]
 

Definition at line 31 of file wvbufstore.h.

WvBufStoreList WvLinkedBufferStore::list [protected]
 

Definition at line 402 of file wvbufstore.h.

Referenced by alloc(), appendsubbuffer(), coalesce(), firstsubbuffer(), free(), get(), mutablepeek(), numsubbuffers(), optallocable(), optgettable(), optpeekable(), prependsubbuffer(), unalloc(), unget(), ungettable(), unlinksubbuffer(), used(), and zap().

size_t WvLinkedBufferStore::maxungettable [protected]
 

Definition at line 404 of file wvbufstore.h.

Referenced by get(), prependsubbuffer(), unget(), ungettable(), unlinksubbuffer(), and zap().

size_t WvLinkedBufferStore::totalused [protected]
 

Definition at line 403 of file wvbufstore.h.

Referenced by alloc(), appendsubbuffer(), coalesce(), get(), prependsubbuffer(), unalloc(), unallocable(), unget(), ungettable(), unlinksubbuffer(), used(), and zap().


The documentation for this class was generated from the following files:
Generated on Tue Oct 5 01:09:28 2004 for WvStreams by doxygen 1.3.7