Grappa  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CacheRW< T, Allocator, Acquirer, Releaser > Class Template Reference

Read-write cache object. More...

#include <Cache.hpp>

Public Member Functions

 CacheRW (GlobalAddress< T > address, size_t count, T *buffer=NULL)
 Create a cache object. More...
 
 ~CacheRW ()
 
void start_acquire ()
 send acquire message More...
 
void block_until_acquired ()
 block until acquire is completed More...
 
void start_release ()
 send release message More...
 
void block_until_released ()
 block until release is completed More...
 
void reset (GlobalAddress< T > address, size_t count)
 reassign cache to point at a different block More...
 
GlobalAddress< T > address ()
 
 operator T * ()
 Dereference cache. More...
 
 operator void * ()
 Dereference cache. More...
 

Protected Attributes

GlobalAddress< T > address_
 
size_t count_
 
Allocator< T > storage_
 
T * pointer_
 
Acquirer< T > acquirer_
 
Releaser< T > releaser_
 

Detailed Description

template<typename T, template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
class CacheRW< T, Allocator, Acquirer, Releaser >

Read-write cache object.

This is parameterize so it can implement coherent or incoherent read-write caches.

Definition at line 218 of file Cache.hpp.

Constructor & Destructor Documentation

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
CacheRW< T, Allocator, Acquirer, Releaser >::CacheRW ( GlobalAddress< T >  address,
size_t  count,
T *  buffer = NULL 
)
inlineexplicit

Create a cache object.

Call with a global address, a number of elements to fetch, and optionally a local buffer to store the cached copy.

Definition at line 231 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
CacheRW< T, Allocator, Acquirer, Releaser >::~CacheRW ( )
inline

Definition at line 240 of file Cache.hpp.

Member Function Documentation

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
GlobalAddress< T > CacheRW< T, Allocator, Acquirer, Releaser >::address ( )
inline

Definition at line 278 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
void CacheRW< T, Allocator, Acquirer, Releaser >::block_until_acquired ( )
inline

block until acquire is completed

Definition at line 251 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
void CacheRW< T, Allocator, Acquirer, Releaser >::block_until_released ( )
inline

block until release is completed

Definition at line 263 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
CacheRW< T, Allocator, Acquirer, Releaser >::operator T * ( )
inline

Dereference cache.

Definition at line 281 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
CacheRW< T, Allocator, Acquirer, Releaser >::operator void * ( )
inline

Dereference cache.

Definition at line 287 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
void CacheRW< T, Allocator, Acquirer, Releaser >::reset ( GlobalAddress< T >  address,
size_t  count 
)
inline

reassign cache to point at a different block

Definition at line 269 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
void CacheRW< T, Allocator, Acquirer, Releaser >::start_acquire ( )
inline

send acquire message

Definition at line 245 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
void CacheRW< T, Allocator, Acquirer, Releaser >::start_release ( )
inline

send release message

Definition at line 257 of file Cache.hpp.

Member Data Documentation

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
Acquirer< T > CacheRW< T, Allocator, Acquirer, Releaser >::acquirer_
protected

Definition at line 224 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
GlobalAddress< T > CacheRW< T, Allocator, Acquirer, Releaser >::address_
protected

Definition at line 220 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
size_t CacheRW< T, Allocator, Acquirer, Releaser >::count_
protected

Definition at line 221 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
T* CacheRW< T, Allocator, Acquirer, Releaser >::pointer_
protected

Definition at line 223 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
Releaser< T > CacheRW< T, Allocator, Acquirer, Releaser >::releaser_
protected

Definition at line 225 of file Cache.hpp.

template<typename T , template< typename TT > class Allocator, template< typename TT > class Acquirer, template< typename TT > class Releaser>
Allocator< T > CacheRW< T, Allocator, Acquirer, Releaser >::storage_
protected

Definition at line 222 of file Cache.hpp.


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