ACE_Allocator_Adapter< MALLOC > Class Template Reference

This class is an adapter that allows the ACE_Allocator to use the ACE_Malloc class below. More...

#include <Malloc_T.h>

Inheritance diagram for ACE_Allocator_Adapter< MALLOC >:

[legend]

Collaboration diagram for ACE_Allocator_Adapter< MALLOC >:

[legend]

List of all members.

Public Types
typedef MALLOC	ALLOCATOR
typedef const MALLOC::MEMORY_POOL_OPTIONS *	MEMORY_POOL_OPTIONS
Public Member Functions
	ACE_Allocator_Adapter (const char *pool_name=0)
	ACE_Allocator_Adapter (const char *pool_name, const char *lock_name, MEMORY_POOL_OPTIONS options=0)
	ACE_Allocator_Adapter (const wchar_t *pool_name)
	ACE_Allocator_Adapter (const wchar_t *pool_name, const wchar_t *lock_name, MEMORY_POOL_OPTIONS options=0)
virtual	~ACE_Allocator_Adapter (void)
	Destructor.
virtual void *	malloc (size_t nbytes)
	Allocate nbytes, but don't give them any initial value.
virtual void *	calloc (size_t nbytes, char initial_value= '\0')
	Allocate nbytes, giving them all an initial_value.
virtual void *	calloc (size_t n_elem, size_t elem_size, char initial_value= '\0')
virtual void	free (void *ptr)
	Free ptr (must have been allocated by ACE_Allocator::malloc()).
virtual int	remove (void)
	Remove any resources associated with this memory manager.
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)
	Returns 0 if the name is in the mapping and -1 if not.
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)
ALLOCATOR &	alloc (void)
	Returns the underlying allocator.
virtual void	dump (void) const
	Dump the state of the object.
Private Attributes
ALLOCATOR	allocator_
	ALLOCATOR instance, which is owned by the adapter.

---

Detailed Description

template<class MALLOC>
class ACE_Allocator_Adapter< MALLOC >

This class is an adapter that allows the ACE_Allocator to use the ACE_Malloc class below.

---

Member Typedef Documentation

template<class MALLOC>

typedef MALLOC ACE_Allocator_Adapter< MALLOC >::ALLOCATOR

template<class MALLOC>

typedef const MALLOC::MEMORY_POOL_OPTIONS* ACE_Allocator_Adapter< MALLOC >::MEMORY_POOL_OPTIONS

---

Constructor & Destructor Documentation

template<class MALLOC>

ACE_Allocator_Adapter< MALLOC >::ACE_Allocator_Adapter

(

const char *

pool_name = 0

)

[inline]

Note that pool_name should be located in a directory with the appropriate visibility and protection so that all processes that need to access it can do so.

template<class MALLOC>

ACE_Allocator_Adapter< MALLOC >::ACE_Allocator_Adapter	(	const char *	pool_name,
		const char *	lock_name,
		MEMORY_POOL_OPTIONS	options = 0
	)			[inline]

Note that pool_name should be located in a directory with the appropriate visibility and protection so that all processes that need to access it can do so. This constructor must be inline to avoid bugs with some C++ compilers.

template<class MALLOC>

ACE_Allocator_Adapter< MALLOC >::ACE_Allocator_Adapter

(

const wchar_t *

pool_name

)

[inline]

Note that pool_name should be located in a directory with the appropriate visibility and protection so that all processes that need to access it can do so.

template<class MALLOC>

ACE_Allocator_Adapter< MALLOC >::ACE_Allocator_Adapter	(	const wchar_t *	pool_name,
		const wchar_t *	lock_name,
		MEMORY_POOL_OPTIONS	options = 0
	)			[inline]

Note that pool_name should be located in a directory with the appropriate visibility and protection so that all processes that need to access it can do so. This constructor must be inline to avoid bugs with some C++ compilers.

template<class MALLOC>

ACE_Allocator_Adapter< MALLOC >::~ACE_Allocator_Adapter

(

void

)

[inline, virtual]

Destructor.

---

Member Function Documentation

template<class MALLOC>

void * ACE_Allocator_Adapter< MALLOC >::malloc

(

size_t

nbytes

)

[inline, virtual]

Allocate nbytes, but don't give them any initial value.

Implements ACE_Allocator.

template<class MALLOC>

void * ACE_Allocator_Adapter< MALLOC >::calloc	(	size_t	nbytes,
		char	initial_value = '\0'
	)			[inline, virtual]

Allocate nbytes, giving them all an initial_value.

Implements ACE_Allocator.

template<class MALLOC>

void * ACE_Allocator_Adapter< MALLOC >::calloc	(	size_t	n_elem,
		size_t	elem_size,
		char	initial_value = '\0'
	)			[inline, virtual]

