https://sourceforge.net/p/perfcache/wiki/InitializeEx%2520Method/Recent changes to InitializeEx MethodenWed, 14 Dec 2011 20:10:12 -0000https://sourceforge.net/p/perfcache/wiki/InitializeEx%2520Method/<pre>--- v11 +++ v12 @@ -73,37 +73,36 @@ <br /> ###### Remarks:###### -The Initialize() method is used to create and initialize a cache. This method also creates and initializes an internal Directory that is used by the cache. - +The InitializeEx() method is used to create and initialize a cache. This method also creates and initializes an internal Directory that is used by the cache. + <br /> ###### Example ###### Cache *pCache = NULL; try { pCache = Cache::CacheFactory(); } catch (std::bad_alloc) { cout << "Error: insufficient memory" << endl; } struct HashFunctionStructure hashFunctionStructure; hashFunctionStructure.HashFunction = &BasicHashFunction; - int iResult = 0; - - iResult = pCache->InitializeEx (KeyTypeByteString, - 25 + 1, // 25 characters + trailing NULL - MapHashTable, // keyStorageMethod - true, // fReplaceDuplicateKeyCacheEntry - 1000, // numSecondsTTLDefault - 1333, // sizeMap - &hashFunctionStructure, - 1000, // sizeCache - LeastRecentlyUsed, - NULL, // pGlobalConfiguration - false, // fDEBUG - NULL); // pLogger + + int iResult = pCache->InitializeEx (KeyTypeByteString, + 25 + 1, // 25 characters + trailing NULL + MapHashTable, // keyStorageMethod + true, // fReplaceDuplicateKeyCacheEntry + 300, // numSecondsTTLDefault + 1333, // numDirectoryElementsToAllocate + &hashFunctionStructure, + 1000, // sizeCache + LeastRecentlyUsed, + NULL, // pGlobalConfiguration + false, // fDEBUG + NULL); // pLogger if (iResult != E_SUCCESS) { // error handling here </pre>Glenn HoffordWed, 14 Dec 2011 20:10:12 -0000https://sourceforge.net68a735b6c424936d413dcfc752490091873cc205https://sourceforge.net/p/perfcache/wiki/InitializeEx%2520Method/<pre>--- v10 +++ v11 @@ -73,7 +73,7 @@ <br /> ###### Remarks:###### -The Initialize() method is used to create and initialize a cache. This method also creates and initialized an internal Directory that is used by the cache. +The Initialize() method is used to create and initialize a cache. This method also creates and initializes an internal Directory that is used by the cache. <br /> ###### Example ###### </pre>Glenn HoffordWed, 14 Dec 2011 03:38:12 -0000https://sourceforge.net941de78d0c8905be86129cb97b0f31ef563d1398https://sourceforge.net/p/perfcache/wiki/InitializeEx%2520Method/<pre>--- v9 +++ v10 @@ -40,38 +40,40 @@ 5) numSecondsTTLDefault: the default Time-to-live (TTL) value. - 6) pHashFunctionStructure: this pointer must point to a HashFunctionStructure that has - been initialized with a hash function. - - 7) replacementPolicy: LeastRecentlyUsed or LeastFrequentlyUsed. - - 8) numDirectoryElementsToAllocate: (for the Directory, when instantiated as a hash + 6) numDirectoryElementsToAllocate: (for the Directory, when instantiated as a hash table) - the size of the directory (map). A typical value would be 133% the size of the cache. (E.g. if cache size = 1000, this would be 1333). - 9) sizeCache: the number of entries (array elements) of the cache. + 7) pHashFunctionStructure: this pointer must point to a HashFunctionStructure that has + been initialized with a hash function. + + 8) sizeCache: the number of entries (array elements) of the cache. + + 9) replacementPolicy: LeastRecentlyUsed or LeastFrequentlyUsed. 10) pGlobalConfiguration: a pointer to a GlobalConfiguration structure (this value may be NULL if custom global configuration settings are not needed). 11) fDEBUG: for debugging: this will generate additional debug output. 12) pLogger: a pointer to an initialized CLogger object. <br /> ###### Return values:###### E_CACHE_INITIALIZATION_INVALID_KEYTYPE_FOR_MAPHASHTABLE E_INSUFFICIENTMEMORY E_CACHE_INITIALIZATION_INVALID_KEYSTORAGEMETHOD E_KEY_INVALIDKEYTYPE E_CACHE_INITIALIZATION_CACHESIZE_TOO_SMALL E_CACHE_INITIALIZATION_INVALID_REPLACEMENTPOLICY E_LOGGINGFUNCTION_MISSING E_SUCCESS <br /> ###### Remarks:###### + +The Initialize() method is used to create and initialize a cache. This method also creates and initialized an internal Directory that is used by the cache. <br /> ###### Example ###### </pre>Glenn HoffordWed, 14 Dec 2011 03:05:55 -0000https://sourceforge.net60c5937308ebdcb45e42fc2c834d4cbfbb7d6f97https://sourceforge.net/p/perfcache/wiki/InitializeEx%2520Method/<pre>--- v8 +++ v9 @@ -23,34 +23,38 @@ <br /> ###### Parameters:###### - 1) keyType: only KeyTypeByteString is currently supported - - 2) lenMaxStringKeyInUnits must include space for a null-terminator byte - or word if one is needed. For example: if the max key length in words - is 128, including space for a null terminator, lenMaxStringKeyInUnits + 1) keyType: the key type: KeyTypeByteString and KeyTypeWordString are currently supported. + + 2) lenMaxStringKeyInUnits: the maximum length of a key that is passed as a parameter + to a basic operation method; for KeyTypeByteString this is a length in bytes, for + KeyTypeWordString this is a length in words. This value must include space for a + null-terminator byte or word if one is needed. For example: if the max key length + in words is 128, including space for a null terminator, lenMaxStringKeyInUnits must be 128. - 3) keyStorageMethod: only MapHashTable is currently supported - - 4) fReplaceDuplicateKeyCacheEntry: a global setting, which causes the Insert + 3) keyStorageMethod: the data structure that is used when the Directory is + instantiated. (MapHashTable is the only value that is currently supported). + + 4) fReplaceDuplicateKeyCacheEntry: a global setting that causes the Insert methods to replace duplicate key cache entries. - 5) numSecondsTTLDefault: the default Time-to-live (TTL) value - - 6) pHashFunctionStructure: must point to a HashFunctionStructure that has + 5) numSecondsTTLDefault: the default Time-to-live (TTL) value. + + 6) pHashFunctionStructure: this pointer must point to a HashFunctionStructure that has been initialized with a hash function. - 7) replacementPolicy: LRU or LFU - - 8) numDirectoryElementsToAllocate: size of map (hash table). A typical value - would be 133% the size of the cache. (E.g. if cache size = 1000, this would be 1333). - - 9) sizeCache: the number of entries (array elements) of the cache - - 10) pGlobalConfiguration: a pointer to a GlobalConfiguration structure (may be NULL, - if custom global configuration settings are not needed). - - 11) fDEBUG: for debugging + 7) replacementPolicy: LeastRecentlyUsed or LeastFrequentlyUsed. + + 8) numDirectoryElementsToAllocate: (for the Directory, when instantiated as a hash + table) - the size of the directory (map). A typical value would be 133% the size + of the cache. (E.g. if cache size = 1000, this would be 1333). + + 9) sizeCache: the number of entries (array elements) of the cache. + + 10) pGlobalConfiguration: a pointer to a GlobalConfiguration structure (this value may be + NULL if custom global configuration settings are not needed). + + 11) fDEBUG: for debugging: this will generate additional debug output. 12) pLogger: a pointer to an initialized CLogger object. </pre>Glenn HoffordWed, 14 Dec 2011 03:01:57 -0000https://sourceforge.net2ee041ff4820eba61530d6583ec75a7b218d5d7ahttps://sourceforge.net/p/perfcache/wiki/InitializeEx%2520Method/<pre>--- v7 +++ v8 @@ -5,64 +5,100 @@ InitializeEx() creates and initializes a cache object. <br /> - ###### Syntax: ###### int InitializeEx (enum KeyType keyType, unsigned int lenMaxStringKeyInUnits, enum KeyStorageMethod keyStorageMethod, bool fReplaceDuplicateKeyCacheEntry, const unsigned int numSecondsTTLDefault, const UINTEGER32 numDirectoryElementsToAllocate, struct HashFunctionStructure pHashFunctionStructure, const UINTEGER32 sizeCache, enum ReplacementPolicy replacementPolicy, struct GlobalConfiguration pGlobalConfiguration, bool fDEBUG, CLogger *pLogger); <br /> ###### Parameters:###### 1) keyType: only KeyTypeByteString is currently supported 2) lenMaxStringKeyInUnits must include space for a null-terminator byte or word if one is needed. For example: if the max key length in words is 128, including space for a null terminator, lenMaxStringKeyInUnits must be 128. 3) keyStorageMethod: only MapHashTable is currently supported 4) fReplaceDuplicateKeyCacheEntry: a global setting, which causes the Insert methods to replace duplicate key cache entries. 5) numSecondsTTLDefault: the default Time-to-live (TTL) value 6) pHashFunctionStructure: must point to a HashFunctionStructure that has been initialized with a hash function. 7) replacementPolicy: LRU or LFU 8) numDirectoryElementsToAllocate: size of map (hash table). A typical value would be 133% the size of the cache. (E.g. if cache size = 1000, this would be 1333). 9) sizeCache: the number of entries (array elements) of the cache 10) pGlobalConfiguration: a pointer to a GlobalConfiguration structure (may be NULL, if custom global configuration settings are not needed). 11) fDEBUG: for debugging 12) pLogger: a pointer to an initialized CLogger object. <br /> ###### Return values:###### E_CACHE_INITIALIZATION_INVALID_KEYTYPE_FOR_MAPHASHTABLE E_INSUFFICIENTMEMORY E_CACHE_INITIALIZATION_INVALID_KEYSTORAGEMETHOD E_KEY_INVALIDKEYTYPE E_CACHE_INITIALIZATION_CACHESIZE_TOO_SMALL E_CACHE_INITIALIZATION_INVALID_REPLACEMENTPOLICY E_LOGGINGFUNCTION_MISSING E_SUCCESS + +<br /> +###### Remarks:###### + +<br /> +###### Example ###### + + Cache *pCache = NULL; + + try + { + pCache = Cache::CacheFactory(); + } + catch (std::bad_alloc) + { + cout << "Error: insufficient memory" << endl; + } + struct HashFunctionStructure hashFunctionStructure; + hashFunctionStructure.HashFunction = &BasicHashFunction; + int iResult = 0; + + iResult = pCache->InitializeEx (KeyTypeByteString, + 25 + 1, // 25 characters + trailing NULL + MapHashTable, // keyStorageMethod + true, // fReplaceDuplicateKeyCacheEntry + 1000, // numSecondsTTLDefault + 1333, // sizeMap + &hashFunctionStructure, + 1000, // sizeCache + LeastRecentlyUsed, + NULL, // pGlobalConfiguration + false, // fDEBUG + NULL); // pLogger + if (iResult != E_SUCCESS) + { + // error handling here + } </pre>Glenn HoffordWed, 14 Dec 2011 02:54:30 -0000https://sourceforge.net59cb523a38d383b8d8d36e72964f4bf236ad6267https://sourceforge.net/p/perfcache/wiki/InitializeEx%2520Method/<pre>--- v6 +++ v7 @@ -58,11 +58,11 @@ <br /> ###### Return values:###### - E_CACHE_INITIALIZATION_INVALID_KEYTYPE_FOR_MAPHASHTABLE - E_INSUFFICIENTMEMORY - E_CACHE_INITIALIZATION_INVALID_KEYSTORAGEMETHOD - E_KEY_INVALIDKEYTYPE - E_CACHE_INITIALIZATION_CACHESIZE_TOO_SMALL - E_CACHE_INITIALIZATION_INVALID_REPLACEMENTPOLICY - E_LOGGINGFUNCTION_MISSING - E_SUCCESS + E_CACHE_INITIALIZATION_INVALID_KEYTYPE_FOR_MAPHASHTABLE + E_INSUFFICIENTMEMORY + E_CACHE_INITIALIZATION_INVALID_KEYSTORAGEMETHOD + E_KEY_INVALIDKEYTYPE + E_CACHE_INITIALIZATION_CACHESIZE_TOO_SMALL + E_CACHE_INITIALIZATION_INVALID_REPLACEMENTPOLICY + E_LOGGINGFUNCTION_MISSING + E_SUCCESS </pre>Glenn HoffordWed, 14 Dec 2011 01:58:18 -0000https://sourceforge.net8e4b5fa23f4388a87cac919a87ebf67f9dfb4cd7https://sourceforge.net/p/perfcache/wiki/InitializeEx%2520Method/<pre>--- v5 +++ v6 @@ -1,5 +1,11 @@ ##### Method: Cache::InitializeEx ##### +###### Summary: ###### + +InitializeEx() creates and initializes a cache object. + +<br /> + ###### Syntax: ###### int InitializeEx (enum KeyType keyType, </pre>Glenn HoffordWed, 14 Dec 2011 01:56:52 -0000https://sourceforge.net210fbf6affc7376a91e86fdc93683bb43123d302https://sourceforge.net/p/perfcache/wiki/InitializeEx%2520Method/<pre>--- v4 +++ v5 @@ -1,4 +1,4 @@ -#### Method: InitializeEx #### +##### Method: Cache::InitializeEx ##### ###### Syntax: ###### </pre>Glenn HoffordWed, 14 Dec 2011 01:55:14 -0000https://sourceforge.net9c55c755323344db806bfd3788007c0886ea2126https://sourceforge.net/p/perfcache/wiki/InitializeEx%2520Method/<pre></pre>Glenn HoffordWed, 14 Dec 2011 00:41:49 -0000https://sourceforge.net7d7eb70d5c25452c1816f0f108b6214647aeaacehttps://sourceforge.net/p/perfcache/wiki/InitializeEx_Method/<pre>--- v2 +++ v3 @@ -1,55 +1,56 @@ -Method: InitializeEx - -Syntax: - +#### Method: InitializeEx #### + +###### Syntax: ###### + int InitializeEx (enum KeyType keyType, unsigned int lenMaxStringKeyInUnits, enum KeyStorageMethod keyStorageMethod, bool fReplaceDuplicateKeyCacheEntry, const unsigned int numSecondsTTLDefault, const UINTEGER32 numDirectoryElementsToAllocate, struct HashFunctionStructure pHashFunctionStructure, const UINTEGER32 sizeCache, enum ReplacementPolicy replacementPolicy, struct GlobalConfiguration pGlobalConfiguration, bool fDEBUG, CLogger *pLogger); -Parameters: +<br /> +###### Parameters:###### 1) keyType: only KeyTypeByteString is currently supported 2) lenMaxStringKeyInUnits must include space for a null-terminator byte or word if one is needed. For example: if the max key length in words is 128, including space for a null terminator, lenMaxStringKeyInUnits must be 128. 3) keyStorageMethod: only MapHashTable is currently supported 4) fReplaceDuplicateKeyCacheEntry: a global setting, which causes the Insert methods to replace duplicate key cache entries. 5) numSecondsTTLDefault: the default Time-to-live (TTL) value 6) pHashFunctionStructure: must point to a HashFunctionStructure that has been initialized with a hash function. 7) replacementPolicy: LRU or LFU 8) numDirectoryElementsToAllocate: size of map (hash table). A typical value would be 133% the size of the cache. (E.g. if cache size = 1000, this would be 1333). 9) sizeCache: the number of entries (array elements) of the cache 10) pGlobalConfiguration: a pointer to a GlobalConfiguration structure (may be NULL, if custom global configuration settings are not needed). 11) fDEBUG: for debugging 12) pLogger: a pointer to an initialized CLogger object. - -Return values: +<br /> +###### Return values:###### E_CACHE_INITIALIZATION_INVALID_KEYTYPE_FOR_MAPHASHTABLE E_INSUFFICIENTMEMORY </pre>Glenn HoffordTue, 13 Dec 2011 22:42:13 -0000https://sourceforge.net2b16d162e0b618a4c0eb235f09e9bed82d64d2bc