Back to index

lightning-sunbird  0.9+nobinonly
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes
nsBaseHashtableMT< KeyClass, DataType, UserDataType > Class Template Reference

This class is a thread-safe version of nsBaseHashtable. More...

#include <nsBaseHashtable.h>

Inheritance diagram for nsBaseHashtableMT< KeyClass, DataType, UserDataType >:
Inheritance graph
[legend]
Collaboration diagram for nsBaseHashtableMT< KeyClass, DataType, UserDataType >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef nsBaseHashtable
< KeyClass, DataType,
UserDataType >::EntryType 
EntryType
typedef nsBaseHashtable
< KeyClass, DataType,
UserDataType >::KeyType 
KeyType
 KeyType is typedef'ed for ease of use.
typedef nsBaseHashtable
< KeyClass, DataType,
UserDataType >::EnumFunction 
EnumFunction
typedef nsBaseHashtable
< KeyClass, DataType,
UserDataType >
::EnumReadFunction 
EnumReadFunction

Public Member Functions

 nsBaseHashtableMT ()
 ~nsBaseHashtableMT ()
PRBool Init (PRUint32 initSize=PL_DHASH_MIN_SIZE)
 Initialize the object.
PRBool IsInitialized () const
 Check whether the table has been initialized.
PRUint32 Count () const
 Return the number of entries in the table.
PRBool Get (KeyType aKey, UserDataType *pData) const
 retrieve the value for a key.
PRBool Put (KeyType aKey, UserDataType aData)
 put a new value for the associated key
void Remove (KeyType aKey)
 remove the data for the associated key
PRUint32 EnumerateRead (EnumReadFunction enumFunc, void *userArg) const
PRUint32 Enumerate (EnumFunction enumFunc, void *userArg)
void Clear ()
 reset the hashtable, removing all entries

Protected Types

typedef PLDHashOperator(* PR_CALLBACK )(KeyType aKey, UserDataType aData, void *userArg)
 function type provided by the application for enumeration.
typedef PLDHashOperator(* PR_CALLBACK )(KeyType aKey, DataType &aData, void *userArg)
 function type provided by the application for enumeration.
typedef nsBaseHashtableET
< KeyClass, DataType >
::KeyTypePointer 
KeyTypePointer
 KeyTypePointer is typedef'ed for ease of use.

Protected Member Functions

PRUint32 EnumerateRead (EnumReadFunction enumFunc, void *userArg) const
 enumerate entries in the hashtable, without allowing changes
PRUint32 Enumerate (EnumFunction enumFunc, void *userArg)
 enumerate entries in the hashtable, allowing changes.
nsBaseHashtableET< KeyClass,
DataType > * 
GetEntry (KeyType aKey) const
 Get the entry associated with a key.
nsBaseHashtableET< KeyClass,
DataType > * 
PutEntry (KeyType aKey)
 Get the entry associated with a key, or create a new entry,.
void RemoveEntry (KeyType aKey)
 Remove the entry associated with a key.
void RawRemoveEntry (nsBaseHashtableET< KeyClass, DataType > *aEntry)
 Remove the entry associated with a key, but don't resize the hashtable.
PRUint32 EnumerateEntries (Enumerator enumFunc, void *userArg)
 Enumerate all the entries of the function.

Static Protected Member Functions

static PLDHashOperator s_EnumReadStub (PLDHashTable *table, PLDHashEntryHdr *hdr, PRUint32 number, void *arg)
static PLDHashOperator s_EnumStub (PLDHashTable *table, PLDHashEntryHdr *hdr, PRUint32 number, void *arg)
static const void *PR_CALLBACK s_GetKey (PLDHashTable *table, PLDHashEntryHdr *entry)
static PLDHashNumber PR_CALLBACK s_HashKey (PLDHashTable *table, const void *key)
static PRBool PR_CALLBACK s_MatchEntry (PLDHashTable *table, const PLDHashEntryHdr *entry, const void *key)
static void PR_CALLBACK s_CopyEntry (PLDHashTable *table, const PLDHashEntryHdr *from, PLDHashEntryHdr *to)
static void PR_CALLBACK s_ClearEntry (PLDHashTable *table, PLDHashEntryHdr *entry)
static PRBool PR_CALLBACK s_InitEntry (PLDHashTable *table, PLDHashEntryHdr *entry, const void *key)

