Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

ACE_New_Allocator Class Reference

Defines a class that provided a simple implementation of memory allocation. More...

#include <Malloc_Allocator.h>

Inheritance diagram for ACE_New_Allocator:

Inheritance graph
[legend]
Collaboration diagram for ACE_New_Allocator:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual void * malloc (size_t nbytes)
 These methods are defined. More...

virtual void * calloc (size_t nbytes, char initial_value='\0')
 Allocate <nbytes>, giving them <initial_value>. More...

virtual void * calloc (size_t n_elem, size_t elem_size, char initial_value='\0')
 Allocate <n_elem> each of size <elem_size>, giving them <initial_value>. More...

virtual void free (void *ptr)
 Free <ptr> (must have been allocated by <ACE_Allocator::malloc>). More...

virtual int remove (void)
 These methods are no-ops. More...

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)
 Locate <name> and pass out parameter via pointer. If found, return 0, returns -1 if failure occurs. More...

virtual int find (const char *name)
 Returns 0 if the name is in the mapping. -1, otherwise. More...

virtual int unbind (const char *name)
 Unbind (remove) the name from the map. Don't return the pointer to the caller. More...

virtual int unbind (const char *name, void *&pointer)
 Break any association of name. Returns the value of pointer in case the caller needs to deallocate memory. More...

virtual int sync (ssize_t len=-1, int flags=MS_SYNC)
virtual int sync (void *addr, size_t len, int flags=MS_SYNC)
 Sync <len> bytes of the memory region to the backing store starting at <addr_>. More...

virtual int protect (ssize_t len=-1, int prot=PROT_RDWR)
virtual int protect (void *addr, size_t len, int prot=PROT_RDWR)
 Change the protection of the pages of the mapped region to <prot> starting at <addr> up to <len> bytes. More...

virtual void dump (void) const
 Dump the state of the object. More...


Detailed Description

Defines a class that provided a simple implementation of memory allocation.

This class uses the new/delete operators to allocate and free up memory. Please note that the only methods that are supported are <malloc>, <calloc>, and <free>. All other methods are no-ops that return -1 and set <errno> to <ENOTSUP>. If you require this functionality, please use: ACE_Allocator_Adapter <ACE_Malloc <ACE_LOCAL_MEMORY_POOL, MUTEX> >, which will allow you to use the added functionality of bind/find/etc. while using the new/delete operators.

Definition at line 54 of file Malloc_Allocator.h.


Member Function Documentation

