OpenDDS::DCPS::FirstTimeFastAllocator< T, N > Class Template Reference

#include <ZeroCopyAllocator_T.h>

Inheritance diagram for OpenDDS::DCPS::FirstTimeFastAllocator< T, N >:

Collaboration diagram for OpenDDS::DCPS::FirstTimeFastAllocator< T, N >:

Public Member Functions
	FirstTimeFastAllocator ()
virtual void *	malloc (size_t nbytes)
virtual void	free (void *ptr)
virtual void *	calloc (size_t nbytes, char initial_value='\0')
	These methods are no-ops. More...
virtual void *	calloc (size_t n_elem, size_t elem_size, char initial_value='\0')
virtual int	remove ()
virtual int	bind (const char *name, void *pointer, int duplicates=0)
virtual int	trybind (const char *name, void *&pointer)
virtual int	find (const char *name, void *&pointer)
virtual int	find (const char *name)
virtual int	unbind (const char *name)
virtual int	unbind (const char *name, void *&pointer)
virtual int	sync (ssize_t len=-1, int flags=MS_SYNC)
virtual int	sync (void *addr, size_t len, int flags=MS_SYNC)
virtual int	protect (ssize_t len=-1, int prot=PROT_RDWR)
virtual int	protect (void *addr, size_t len, int prot=PROT_RDWR)
virtual void	dump () const
T *	pool ()
Public Member Functions inherited from ACE_Allocator
	ACE_Allocator (void)
virtual	~ACE_Allocator (void)

Private Attributes
bool	firstTime_
	is this the first time this is allocated? More...
T	pool_ [N]
	the pool of allocated memory. More...

Additional Inherited Members
Public Types inherited from ACE_Allocator
typedef size_t	size_type
Static Public Member Functions inherited from ACE_Allocator
static ACE_Allocator *	instance (void)
static ACE_Allocator *	instance (ACE_Allocator *)
static void	close_singleton (void)

Detailed Description

template<class T, std::size_t N>
class OpenDDS::DCPS::FirstTimeFastAllocator< T, N >

This allocator is "Fast" because it's pool can be on the stack (If the object is on the stack and hence it does not require the cost of allocating and deallocating on the heap. It object is on the heap then it requires just one allocation; not two.) WARNING The object using this allocator must not have a scope smaller than this object !!!

Definition at line 32 of file ZeroCopyAllocator_T.h.

Constructor & Destructor Documentation

FirstTimeFastAllocator()

template<class T , std::size_t N>

ACE_INLINE OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::FirstTimeFastAllocator

(

)

Definition at line 19 of file ZeroCopyAllocator_T.inl.

  : firstTime_(true)
  , pool_()
{
}

Member Function Documentation

bind()

template<class T , std::size_t N>

int OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::bind ( const char *  name, void *  pointer, int  duplicates = 0  )

virtual

Implements ACE_Allocator.

Definition at line 59 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
  ACE_UNUSED_ARG(name);
  ACE_UNUSED_ARG(pointer);
  ACE_UNUSED_ARG(duplicates);
  return -1;
}

calloc() [1/2]

template<class T , std::size_t N>

void * OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::calloc ( size_t  nbytes, char  initial_value = '\0'  )

virtual

These methods are no-ops.

Implements ACE_Allocator.

Definition at line 31 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_UNUSED_ARG(nbytes);
  ACE_UNUSED_ARG(initial_value);
  return (void*)0;
}

calloc() [2/2]

template<class T , std::size_t N>

void * OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::calloc ( size_t  n_elem, size_t  elem_size, char  initial_value = '\0'  )

virtual

Implements ACE_Allocator.

Definition at line 40 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_UNUSED_ARG(n_elem);
  ACE_UNUSED_ARG(elem_size);
  ACE_UNUSED_ARG(initial_value);
  return (void*)0;
}

dump()

template<class T , std::size_t N>

void OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::dump ( void  ) const

virtual

Implements ACE_Allocator.

Definition at line 181 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
}

find() [1/2]

template<class T , std::size_t N>

int OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::find ( const char *  name, void *&  pointer  )

virtual

Implements ACE_Allocator.

Definition at line 82 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
  ACE_UNUSED_ARG(name);
  ACE_UNUSED_ARG(pointer);
  return -1;
}

find() [2/2]

template<class T , std::size_t N>

int OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::find ( const char *  name )

virtual

Implements ACE_Allocator.

Definition at line 93 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
  ACE_UNUSED_ARG(name);
  return -1;
}

free()

template<class T , std::size_t N>