Protected Attributes

PRLockmLock
PLDHashTable mTable

Detailed Description

template<class KeyClass, class DataType, class UserDataType>
class nsBaseHashtableMT< KeyClass, DataType, UserDataType >

This class is a thread-safe version of nsBaseHashtable.

Definition at line 262 of file nsBaseHashtable.h.


Member Typedef Documentation

template<class KeyClass, class DataType, class UserDataType>
typedef nsBaseHashtable<KeyClass,DataType,UserDataType>::EntryType nsBaseHashtableMT< KeyClass, DataType, UserDataType >::EntryType

Reimplemented from nsBaseHashtable< KeyClass, DataType, UserDataType >.

Definition at line 267 of file nsBaseHashtable.h.

template<class KeyClass, class DataType, class UserDataType>
typedef nsBaseHashtable<KeyClass,DataType,UserDataType>::EnumFunction nsBaseHashtableMT< KeyClass, DataType, UserDataType >::EnumFunction

Definition at line 271 of file nsBaseHashtable.h.

template<class KeyClass, class DataType, class UserDataType>
typedef nsBaseHashtable<KeyClass,DataType,UserDataType>::EnumReadFunction nsBaseHashtableMT< KeyClass, DataType, UserDataType >::EnumReadFunction

Definition at line 273 of file nsBaseHashtable.h.

template<class KeyClass, class DataType, class UserDataType>
typedef nsBaseHashtable<KeyClass,DataType,UserDataType>::KeyType nsBaseHashtableMT< KeyClass, DataType, UserDataType >::KeyType
typedef nsBaseHashtableET< KeyClass, DataType > ::KeyTypePointer nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::KeyTypePointer [inherited]

KeyTypePointer is typedef'ed for ease of use.

Definition at line 144 of file nsTHashtable.h.

template<class KeyClass, class DataType, class UserDataType>
typedef PLDHashOperator(* nsBaseHashtable< KeyClass, DataType, UserDataType >::PR_CALLBACK)(KeyType aKey, UserDataType aData, void *userArg) [inherited]

function type provided by the application for enumeration.

Parameters:
aKeythe key being enumerated
aDatadata being enumerated userArg passed unchanged from Enumerate
Returns:
either PL_DHASH_NEXT or PL_DHASH_STOP

Reimplemented from nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >.

Definition at line 171 of file nsBaseHashtable.h.

template<class KeyClass, class DataType, class UserDataType>
typedef PLDHashOperator(* nsBaseHashtable< KeyClass, DataType, UserDataType >::PR_CALLBACK)(KeyType aKey, DataType &aData, void *userArg) [inherited]

function type provided by the application for enumeration.

Parameters:
aKeythe key being enumerated
aDataReference to data being enumerated, may be altered. e.g. for nsInterfaceHashtable this is an nsCOMPtr reference... userArg passed unchanged from Enumerate
Returns:
bitflag combination of PLDHashOperator::PL_DHASH_REMOVE, PL_DHASH_NEXT , or PL_DHASH_STOP

Reimplemented from nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >.

Definition at line 203 of file nsBaseHashtable.h.


Constructor & Destructor Documentation

template<class KeyClass, class DataType, class UserDataType>
nsBaseHashtableMT< KeyClass, DataType, UserDataType >::nsBaseHashtableMT ( ) [inline]

Definition at line 275 of file nsBaseHashtable.h.

: mLock(nsnull) { }
template<class KeyClass , class DataType , class UserDataType >
nsBaseHashtableMT< KeyClass, DataType, UserDataType >::~nsBaseHashtableMT ( )

Definition at line 355 of file nsBaseHashtable.h.

{
  if (this->mLock)
    PR_DestroyLock(this->mLock);
}

Here is the call graph for this function:


Member Function Documentation

template<class KeyClass , class DataType , class UserDataType >
void nsBaseHashtableMT< KeyClass, DataType, UserDataType >::Clear ( void  )