ACE_INLINE int ACE_New_Allocator::bind const char *    name,
void *    pointer,
int    duplicates = 0
[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.

Definition at line 44 of file Malloc_Allocator.i.

00045 {
00046   ACE_NOTSUP_RETURN (-1);
00047 }

ACE_INLINE void * ACE_New_Allocator::calloc size_t    n_elem,
size_t    elem_size,
char    initial_value = '\0'
[virtual]
 

Allocate <n_elem> each of size <elem_size>, giving them <initial_value>.

Implements ACE_Allocator.

Reimplemented in ACE_Cached_Allocator.

Definition at line 26 of file Malloc_Allocator.i.

References calloc.

00027 {
00028   return ACE_New_Allocator::calloc (n_elem * elem_size, initial_value);
00029 }

ACE_INLINE void * ACE_New_Allocator::calloc size_t    nbytes,
char    initial_value = '\0'
[virtual]
 

Allocate <nbytes>, giving them <initial_value>.

Implements ACE_Allocator.

Reimplemented in ACE_Cached_Allocator.

Definition at line 14 of file Malloc_Allocator.i.

References ACE_NEW_RETURN, and ACE_OS_String::memset.

Referenced by calloc.

00016 {
00017   char *ptr = 0;
00018 
00019   ACE_NEW_RETURN (ptr, char[nbytes], 0);
00020 
00021   ACE_OS::memset (ptr, initial_value, nbytes);
00022   return (void *) ptr;
00023 }

ACE_INLINE void ACE_New_Allocator::dump void    const [virtual]
 

Dump the state of the object.

Implements ACE_Allocator.

Definition at line 111 of file Malloc_Allocator.i.

00112 {
00113 }

ACE_INLINE int ACE_New_Allocator::find const char *    name [virtual]
 

Returns 0 if the name is in the mapping. -1, otherwise.

Implements ACE_Allocator.

Definition at line 62 of file Malloc_Allocator.i.

00063 {
00064   ACE_NOTSUP_RETURN (-1);
00065 }

ACE_INLINE int ACE_New_Allocator::find const char *    name,
void *&    pointer
[virtual]
 

Locate <name> and pass out parameter via pointer. If found, return 0, returns -1 if failure occurs.

Implements ACE_Allocator.

Definition at line 56 of file Malloc_Allocator.i.

00057 {
00058   ACE_NOTSUP_RETURN (-1);
00059 }

ACE_INLINE void ACE_New_Allocator::free void *    ptr [virtual]
 

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

Implements ACE_Allocator.

Reimplemented in ACE_Cached_Allocator.

Definition at line 32 of file Malloc_Allocator.i.

00033 {
00034   delete [] (char *) ptr;
00035 }

ACE_INLINE void * ACE_New_Allocator::malloc size_t    nbytes [virtual]
 

These methods are defined.

Implements ACE_Allocator.

Reimplemented in ACE_Cached_Allocator.

Definition at line 4 of file Malloc_Allocator.i.

References ACE_NEW_RETURN.

00005 {
00006   char *ptr = 0;
00007 
00008   if (nbytes > 0)
00009     ACE_NEW_RETURN (ptr, char[nbytes], 0);
00010   return (void *) ptr;
00011 }

ACE_INLINE int ACE_New_Allocator::protect void *    addr,
size_t    len,
int    prot = PROT_RDWR
[virtual]
 

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

Implements ACE_Allocator.

Definition at line 98 of file Malloc_Allocator.i.

00099 {
00100   ACE_NOTSUP_RETURN (-1);
00101 }

ACE_INLINE int ACE_New_Allocator::protect ssize_t    len = -1,
int    prot = PROT_RDWR
[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.

Definition at line 92 of file Malloc_Allocator.i.

References ssize_t.

00093 {
00094   ACE_NOTSUP_RETURN (-1);
00095 }

ACE_INLINE int ACE_New_Allocator::remove void    [virtual]
 

These methods are no-ops.

Implements ACE_Allocator.

Definition at line 38 of file Malloc_Allocator.i.

00039 {
00040   ACE_NOTSUP_RETURN (-1);
00041 }

ACE_INLINE int ACE_New_Allocator::sync void *    addr,
size_t    len,
int    flags = MS_SYNC
[virtual]
 

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

Implements ACE_Allocator.

Definition at line 86 of file Malloc_Allocator.i.

00087 {
00088   ACE_NOTSUP_RETURN (-1);
00089 }

ACE_INLINE int ACE_New_Allocator::sync ssize_t    len = -1,
int    flags = MS_SYNC
[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.

Definition at line 80 of file Malloc_Allocator.i.

References ssize_t.

00081 {
00082   ACE_NOTSUP_RETURN (-1);
00083 }

ACE_INLINE int ACE_New_Allocator::trybind const char *    name,
void *&    pointer
[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.

Definition at line 50 of file Malloc_Allocator.i.

00051 {
00052   ACE_NOTSUP_RETURN (-1);
00053 }

ACE_INLINE int ACE_New_Allocator::unbind const char *    name,
void *&    pointer
[virtual]
 

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

Implements ACE_Allocator.

Definition at line 74 of file Malloc_Allocator.i.

00075 {
00076   ACE_NOTSUP_RETURN (-1);
00077 }

ACE_INLINE int ACE_New_Allocator::unbind const char *    name [virtual]
 

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

Implements ACE_Allocator.

Definition at line 68 of file Malloc_Allocator.i.

00069 {
00070   ACE_NOTSUP_RETURN (-1);
00071 }


The documentation for this class was generated from the following files:
Generated on Mon Jun 16 12:50:58 2003 for ACE by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002