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

The WvBufCursor storage class. More...

#include <wvbufstore.h>

Inheritance diagram for WvBufCursorStore:
Inheritance graph
[legend]

Public Member Functions

 WvBufCursorStore (size_t _granularity, WvBufStore *_buf, int _start, size_t _length)
 
virtual bool isreadable () const
 
virtual size_t used () const
 
virtual size_t optgettable () const
 
virtual const void * get (size_t count)
 
virtual void skip (size_t count)
 
virtual void unget (size_t count)
 
virtual size_t ungettable () const
 
virtual size_t peekable (int offset) const
 
virtual size_t optpeekable (int offset) const
 
virtual const void * peek (int offset, size_t count)
 
virtual void zap ()
 
virtual bool iswritable () const
 
virtual void * mutablepeek (int offset, size_t count)
 
 WvBufCursorStore (size_t _granularity, WvBufStore *_buf, int _start, size_t _length)
 
virtual bool isreadable () const
 
virtual size_t used () const
 
virtual size_t optgettable () const
 
virtual const void * get (size_t count)
 
virtual void skip (size_t count)
 
virtual void unget (size_t count)
 
virtual size_t ungettable () const
 
virtual size_t peekable (int offset) const
 
virtual size_t optpeekable (int offset) const
 
virtual const void * peek (int offset, size_t count)
 
virtual void zap ()
 
virtual bool iswritable () const
 
virtual void * mutablepeek (int offset, size_t count)
 
virtual size_t free () const
 
virtual size_t free () const
 
virtual size_t optallocable () const
 
virtual size_t optallocable () const
 
virtual void * alloc (size_t count)
 
virtual void * alloc (size_t count)
 
virtual void unalloc (size_t count)
 
virtual void unalloc (size_t count)
 
virtual size_t unallocable () const
 
virtual size_t unallocable () const
 
virtual void merge (WvBufStore &instore, size_t count)
 
virtual void merge (WvBufStore &instore, size_t count)
 
void move (void *buf, size_t count)
 
void move (void *buf, size_t count)
 
void copy (void *buf, int offset, size_t count)
 
void copy (void *buf, int offset, size_t count)
 
void put (const void *data, size_t count)
 
void put (const void *data, size_t count)
 
void fastput (const void *data, size_t count)
 
void fastput (const void *data, size_t count)
 
void poke (const void *data, int offset, size_t count)
 
void poke (const void *data, int offset, size_t count)
 