reset the hashtable, removing all entries

Reimplemented from nsBaseHashtable< KeyClass, DataType, UserDataType >.

Definition at line 448 of file nsBaseHashtable.h.

Here is the call graph for this function:

template<class KeyClass , class DataType , class UserDataType >
PRUint32 nsBaseHashtableMT< KeyClass, DataType, UserDataType >::Count ( void  ) const

Return the number of entries in the table.

Returns:
number of entries

Reimplemented from nsBaseHashtable< KeyClass, DataType, UserDataType >.

Definition at line 376 of file nsBaseHashtable.h.

Here is the call graph for this function:

template<class KeyClass, class DataType, class UserDataType>
PRUint32 nsBaseHashtable< KeyClass, DataType, UserDataType >::Enumerate ( EnumFunction  enumFunc,
void userArg 
) [inline, inherited]

enumerate entries in the hashtable, allowing changes.

This functions write-locks the hashtable.

Parameters:
enumFuncenumeration callback
userArgpassed unchanged to the EnumFunction

Definition at line 213 of file nsBaseHashtable.h.

  {
    NS_ASSERTION(this->mTable.entrySize,
                 "nsBaseHashtable was not initialized properly.");

    s_EnumArgs enumData = { enumFunc, userArg };
    return PL_DHashTableEnumerate(&this->mTable,
                                  s_EnumStub,
                                  &enumData);
  }

Here is the caller graph for this function:

template<class KeyClass , class DataType , class UserDataType >
PRUint32 nsBaseHashtableMT< KeyClass, DataType, UserDataType >::Enumerate ( EnumFunction  enumFunc,
void userArg 
)

Definition at line 436 of file nsBaseHashtable.h.

Here is the call graph for this function:

PRUint32 nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::EnumerateEntries ( Enumerator  enumFunc,
void userArg 
) [inline, inherited]

Enumerate all the entries of the function.

Parameters:
enumFuncthe Enumerator function to call
userArga pointer to pass to the Enumerator function
Returns:
the number of entries actually enumerated

Definition at line 233 of file nsTHashtable.h.

  {
    NS_ASSERTION(mTable.entrySize, "nsTHashtable was not initialized properly.");
    
    s_EnumArgs args = { enumFunc, userArg };
    return PL_DHashTableEnumerate(&mTable, s_EnumStub, &args);
  }
template<class KeyClass, class DataType, class UserDataType>
PRUint32 nsBaseHashtable< KeyClass, DataType, UserDataType >::EnumerateRead ( EnumReadFunction  enumFunc,
void userArg 
) const [inline, inherited]

enumerate entries in the hashtable, without allowing changes

Parameters:
enumFuncenumeration callback
userArgpassed unchanged to the EnumReadFunction

Definition at line 180 of file nsBaseHashtable.h.

  {
    NS_ASSERTION(this->mTable.entrySize,
                 "nsBaseHashtable was not initialized properly.");

    s_EnumReadArgs enumData = { enumFunc, userArg };
    return PL_DHashTableEnumerate(NS_CONST_CAST(PLDHashTable*, &this->mTable),
                                  s_EnumReadStub,
                                  &enumData);
  }

Here is the caller graph for this function:

template<class KeyClass , class DataType , class UserDataType >
PRUint32 nsBaseHashtableMT< KeyClass, DataType, UserDataType >::EnumerateRead ( EnumReadFunction  enumFunc,
void userArg 
) const

Definition at line 423 of file nsBaseHashtable.h.

Here is the call graph for this function:

template<class KeyClass , class DataType , class UserDataType>
PRBool nsBaseHashtableMT< KeyClass, DataType, UserDataType >::Get ( KeyType  aKey,
UserDataType *  pData 
) const

retrieve the value for a key.

Parameters:
aKeythe key to retreive
pDatadata associated with this key will be placed at this pointer. If you only need to check if the key exists, pData may be null.
Returns:
PR_TRUE if the key exists. If key does not exist, pData is not modified.

Reimplemented from nsBaseHashtable< KeyClass, DataType, UserDataType >.

Reimplemented in nsRefPtrHashtableMT< KeyClass, RefPtr >, nsInterfaceHashtableMT< KeyClass, Interface >, and nsClassHashtableMT< KeyClass, T >.

Definition at line 387 of file nsBaseHashtable.h.

Here is the call graph for this function:

nsBaseHashtableET< KeyClass, DataType > * nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::GetEntry ( KeyType  aKey) const [inline, inherited]

Get the entry associated with a key.

Parameters:
aKeythe key to retrieve
Returns:
pointer to the entry class, if the key exists; nsnull if the key doesn't exist

Definition at line 158 of file nsTHashtable.h.

  {
    NS_ASSERTION(mTable.entrySize, "nsTHashtable was not initialized properly.");
  
    EntryType* entry =
      NS_REINTERPRET_CAST(EntryType*,
                          PL_DHashTableOperate(
                            NS_CONST_CAST(PLDHashTable*,&mTable),
                            EntryType::KeyToPointer(aKey),
                            PL_DHASH_LOOKUP));
    return PL_DHASH_ENTRY_IS_BUSY(entry) ? entry : nsnull;
  }

Here is the caller graph for this function:

template<class KeyClass , class DataType , class UserDataType >
PRBool nsBaseHashtableMT< KeyClass, DataType, UserDataType >::Init ( PRUint32  initSize = PL_DHASH_MIN_SIZE)

Initialize the object.

Parameters:
initSizethe initial number of buckets in the hashtable, default 16 locking on all class methods
Returns:
PR_TRUE if the object was initialized properly.

Reimplemented from nsBaseHashtable< KeyClass, DataType, UserDataType >.

Definition at line 363 of file nsBaseHashtable.h.

{
  if (!nsTHashtable<EntryType>::IsInitialized() && !nsTHashtable<EntryType>::Init(initSize))
    return PR_FALSE;

  this->mLock = PR_NewLock();
  NS_WARN_IF_FALSE(this->mLock, "Error creating lock during nsBaseHashtableL::Init()");

  return (this->mLock != nsnull);
}

Here is the call graph for this function:

template<class KeyClass, class DataType, class UserDataType>
PRBool nsBaseHashtableMT< KeyClass, DataType, UserDataType >::IsInitialized ( ) const [inline]

Check whether the table has been initialized.

This function is especially useful for static hashtables.

Returns:
PR_TRUE if the table has been initialized.

Reimplemented from nsBaseHashtable< KeyClass, DataType, UserDataType >.

Definition at line 279 of file nsBaseHashtable.h.

{ return (PRBool) mLock; }
template<class KeyClass , class DataType , class UserDataType>
PRBool nsBaseHashtableMT< KeyClass, DataType, UserDataType >::Put ( KeyType  aKey,
UserDataType  aData 
)

put a new value for the associated key

Parameters:
aKeythe key to put
aDatathe new data
Returns:
always PR_TRUE, unless memory allocation failed

Reimplemented from nsBaseHashtable< KeyClass, DataType, UserDataType >.

Definition at line 400 of file nsBaseHashtable.h.

Here is the call graph for this function:

nsBaseHashtableET< KeyClass, DataType > * nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::PutEntry ( KeyType  aKey) [inline, inherited]

Get the entry associated with a key, or create a new entry,.

Parameters:
aKeythe key to retrieve
Returns:
pointer to the entry class retreived; nsnull only if memory can't be allocated

Definition at line 177 of file nsTHashtable.h.

  {
    NS_ASSERTION(mTable.entrySize, "nsTHashtable was not initialized properly.");
    
    return NS_STATIC_CAST(EntryType*,
                          PL_DHashTableOperate(
                            &mTable,
                            EntryType::KeyToPointer(aKey),
                            PL_DHASH_ADD));
  }

Here is the caller graph for this function:

void nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::RawRemoveEntry ( nsBaseHashtableET< KeyClass, DataType > *  aEntry) [inline, inherited]

Remove the entry associated with a key, but don't resize the hashtable.

This is a low-level method, and is not recommended unless you know what you're doing and you need the extra performance. This method can be used during enumeration, while RemoveEntry() cannot.

