ROSE  0.9.9.149
Public Types | Public Member Functions | Protected Member Functions | List of all members
Sawyer::Container::Buffer< A, T > Class Template Referenceabstract

Description

template<class A, class T>
class Sawyer::Container::Buffer< A, T >

Base class for all buffers.

A buffer stores a sequence of elements somewhat like a vector, but imparts a read/write paradigm for accessing those elements.

Definition at line 25 of file Buffer.h.

#include <Buffer.h>

Inheritance diagram for Sawyer::Container::Buffer< A, T >:
Inheritance graph
[legend]
Collaboration diagram for Sawyer::Container::Buffer< A, T >:
Collaboration graph
[legend]

Public Types

typedef SharedPointer< BufferPtr
 Reference counting smart pointer. More...
 
typedef A Address
 Key type for addressing data. More...
 
typedef T Value
 Type of values stored in the buffer. More...
 

Public Member Functions

virtual Ptr copy () const =0
 Create a new copy of buffer data. More...
 
virtual Address available (Address address) const =0
 Distance to end of buffer. More...
 
virtual Address size () const
 Size of buffer. More...
 
virtual void resize (Address n)=0
 Change the size of the buffer. More...
 
virtual void sync ()
 Synchronize buffer with persistent storage. More...
 
virtual Address read (Value *buf, Address address, Address n) const =0
 Reads data from a buffer. More...
 
virtual Address write (const Value *buf, Address address, Address n)=0
 Writes data to a buffer. More...
 
virtual const Valuedata () const =0
 Data for the buffer. More...
 
const std::string & name () const
 Property: Name. More...
 
void name (const std::string &s)
 Property: Name. More...
 
bool copyOnWrite () const
 Property: Copy on write. More...
 
void copyOnWrite (bool b)
 Property: Copy on write. More...
 
- Public Member Functions inherited from Sawyer::SharedObject
 SharedObject ()
 Default constructor. More...
 
 SharedObject (const SharedObject &)
 Copy constructor. More...
 
virtual ~SharedObject ()
 Virtual destructor. More...
 
SharedObjectoperator= (const SharedObject &)
 Assignment. More...
 

Protected Member Functions

 Buffer (const std::string &name="")
 

Member Typedef Documentation

template<class A, class T>
typedef SharedPointer<Buffer> Sawyer::Container::Buffer< A, T >::Ptr

Reference counting smart pointer.

See also
smart_pointers

Definition at line 45 of file Buffer.h.

template<class A, class T>
typedef A Sawyer::Container::Buffer< A, T >::Address

Key type for addressing data.

The key type should be an unsigned integral type and is the type used to index the data.

Definition at line 50 of file Buffer.h.

template<class A, class T>
typedef T Sawyer::Container::Buffer< A, T >::Value

Type of values stored in the buffer.

Definition at line 53 of file Buffer.h.

Member Function Documentation

template<class A, class T>
virtual Ptr Sawyer::Container::Buffer< A, T >::copy ( ) const
pure virtual

Create a new copy of buffer data.

Returns a new buffer containing the same data as the old buffer. Some buffer types cannot make an exact copy, in which case they should return an AllocatingBuffer that holds a snapshot of the source buffer's data as it existed at the time of this operation.

Implemented in Sawyer::Container::MappedBuffer< A, T >, Sawyer::Container::StaticBuffer< A, T >, Sawyer::Container::AllocatingBuffer< A, T >, and Sawyer::Container::NullBuffer< A, T >.

template<class A, class T>
virtual Address Sawyer::Container::Buffer< A, T >::available ( Address  address) const
pure virtual

Distance to end of buffer.

The distance in units of the Value type from the specified address (inclusive) to the last element of the buffer (inclusive). If the address is beyond the end of the buffer then a distance of zero is returned rather than a negative distance. Note that the return value will overflow to zero if the buffer spans the entire address space.

Implemented in Sawyer::Container::MappedBuffer< A, T >, Sawyer::Container::StaticBuffer< A, T >, Sawyer::Container::AllocatingBuffer< A, T >, and Sawyer::Container::NullBuffer< A, T >.

Referenced by Sawyer::Container::AddressMap< rose_addr_t, uint8_t >::checkConsistency(), and Sawyer::Container::Buffer< size_t, char >::size().

template<class A, class T>
virtual Address Sawyer::Container::Buffer< A, T >::size ( void  ) const
inlinevirtual

Size of buffer.

Returns the number of Value elements stored in the buffer. In other words, this is the first address beyond the end of the buffer. Note that the return value may overflow to zero if the buffer spans the entire address space.

Definition at line 76 of file Buffer.h.

Referenced by Sawyer::Container::AllocatingBuffer< A, T >::copy(), Sawyer::Container::MappedBuffer< A, T >::copy(), and Sawyer::Container::MappedBuffer< A, T >::resize().

template<class A, class T>
virtual void Sawyer::Container::Buffer< A, T >::resize ( Address  n)
pure virtual

Change the size of the buffer.

Truncates the buffer to a smaller size, or extends the buffer as necessary to make its size n values.

Implemented in Sawyer::Container::MappedBuffer< A, T >, Sawyer::Container::StaticBuffer< A, T >, Sawyer::Container::AllocatingBuffer< A, T >, and Sawyer::Container::NullBuffer< A, T >.

template<class A, class T>
virtual void Sawyer::Container::Buffer< A, T >::sync ( )
inlinevirtual

Synchronize buffer with persistent storage.

If the buffer is backed by a file of some sort, then synchronize the buffer contents with the file by writing to the file any buffer values that have changed.

Definition at line 87 of file Buffer.h.

template<class A, class T>
const std::string& Sawyer::Container::Buffer< A, T >::name ( ) const
inline

Property: Name.

An arbitrary string stored as part of the buffer, usually used for debugging.

Definition at line 94 of file Buffer.h.

template<class A, class T>
void Sawyer::Container::Buffer< A, T >::name ( const std::string &  s)
inline

Property: Name.

An arbitrary string stored as part of the buffer, usually used for debugging.

Definition at line 95 of file Buffer.h.

template<class A, class T>
virtual Address Sawyer::Container::Buffer< A, T >::read ( Value buf,
Address  address,
Address  n 
) const
pure virtual

Reads data from a buffer.

Reads up to n values from this buffer beginning at the specified address and copies them to the caller-supplied argument. Returns the number of values actually copied, which may be smaller than the number requested. The output buffer is not zero-padded for short reads. Also note that the return value may overflow to zero if the entire address space is read.

As a special case, if buf is a null pointer, then no data is copied and the return value indicates the number of values that would have been copied had buf been non-null.

Implemented in Sawyer::Container::MappedBuffer< A, T >, Sawyer::Container::StaticBuffer< A, T >, Sawyer::Container::AllocatingBuffer< A, T >, and Sawyer::Container::NullBuffer< A, T >.

template<class A, class T>
virtual Address Sawyer::Container::Buffer< A, T >::write ( const Value buf,
Address  address,
Address  n 
)
pure virtual

Writes data to a buffer.

Writes up to n values from buf into this buffer starting at the specified address. Returns the number of values actually written, which might be smaller than n. The return value will be less than n if an error occurs, but note that the return value may overflow to zero if the entire address space is written.

Implemented in Sawyer::Container::MappedBuffer< A, T >, Sawyer::Container::StaticBuffer< A, T >, Sawyer::Container::AllocatingBuffer< A, T >, and Sawyer::Container::NullBuffer< A, T >.

template<class A, class T>
virtual const Value* Sawyer::Container::Buffer< A, T >::data ( ) const
pure virtual

Data for the buffer.

Returns a pointer for the buffer data. Those subclasses that don't support this method will return the null pointer.

Implemented in Sawyer::Container::MappedBuffer< A, T >, Sawyer::Container::StaticBuffer< A, T >, Sawyer::Container::AllocatingBuffer< A, T >, and Sawyer::Container::NullBuffer< A, T >.

template<class A, class T>
bool Sawyer::Container::Buffer< A, T >::copyOnWrite ( ) const
inline

Property: Copy on write.

This is a bit stored in the buffer and is used by higher layers to implement copy-on-write. The buffer itself does nothing with this bit.

Definition at line 127 of file Buffer.h.

template<class A, class T>
void Sawyer::Container::Buffer< A, T >::copyOnWrite ( bool  b)
inline

Property: Copy on write.

This is a bit stored in the buffer and is used by higher layers to implement copy-on-write. The buffer itself does nothing with this bit.

Definition at line 128 of file Buffer.h.


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