void basicmerge (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 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 size_t numsubbuffers () const
 Returns the number of subbuffers in the buffer.
 
virtual WvBufStorefirstsubbuffer () const
 Returns the first subbuffer.
 
virtual WvBufStorefirstsubbuffer () const
 Returns the first subbuffer.
 
virtual void appendsubbuffer (WvBufStore *buffer, bool autofree)
 Appends a subbuffer to the buffer.
 
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 void prependsubbuffer (WvBufStore *buffer, bool autofree)
 Prepends a subbuffer to the buffer.
 
virtual bool unlinksubbuffer (WvBufStore *buffer, bool allowautofree)
 Unlinks the specified subbuffer.
 
virtual bool unlinksubbuffer (WvBufStore *buffer, bool allowautofree)
 Unlinks the specified subbuffer.
 

Protected Attributes

WvBufStorebuf
 
int start
 
size_t length
 
size_t shift
 
int granularity
 

Detailed Description

The WvBufCursor storage class.

Definition at line 511 of file debian/libwvstreams-dev/usr/include/wvstreams/wvbufstore.h.

Constructor & Destructor Documentation

◆ WvBufCursorStore()

WvBufCursorStore::WvBufCursorStore ( size_t  _granularity,
WvBufStore _buf,
int  _start,
size_t  _length 
)

Definition at line 1183 of file wvbufferstore.cc.

Member Function Documentation

◆ isreadable() [1/2]

bool WvBufCursorStore::isreadable ( ) const
virtual

Reimplemented from WvBufStore.

Definition at line 1191 of file wvbufferstore.cc.

◆ used() [1/2]

size_t WvBufCursorStore::used ( ) const
virtual

Implements WvBufStore.

Definition at line 1197 of file wvbufferstore.cc.

◆ optgettable() [1/2]

size_t WvBufCursorStore::optgettable ( ) const
virtual

Reimplemented from WvBufStore.

Definition at line 1203 of file wvbufferstore.cc.

◆ get() [1/2]

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

Implements WvBufStore.

Definition at line 1214 of file wvbufferstore.cc.

◆ skip() [1/2]

void WvBufCursorStore::skip ( size_t  count)
virtual

Reimplemented from WvBufStore.

Definition at line 1224 of file wvbufferstore.cc.

◆ unget() [1/2]

void WvBufCursorStore::unget ( size_t  count)
virtual

Implements WvBufStore.

Definition at line 1232 of file wvbufferstore.cc.

◆ ungettable() [1/2]

size_t WvBufCursorStore::ungettable ( ) const
virtual

Implements WvBufStore.

Definition at line 1240 of file wvbufferstore.cc.

◆ peekable() [1/2]

size_t WvBufCursorStore::peekable ( int  offset) const
virtual

Reimplemented from WvBufStore.

Definition at line 1252 of file wvbufferstore.cc.

◆ optpeekable() [1/2]

size_t WvBufCursorStore::optpeekable ( int  offset) const
virtual

Reimplemented from WvBufStore.

Definition at line 1262 of file wvbufferstore.cc.

◆ peek() [1/2]

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

Reimplemented from WvBufStore.

Definition at line 1274 of file wvbufferstore.cc.

◆ zap() [1/2]

void WvBufCursorStore::zap ( )
virtual

Implements WvBufStore.

Definition at line 1246 of file wvbufferstore.cc.

◆ iswritable() [1/2]

bool WvBufCursorStore::iswritable ( ) const
virtual

Reimplemented from WvReadOnlyBufferStoreMixin< WvBufStore >.

Definition at line 1283 of file wvbufferstore.cc.

◆ mutablepeek() [1/2]

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

Reimplemented from WvReadOnlyBufferStoreMixin< WvBufStore >.

Definition at line 1290 of file wvbufferstore.cc.

◆ isreadable() [2/2]

virtual bool WvBufCursorStore::isreadable ( ) const
virtual

Reimplemented from WvBufStore.

◆ used() [2/2]

virtual size_t WvBufCursorStore::used ( ) const
virtual

Implements WvBufStore.

◆ optgettable() [2/2]

virtual size_t WvBufCursorStore::optgettable ( ) const
virtual

Reimplemented from WvBufStore.

◆ get() [2/2]

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

Implements WvBufStore.

◆ skip() [2/2]

virtual void WvBufCursorStore::skip ( size_t  count)
virtual

Reimplemented from WvBufStore.

◆ unget() [2/2]

virtual void WvBufCursorStore::unget ( size_t  count)
virtual

Implements WvBufStore.

◆ ungettable() [2/2]

virtual size_t WvBufCursorStore::ungettable ( ) const
virtual

Implements WvBufStore.

◆ peekable() [2/2]

virtual size_t WvBufCursorStore::peekable ( int  offset) const
virtual

Reimplemented from WvBufStore.

◆ optpeekable() [2/2]

virtual size_t WvBufCursorStore::optpeekable ( int  offset) const
virtual

Reimplemented from WvBufStore.

◆ peek() [2/2]

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

Reimplemented from WvBufStore.

◆ zap() [2/2]

virtual void WvBufCursorStore::zap ( )
virtual

Implements WvBufStore.

◆ iswritable() [2/2]

virtual bool WvBufCursorStore::iswritable ( ) const
virtual

◆ mutablepeek() [2/2]

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

◆ free() [1/2]

virtual size_t WvReadOnlyBufferStoreMixin< WvBufStore >::free ( ) const
inlinevirtualinherited

◆ free() [2/2]

virtual size_t WvReadOnlyBufferStoreMixin< WvBufStore >::free ( ) const
inlinevirtualinherited

Implements WvBufStore.

Definition at line 148 of file include/wvbufstore.h.

◆ optallocable() [1/2]

virtual size_t WvReadOnlyBufferStoreMixin< WvBufStore >::optallocable ( ) const
inlinevirtualinherited

Reimplemented from WvBufStore.

Definition at line 152 of file debian/libwvstreams-dev/usr/include/wvstreams/wvbufstore.h.

◆ optallocable() [2/2]

virtual size_t WvReadOnlyBufferStoreMixin< WvBufStore >::optallocable ( ) const
inlinevirtualinherited

Reimplemented from WvBufStore.

Definition at line 152 of file include/wvbufstore.h.

◆ alloc() [1/2]

virtual void * WvReadOnlyBufferStoreMixin< WvBufStore >::alloc ( size_t  count)
inlinevirtualinherited

◆ alloc() [2/2]

virtual void * WvReadOnlyBufferStoreMixin< WvBufStore >::alloc ( size_t  count)
inlinevirtualinherited

Implements WvBufStore.

Definition at line 156 of file include/wvbufstore.h.

◆ unalloc() [1/2]

virtual void WvReadOnlyBufferStoreMixin< WvBufStore >::unalloc ( size_t  count)
inlinevirtualinherited

◆ unalloc() [2/2]

virtual void WvReadOnlyBufferStoreMixin< WvBufStore >::unalloc ( size_t  count)
inlinevirtualinherited

Implements WvBufStore.

Definition at line 162 of file include/wvbufstore.h.

◆ unallocable() [1/2]

virtual size_t WvReadOnlyBufferStoreMixin< WvBufStore >::unallocable ( ) const
inlinevirtualinherited

◆ unallocable() [2/2]

virtual size_t WvReadOnlyBufferStoreMixin< WvBufStore >::unallocable ( ) const
inlinevirtualinherited

Implements WvBufStore.

Definition at line 167 of file include/wvbufstore.h.

◆ merge() [1/2]

virtual void WvReadOnlyBufferStoreMixin< WvBufStore >::merge ( WvBufStore instore,
size_t  count 
)
inlinevirtualinherited

Reimplemented from WvBufStore.

Definition at line 177 of file debian/libwvstreams-dev/usr/include/wvstreams/wvbufstore.h.

◆ merge() [2/2]

virtual void WvReadOnlyBufferStoreMixin< WvBufStore >::merge ( WvBufStore instore,
size_t  count 
)
inlinevirtualinherited

Reimplemented from WvBufStore.

Definition at line 177 of file include/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.

◆ 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.

◆ basicmerge()

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

Definition at line 229 of file wvbufferstore.cc.

◆ usessubbuffers() [1/2]

virtual bool WvBufStore::usessubbuffers ( ) const
inlineprotectedvirtualinherited

Returns true if the buffer uses subbuffers for storage.

Reimplemented in WvLinkedBufferStore, and WvLinkedBufferStore.

Definition at line 96 of file debian/libwvstreams-dev/usr/include/wvstreams/wvbufstore.h.

◆ usessubbuffers() [2/2]

virtual bool WvBufStore::usessubbuffers ( ) const
inlineprotectedvirtualinherited

Returns true if the buffer uses subbuffers for storage.

Reimplemented in WvLinkedBufferStore, and WvLinkedBufferStore.

Definition at line 96 of file include/wvbufstore.h.

◆ numsubbuffers() [1/2]

virtual size_t WvBufStore::numsubbuffers ( ) const
inlineprotectedvirtualinherited

Returns the number of subbuffers in the buffer.

Reimplemented in WvLinkedBufferStore, and WvLinkedBufferStore.

Definition at line 100 of file debian/libwvstreams-dev/usr/include/wvstreams/wvbufstore.h.

◆ numsubbuffers() [2/2]

virtual size_t WvBufStore::numsubbuffers ( ) const
inlineprotectedvirtualinherited

Returns the number of subbuffers in the buffer.

Reimplemented in WvLinkedBufferStore, and WvLinkedBufferStore.

Definition at line 100 of file include/wvbufstore.h.

◆ firstsubbuffer() [1/2]

virtual WvBufStore * WvBufStore::firstsubbuffer ( ) const
inlineprotectedvirtualinherited

Returns the first subbuffer.

Returns: the buffer or NULL if none or not supported

Reimplemented in WvLinkedBufferStore, and WvLinkedBufferStore.

Definition at line 107 of file debian/libwvstreams-dev/usr/include/wvstreams/wvbufstore.h.

◆ firstsubbuffer() [2/2]

virtual WvBufStore * WvBufStore::firstsubbuffer ( ) const
inlineprotectedvirtualinherited

Returns the first subbuffer.

Returns: the buffer or NULL if none or not supported

Reimplemented in WvLinkedBufferStore, and WvLinkedBufferStore.

Definition at line 107 of file include/wvbufstore.h.

◆ appendsubbuffer() [1/2]

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

Appends a subbuffer to the buffer.

Reimplemented in WvLinkedBufferStore, and WvLinkedBufferStore.

Definition at line 111 of file debian/libwvstreams-dev/usr/include/wvstreams/wvbufstore.h.

◆ appendsubbuffer() [2/2]

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

Appends a subbuffer to the buffer.

Reimplemented in WvLinkedBufferStore, and WvLinkedBufferStore.

Definition at line 111 of file include/wvbufstore.h.

◆ prependsubbuffer() [1/2]

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

Prepends a subbuffer to the buffer.

Reimplemented in WvLinkedBufferStore, and WvLinkedBufferStore.

Definition at line 115 of file debian/libwvstreams-dev/usr/include/wvstreams/wvbufstore.h.

◆ prependsubbuffer() [2/2]

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

Prepends a subbuffer to the buffer.

Reimplemented in WvLinkedBufferStore, and WvLinkedBufferStore.

Definition at line 115 of file include/wvbufstore.h.

◆ unlinksubbuffer() [1/2]

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, and WvLinkedBufferStore.

Definition at line 123 of file debian/libwvstreams-dev/usr/include/wvstreams/wvbufstore.h.

◆ unlinksubbuffer() [2/2]

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, and WvLinkedBufferStore.

Definition at line 123 of file include/wvbufstore.h.

Member Data Documentation

◆ buf

WvBufStore * WvBufCursorStore::buf
protected

◆ start

int WvBufCursorStore::start
protected

◆ length

size_t WvBufCursorStore::length
protected

◆ shift

size_t WvBufCursorStore::shift
protected

◆ granularity

int WvBufStore::granularity
protectedinherited

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