Recent changes to Insert Method

WikiPage Insert Method modified by Glenn Hofford

Glenn Hofford — Wed, 14 Dec 2011 20:20:23 -0000

--- v8 
+++ v9 
@@ -52,7 +52,10 @@
 
     // (note: in this case, the trailing NULL is inserted)
 
-    iResult = pCache->Insert ((const QBYTE *)"Alphabet", (QBYTE *) szVal, strlen(szVal)+1, 0);
+    int iResult = pCache->Insert ((const QBYTE *)"Alphabet", // key
+                                  (QBYTE *) szVal,           // pbData (the value)
+                                  strlen(szVal)+1,           // cbData
+                                  0);                        // TTL
 
     if (iResult != E_SUCCESS)
     {

WikiPage Insert Method modified by Glenn Hofford

Glenn Hofford — Wed, 14 Dec 2011 03:21:42 -0000

--- v7 
+++ v8 
@@ -41,7 +41,7 @@
 

 ###### Remarks:######
 
-The Insert() method inserts a key and an associate value into the cache. If the cache is full, a replacement is performed; the type of replacement is dependent on the cache replacement policy.
+The Insert() method inserts a key and an associated value into the cache. If the cache is full, a replacement is performed; the type of replacement is dependent on the cache replacement policy.
 
 

 ###### Example ######

WikiPage Insert Method modified by Glenn Hofford

Glenn Hofford — Wed, 14 Dec 2011 03:20:52 -0000

--- v6 
+++ v7 
@@ -2,8 +2,7 @@
 
 ###### Summary: ######
 
-Insert() copies cbData bytes from the buffer pointed to by pbData into a cache entry within
-the cache.
+Insert() copies cbData bytes from the buffer pointed to by pbData into a cache entry within the cache.
 
 

 ###### Syntax: ######

WikiPage Insert Method modified by Glenn Hofford

Glenn Hofford — Wed, 14 Dec 2011 03:20:38 -0000

--- v5 
+++ v6 
@@ -2,7 +2,8 @@
 
 ###### Summary: ######
 
-Insert() copies cbData bytes from the buffer pointed to by pbData into the cache.
+Insert() copies cbData bytes from the buffer pointed to by pbData into a cache entry within
+the cache.
 
 

 ###### Syntax: ######

WikiPage Insert Method modified by Glenn Hofford

Glenn Hofford — Wed, 14 Dec 2011 03:19:49 -0000

--- v4 
+++ v5 
@@ -12,21 +12,49 @@
                 const size_t cbData,
                 const unsigned int numSecondsTTL);
 
-

+    int Insert (const QWORD *wszKey,
+                const QBYTE *pbData,
+                const size_t cbData,
+                const unsigned int numSecondsTTL);
+
+

 ###### Parameters:######
 
-    1) szKey:
-
-    2) pbData:
-
-    3) cbData:
-
-    4) numSecondsTTL:
+    1) szKey or wszKey: the key
+
+    2) pbData: a pointer to a buffer of bytes that will be inserted into the cache.
+
+    3) cbData: a count of bytes of the data. This value does not necessarily need to include
+       space for a trailing NULL. Exactly cbData bytes of the buffer pointed to by pbData
+       will be stored in the cache.
+
+    4) numSecondsTTL: number of seconds for the "time-to-live" value.
 
 

 ###### Return values:######
 
       E_KEY_INVALIDKEYTYPE
       E_INVALID_KEYVALUE
       E_CACHE_DUPLICATE_KEY_FOUND_ENTRY_NOT_REPLACED
       E_SUCCESS
+
+

+###### Remarks:######
+
+The Insert() method inserts a key and an associate value into the cache. If the cache is full, a replacement is performed; the type of replacement is dependent on the cache replacement policy.
+
+

+###### Example ######
+
+    char szVal  [26 + 1];
+
+    strcpy (szVal, "ABCDEFGHIJKLMNOPQRSTUVWXYZ");
+
+    // (note: in this case, the trailing NULL is inserted)
+
+    iResult = pCache->Insert ((const QBYTE *)"Alphabet", (QBYTE *) szVal, strlen(szVal)+1, 0);
+
+    if (iResult != E_SUCCESS)
+    {
+        // error handling here
+    }

WikiPage Insert Method modified by Glenn Hofford

Glenn Hofford — Wed, 14 Dec 2011 01:58:36 -0000

--- v3 
+++ v4 
@@ -26,7 +26,7 @@
 

 ###### Return values:######
 
-    E_KEY_INVALIDKEYTYPE
-    E_INVALID_KEYVALUE
-    E_CACHE_DUPLICATE_KEY_FOUND_ENTRY_NOT_REPLACED
-    E_SUCCESS
+      E_KEY_INVALIDKEYTYPE
+      E_INVALID_KEYVALUE
+      E_CACHE_DUPLICATE_KEY_FOUND_ENTRY_NOT_REPLACED
+      E_SUCCESS

WikiPage Insert Method modified by Glenn Hofford

Glenn Hofford — Wed, 14 Dec 2011 01:55:34 -0000

--- v2 
+++ v3 
@@ -1,4 +1,4 @@
-##### Method: Insert #####
+##### Method: Cache::Insert #####
 
 ###### Summary: ######

WikiPage Insert Method modified by Glenn Hofford

Glenn Hofford — Wed, 14 Dec 2011 01:54:08 -0000

--- v1 
+++ v2 
@@ -1,6 +1,32 @@
-    // Insert() copies cbData bytes from the buffer pointed to by pbData into the cache.
-    //
-    virtual int Insert (const QBYTE *szKey,
-                        const QBYTE *pbData,
-                        const size_t cbData,
-                        const unsigned int numSecondsTTL) = 0;
+##### Method: Insert #####
+
+###### Summary: ######
+
+Insert() copies cbData bytes from the buffer pointed to by pbData into the cache.
+
+

+###### Syntax: ######
+
+    int Insert (const QBYTE *szKey,
+                const QBYTE *pbData,
+                const size_t cbData,
+                const unsigned int numSecondsTTL);
+
+

+###### Parameters:######
+
+    1) szKey:
+
+    2) pbData:
+
+    3) cbData:
+
+    4) numSecondsTTL:
+
+

+###### Return values:######
+
+    E_KEY_INVALIDKEYTYPE
+    E_INVALID_KEYVALUE
+    E_CACHE_DUPLICATE_KEY_FOUND_ENTRY_NOT_REPLACED
+    E_SUCCESS

WikiPage Insert Method modified by Glenn Hofford

Glenn Hofford — Wed, 14 Dec 2011 01:48:08 -0000

// Insert() copies cbData bytes from the buffer pointed to by pbData into the cache. // virtual int Insert (const QBYTE *szKey, const QBYTE *pbData, const size_t cbData, const unsigned int numSecondsTTL) = 0;