ucc::keyassoc Class Reference

A class to hold memory pointers referenced by string names. More...

#include <memory.h>

Inheritance diagram for ucc::keyassoc:

Inheritance graph
[legend]
Collaboration diagram for ucc::keyassoc:

Collaboration graph
[legend]

Public Member Functions

 keyassoc (unsigned indexing=177, size_t max=0, size_t page=0)
 Create a key associated memory pointer table.
 ~keyassoc ()
 Destroy association object.
unsigned getCount (void)
 Get the number of associations we have in our object.
void * operator() (const char *name)
 Lookup the data pointer of a string by direct operation.
void purge (void)
 Purge all associations and return allocated pages to heap.
void * locate (const char *name)
 Lookup the data pointer by the string name given.
bool assign (char *name, void *pointer)
 Assign a name to a data pointer.
bool create (char *name, void *pointer)
 Create a new name in the association table and assign it's value.
void * remove (const char *name)
 Remove a name and pointer association.

Friends

class keydata

Detailed Description

A class to hold memory pointers referenced by string names.

This is used to form a typeless data pointer that can be associated and referenced by string/logical name. The memory used for forming the string names can itself be managed in reusable memory pools and the entire structure uses it's own private pager heap. This allows new string named pointers to be added and deleted at runtime in a thread- safe manner. This might typically be used as a session id manager or for symbol tables.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 381 of file memory.h.


Constructor & Destructor Documentation

ucc::keyassoc::keyassoc ( unsigned  indexing = 177,
size_t  max = 0,
size_t  page = 0 
)

Create a key associated memory pointer table.

Parameters:
indexing size for hash map.
max size of a string name if names are in reusable managed memory.
page size of memory pager.

ucc::keyassoc::~keyassoc (  ) 

Destroy association object.

Release all pages back to the heap.


Member Function Documentation

bool ucc::keyassoc::assign ( char *  name,
void *  pointer 
)

Assign a name to a data pointer.

If the name exists, it is re-assigned with the new pointer value, otherwise it is created.

Parameters:
name to assign.
pointer value to assign with name.
Returns:
false if failed because name is too long for managed table.

bool ucc::keyassoc::create ( char *  name,
void *  pointer 
)

Create a new name in the association table and assign it's value.

Parameters:
name to create.
pointer value to assign with name.
Returns:
false if already exists or name is too long for managed table.

unsigned ucc::keyassoc::getCount ( void   )  [inline]

Get the number of associations we have in our object.

Returns:
number of associations stored.

Reimplemented in ucc::assoc_pointer< T, I, M, P >.

Definition at line 422 of file memory.h.

void* ucc::keyassoc::locate ( const char *  name  ) 

Lookup the data pointer by the string name given.

Parameters:
name to lookup.
Returns:
pointer to data or NULL if not found.

Reimplemented in ucc::assoc_pointer< T, I, M, P >.

void* ucc::keyassoc::operator() ( const char *  name  )  [inline]

Lookup the data pointer of a string by direct operation.

Parameters:
name to lookup.
Returns:
pointer to data or NULL if not found.

Reimplemented in ucc::assoc_pointer< T, I, M, P >.

Definition at line 430 of file memory.h.

void* ucc::keyassoc::remove ( const char *  name  ) 

Remove a name and pointer association.

If managed key names are used then the memory allocated for the name will be re-used.

Parameters:
name to remove.
Returns:
pointer value of the name or NULL if not found.


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

Generated on Tue Jul 28 21:43:30 2009 for UCommon by  doxygen 1.5.9