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)
 
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 merge (WvBufStore &instore, size_t count)
 
void move (void *buf, size_t count)
 
void copy (void *buf, int offset, size_t count)
 
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)
 
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.
 

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 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()

bool WvBufCursorStore::isreadable ( ) const
virtual

Reimplemented from WvBufStore.

Definition at line 1191 of file wvbufferstore.cc.

◆ used()

size_t WvBufCursorStore::used ( ) const
virtual

Implements WvBufStore.

Definition at line 1197 of file wvbufferstore.cc.

◆ optgettable()

size_t WvBufCursorStore::optgettable ( ) const
virtual

Reimplemented from WvBufStore.

Definition at line 1203 of file wvbufferstore.cc.

◆ get()

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

Implements WvBufStore.

Definition at line 1214 of file wvbufferstore.cc.

◆ skip()

void WvBufCursorStore::skip ( size_t  count)
virtual

Reimplemented from WvBufStore.

Definition at line 1224 of file wvbufferstore.cc.

◆ unget()

void WvBufCursorStore::unget ( size_t  count)
virtual

Implements WvBufStore.

Definition at line 1232 of file wvbufferstore.cc.

◆ ungettable()

size_t WvBufCursorStore::ungettable ( ) const
virtual

Implements WvBufStore.

Definition at line 1240 of file wvbufferstore.cc.

◆ peekable()

size_t WvBufCursorStore::peekable ( int  offset) const
virtual

Reimplemented from WvBufStore.

Definition at line 1252 of file wvbufferstore.cc.

◆ optpeekable()

size_t WvBufCursorStore::optpeekable ( int  offset) const
virtual

Reimplemented from WvBufStore.

Definition at line 1262 of file wvbufferstore.cc.

◆ peek()

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

Reimplemented from WvBufStore.

Definition at line 1274 of file wvbufferstore.cc.

◆ zap()

void WvBufCursorStore::zap ( )
virtual

Implements WvBufStore.

Definition at line 1246 of file wvbufferstore.cc.

◆ iswritable()

bool WvBufCursorStore::iswritable ( ) const
virtual

Reimplemented from WvReadOnlyBufferStoreMixin< WvBufStore >.

Definition at line 1283 of file wvbufferstore.cc.

◆ mutablepeek()

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

Reimplemented from WvReadOnlyBufferStoreMixin< WvBufStore >.

Definition at line 1290 of file wvbufferstore.cc.

◆ free()

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

Implements WvBufStore.

Definition at line 148 of file wvbufstore.h.

◆ optallocable()

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

Reimplemented from WvBufStore.

Definition at line 152 of file wvbufstore.h.

◆ alloc()

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

Implements WvBufStore.

Definition at line 156 of file wvbufstore.h.

◆ unalloc()

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

Implements WvBufStore.

Definition at line 162 of file wvbufstore.h.

◆ unallocable()

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

Implements WvBufStore.

Definition at line 167 of file wvbufstore.h.

◆ merge()

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

Reimplemented from WvBufStore.

Definition at line 177 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.

◆ 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()

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

◆ buf

WvBufStore* WvBufCursorStore::buf
protected

Definition at line 515 of file wvbufstore.h.

◆ start

int WvBufCursorStore::start
protected

Definition at line 516 of file wvbufstore.h.

◆ length

size_t WvBufCursorStore::length
protected

Definition at line 517 of file wvbufstore.h.

◆ shift

size_t WvBufCursorStore::shift
protected

Definition at line 518 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: