C++ Client API Reference for Oracle Coherence: coherence/util/SafeHashSet.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_SAFE_HASH_SET_HPP
00008 #define COH_SAFE_HASH_SET_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/util/MappedSet.hpp"
00013 
00014 COH_OPEN_NAMESPACE2(coherence,util)
00015 
00016 /**
00017  * A thread-safe Set implementation which is backed by a SafeHashMap.
00018  *
00019  * @author lh  2012.08.23
00020  * @since Coherence 12.1.2
00021  */
00022 class COH_EXPORT SafeHashSet
00023     : public cloneable_spec<SafeHashSet,
00024         extends<MappedSet> >
00025     {
00026     friend class factory<SafeHashSet>;
00027 
00028     // ----- constructors ---------------------------------------------------
00029 
00030     protected:
00031         /**
00032          * Default constructor.
00033          */
00034         SafeHashSet();
00035 
00036         /**
00037          * Construct a thread-safe hash set using the specified settings.
00038          *
00039          * @param cInitialBuckets  the initial number of hash buckets,
00040          *                         0 &lt; n
00041          * @param flLoadFactor     the acceptable load factor before resizing
00042          *                         occurs, 0 &lt; n, such that a load factor
00043          *                         of 1.0 causes resizing when the number of
00044          *                         entries exceeds the number of buckets
00045          * @param flGrowthRate     the rate of bucket growth when a resize
00046          *                         occurs, 0 &lt; n, such that a growth rate
00047          *                         of 1.0 will double the number of buckets:
00048          *                         bucketcount = bucketcount * (1 + growthrate)
00049          */
00050         SafeHashSet(size32_t cInitialBuckets, float32_t flLoadFactor,
00051             float32_t flGrowthRate);
00052 
00053         /**
00054          * Copy constructor.
00055          */
00056         SafeHashSet(const SafeHashSet& that);
00057     };
00058 
00059 COH_CLOSE_NAMESPACE2
00060 
00061 #endif // COH_SAFE_HASH_SET