]> git.saurik.com Git - redis.git/commitdiff
RDB type loading functions clarified in comments.
authorantirez <antirez@gmail.com>
Sat, 2 Jun 2012 08:21:57 +0000 (10:21 +0200)
committerantirez <antirez@gmail.com>
Sat, 2 Jun 2012 08:21:57 +0000 (10:21 +0200)
Improved comments to make clear that rdbLoadType() just loads a
general TYPE in the context of RDB that can be an object type or an
expire type, end-of-file, and so forth.

While rdbLoadObjectType() enforces that the type is a valid Object Type
otherwise it returns -1.

src/rdb.c

index f9b962670c9d123ef8b5c2c2bebcbb11670e6667..9190ea514cb65ed12af35795003fabade5fd6102 100644 (file)
--- a/src/rdb.c
+++ b/src/rdb.c
@@ -21,6 +21,9 @@ int rdbSaveType(rio *rdb, unsigned char type) {
     return rdbWriteRaw(rdb,&type,1);
 }
 
+/* Load a "type" in RDB format, that is a one byte unsigned integer.
+ * This function is not only used to load object types, but also special
+ * "types" like the end-of-file type, the EXPIRE type, and so forth. */
 int rdbLoadType(rio *rdb) {
     unsigned char type;
     if (rioRead(rdb,&type,1) == 0) return -1;
@@ -433,7 +436,8 @@ int rdbSaveObjectType(rio *rdb, robj *o) {
     return -1; /* avoid warning */
 }
 
-/* Load object type. Return -1 when the byte doesn't contain an object type. */
+/* Use rdbLoadType() to load a TYPE in RDB format, but returns -1 if the
+ * type is not specifically a valid Object Type. */
 int rdbLoadObjectType(rio *rdb) {
     int type;
     if ((type = rdbLoadType(rdb)) == -1) return -1;