Parameters:
aEntrythe entry-pointer to remove (obtained from GetEntry or the enumerator

Definition at line 209 of file nsTHashtable.h.

template<class KeyClass , class DataType , class UserDataType >
void nsBaseHashtableMT< KeyClass, DataType, UserDataType >::Remove ( KeyType  aKey)

remove the data for the associated key

Parameters:
aKeythe key to remove from the hashtable

Reimplemented from nsBaseHashtable< KeyClass, DataType, UserDataType >.

Definition at line 413 of file nsBaseHashtable.h.

Here is the call graph for this function:

void nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::RemoveEntry ( KeyType  aKey) [inline, inherited]

Remove the entry associated with a key.

Parameters:
aKeyof the entry to remove

Definition at line 192 of file nsTHashtable.h.

  {
    NS_ASSERTION(mTable.entrySize, "nsTHashtable was not initialized properly.");

    PL_DHashTableOperate(&mTable,
                         EntryType::KeyToPointer(aKey),
                         PL_DHASH_REMOVE);
  }

Here is the caller graph for this function:

static void PR_CALLBACK nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::s_ClearEntry ( PLDHashTable table,
PLDHashEntryHdr entry 
) [static, protected, inherited]
static void PR_CALLBACK nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::s_CopyEntry ( PLDHashTable table,
const PLDHashEntryHdr from,
PLDHashEntryHdr to 
) [static, protected, inherited]
template<class KeyClass , class DataType , class UserDataType >
PLDHashOperator nsBaseHashtable< KeyClass, DataType, UserDataType >::s_EnumReadStub ( PLDHashTable table,
PLDHashEntryHdr hdr,
PRUint32  number,
void arg 
) [static, protected, inherited]

Definition at line 322 of file nsBaseHashtable.h.

{
  EntryType* ent = NS_STATIC_CAST(EntryType*, hdr);
  s_EnumReadArgs* eargs = (s_EnumReadArgs*) arg;

  PLDHashOperator res = (eargs->func)(ent->GetKey(), ent->mData, eargs->userArg);

  NS_ASSERTION( !(res & PL_DHASH_REMOVE ),
                "PL_DHASH_REMOVE return during const enumeration; ignoring.");

  if (res & PL_DHASH_STOP)
    return PL_DHASH_STOP;

  return PL_DHASH_NEXT;
}

Here is the caller graph for this function:

template<class KeyClass , class DataType , class UserDataType >
PLDHashOperator nsBaseHashtable< KeyClass, DataType, UserDataType >::s_EnumStub ( PLDHashTable table,
PLDHashEntryHdr hdr,
PRUint32  number,
void arg 
) [static, protected, inherited]

Reimplemented from nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >.

Definition at line 341 of file nsBaseHashtable.h.

{
  EntryType* ent = NS_STATIC_CAST(EntryType*, hdr);
  s_EnumArgs* eargs = (s_EnumArgs*) arg;

  return (eargs->func)(ent->GetKey(), ent->mData, eargs->userArg);
}

Here is the caller graph for this function:

static const void* PR_CALLBACK nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::s_GetKey ( PLDHashTable table,
PLDHashEntryHdr entry 
) [static, protected, inherited]
static PLDHashNumber PR_CALLBACK nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::s_HashKey ( PLDHashTable table,
const void key 
) [static, protected, inherited]
static PRBool PR_CALLBACK nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::s_InitEntry ( PLDHashTable table,
PLDHashEntryHdr entry,
const void key 
) [static, protected, inherited]
static PRBool PR_CALLBACK nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::s_MatchEntry ( PLDHashTable table,
const PLDHashEntryHdr entry,
const void key 
) [static, protected, inherited]

Member Data Documentation

template<class KeyClass, class DataType, class UserDataType>
PRLock* nsBaseHashtableMT< KeyClass, DataType, UserDataType >::mLock [protected]

Definition at line 290 of file nsBaseHashtable.h.

PLDHashTable nsTHashtable< nsBaseHashtableET< KeyClass, DataType > >::mTable [protected, inherited]

Definition at line 252 of file nsTHashtable.h.


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