Allocate n_elem each of size elem_size, giving them initial_value.

Implements ACE_Allocator.

template<class MALLOC>

void ACE_Allocator_Adapter< MALLOC >::free

(

void *

ptr

)

[inline, virtual]

Free ptr (must have been allocated by ACE_Allocator::malloc()).

Implements ACE_Allocator.

template<class MALLOC>

int ACE_Allocator_Adapter< MALLOC >::remove

(

void

)

[inline, virtual]

Remove any resources associated with this memory manager.

Implements ACE_Allocator.

template<class MALLOC>

int ACE_Allocator_Adapter< MALLOC >::bind	(	const char *	name,
		void *	pointer,
		int	duplicates = 0
	)			[inline, virtual]

Associate name with pointer. If duplicates == 0 then do not allow duplicate name/pointer associations, else if duplicates != 0 then allow duplicate name/pointer assocations. Returns 0 if successfully binds (1) a previously unbound name or (2) duplicates != 0, returns 1 if trying to bind a previously bound name and duplicates == 0, else returns -1 if a resource failure occurs.

Implements ACE_Allocator.

template<class MALLOC>

int ACE_Allocator_Adapter< MALLOC >::trybind	(	const char *	name,
		void *&	pointer
	)			[inline, virtual]

Associate name with pointer. Does not allow duplicate name/pointer associations. Returns 0 if successfully binds (1) a previously unbound name, 1 if trying to bind a previously bound name, or returns -1 if a resource failure occurs. When this call returns, pointer's value will always reference the void * that name is associated with. Thus, if the caller needs to use pointer (e.g., to free it) a copy must be maintained by the caller.

Implements ACE_Allocator.

template<class MALLOC>

int ACE_Allocator_Adapter< MALLOC >::find	(	const char *	name,
		void *&	pointer
	)			[inline, virtual]

Locate name and pass out parameter via pointer. If found, return 0, returns -1 if name isn't found.

Implements ACE_Allocator.

template<class MALLOC>

int ACE_Allocator_Adapter< MALLOC >::find

(

const char *

name

)

[inline, virtual]

Returns 0 if the name is in the mapping and -1 if not.

Implements ACE_Allocator.

template<class MALLOC>

int ACE_Allocator_Adapter< MALLOC >::unbind

(

const char *

name

)

[inline, virtual]

Unbind (remove) the name from the map. Don't return the pointer to the caller

Implements ACE_Allocator.

template<class MALLOC>

int ACE_Allocator_Adapter< MALLOC >::unbind	(	const char *	name,
		void *&	pointer
	)			[inline, virtual]

Break any association of name. Returns the value of pointer in case the caller needs to deallocate memory.

Implements ACE_Allocator.

template<class MALLOC>

int ACE_Allocator_Adapter< MALLOC >::sync	(	ssize_t	len = -1,
		int	flags = MS_SYNC
	)			[inline, virtual]

Sync len bytes of the memory region to the backing store starting at this->base_addr_. If len == -1 then sync the whole region.

Implements ACE_Allocator.

template<class MALLOC>

int ACE_Allocator_Adapter< MALLOC >::sync	(	void *	addr,
		size_t	len,
		int	flags = MS_SYNC
	)			[inline, virtual]

Sync len bytes of the memory region to the backing store starting at addr_.

Implements ACE_Allocator.

template<class MALLOC>

int ACE_Allocator_Adapter< MALLOC >::protect	(	ssize_t	len = -1,
		int	prot = PROT_RDWR
	)			[inline, virtual]

Change the protection of the pages of the mapped region to prot starting at this->base_addr_ up to len bytes. If len == -1 then change protection of all pages in the mapped region.

Implements ACE_Allocator.

template<class MALLOC>

int ACE_Allocator_Adapter< MALLOC >::protect	(	void *	addr,
		size_t	len,
		int	prot = PROT_RDWR
	)			[inline, virtual]

Change the protection of the pages of the mapped region to prot starting at addr up to len bytes.

Implements ACE_Allocator.

template<class MALLOC>

MALLOC & ACE_Allocator_Adapter< MALLOC >::alloc

(

void

)

[inline]

Returns the underlying allocator.

template<class MALLOC>

void ACE_Allocator_Adapter< MALLOC >::dump

(

void

)

const [inline, virtual]

Dump the state of the object.

Implements ACE_Allocator.

---

Member Data Documentation

template<class MALLOC>

ALLOCATOR ACE_Allocator_Adapter< MALLOC >::allocator_ [private]

ALLOCATOR instance, which is owned by the adapter.

Reimplemented from ACE_Allocator.

---

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

• Malloc_T.h
• Malloc_T.cpp