ACE_INLINE void OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::free ( void *  ptr )

virtual

Implements ACE_Allocator.

Definition at line 47 of file ZeroCopyAllocator_T.inl.

{
  if (ptr != (void*) pool_) {
#if defined (ACE_HAS_ALLOC_HOOKS)
     ACE_Allocator::instance()->free(ptr);
#else
    ACE_OS::free(ptr);
#endif /* ACE_HAS_ALLOC_HOOKS */
  }
}

malloc()

template<class T , std::size_t N>

ACE_INLINE void * OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::malloc ( size_t  nbytes )

virtual

Implements ACE_Allocator.

Definition at line 30 of file ZeroCopyAllocator_T.inl.

{
  if (firstTime_ && nbytes <= N * sizeof(T)) {
    firstTime_ = false;
    return (void*) pool_;

  } else {
#if defined (ACE_HAS_ALLOC_HOOKS)
    return ACE_Allocator::instance()->malloc(nbytes);
#else
    return ACE_OS::malloc(nbytes);
#endif /* ACE_HAS_ALLOC_HOOKS */
  }
}

pool()

template<class T, std::size_t N>

T* OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::pool ( void  )

inline

Definition at line 57 of file ZeroCopyAllocator_T.h.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::swap().

            {
    return pool_;
  }

protect() [1/2]

template<class T , std::size_t N>

int OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::protect ( ssize_t  len = -1, int  prot = PROT_RDWR  )

virtual

Implements ACE_Allocator.

Definition at line 147 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
  ACE_UNUSED_ARG(len);
  ACE_UNUSED_ARG(prot);
  return -1;
}

protect() [2/2]

template<class T , std::size_t N>

int OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::protect ( void *  addr, size_t  len, int  prot = PROT_RDWR  )

virtual

Implements ACE_Allocator.

Definition at line 158 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
  ACE_UNUSED_ARG(addr);
  ACE_UNUSED_ARG(len);
  ACE_UNUSED_ARG(prot);
  return -1;
}

remove()

template<class T , std::size_t N>

int OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::remove ( void  )

virtual

Implements ACE_Allocator.

Definition at line 50 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
  return -1;
}

sync() [1/2]

template<class T , std::size_t N>

int OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::sync ( ssize_t  len = -1, int  flags = MS_SYNC  )

virtual

Implements ACE_Allocator.

Definition at line 124 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
  ACE_UNUSED_ARG(len);
  ACE_UNUSED_ARG(flags);
  return -1;
}

sync() [2/2]

template<class T , std::size_t N>

int OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::sync ( void *  addr, size_t  len, int  flags = MS_SYNC  )

virtual

Implements ACE_Allocator.

Definition at line 135 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
  ACE_UNUSED_ARG(addr);
  ACE_UNUSED_ARG(len);
  ACE_UNUSED_ARG(flags);
  return -1;
}

trybind()

template<class T , std::size_t N>

int OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::trybind ( const char *  name, void *&  pointer  )

virtual

Implements ACE_Allocator.

Definition at line 71 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
  ACE_UNUSED_ARG(name);
  ACE_UNUSED_ARG(pointer);
  return -1;
}

unbind() [1/2]

template<class T , std::size_t N>

int OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::unbind ( const char *  name )

virtual

Implements ACE_Allocator.

Definition at line 103 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
  ACE_UNUSED_ARG(name);
  return -1;
}

unbind() [2/2]

template<class T , std::size_t N>

int OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::unbind ( const char *  name, void *&  pointer  )

virtual

Implements ACE_Allocator.

Definition at line 113 of file ZeroCopyAllocator_T.cpp.

{/* no-op */
  ACE_ERROR((LM_ERROR,
             ACE_TEXT("(%P|%t) %T not supported %a\n"))) ;
  ACE_UNUSED_ARG(name);
  ACE_UNUSED_ARG(pointer);
  return -1;
}

Member Data Documentation

firstTime_

template<class T, std::size_t N>

bool OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::firstTime_

private

is this the first time this is allocated?

Definition at line 63 of file ZeroCopyAllocator_T.h.

pool_

template<class T, std::size_t N>

T OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::pool_[N]

private

the pool of allocated memory.

Definition at line 66 of file ZeroCopyAllocator_T.h.

Referenced by OpenDDS::DCPS::FirstTimeFastAllocator< OpenDDS::DCPS::ReceivedDataElement *, DEF_MAX >::pool().

---

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

• ZeroCopyAllocator_T.h
• ZeroCopyAllocator_T.cpp
• ZeroCopyAllocator_T.inl