diff options
| author | itamar <itamar@redislabs.com> | 2016-12-05 18:34:38 +0200 |
|---|---|---|
| committer | itamar <itamar@redislabs.com> | 2016-12-05 18:34:38 +0200 |
| commit | 94fe98666cff0c9b1411044b8564d7aaa8253fb2 (patch) | |
| tree | 17f8efdfb17f705c410c1c8a2ceca5d73e0266b2 /src/modules | |
| parent | 16cce320c468f93c101227cb7c012139257ae21d (diff) | |
| download | redis-94fe98666cff0c9b1411044b8564d7aaa8253fb2.tar.gz | |
Corrects a couple of omissions in the modules docs
Diffstat (limited to 'src/modules')
| -rw-r--r-- | src/modules/API.md | 1 | ||||
| -rw-r--r-- | src/modules/TYPES.md | 4 |
2 files changed, 3 insertions, 2 deletions
diff --git a/src/modules/API.md b/src/modules/API.md index 8659f7951..e90429e3b 100644 --- a/src/modules/API.md +++ b/src/modules/API.md @@ -1062,6 +1062,7 @@ documentation, especially the TYPES.md file. * **rdb_save**: A callback function pointer that saves data to RDB files. * **aof_rewrite**: A callback function pointer that rewrites data as commands. * **digest**: A callback function pointer that is used for `DEBUG DIGEST`. +* **mem_usage**: A callback function pointer that is used for `MEMORY`. * **free**: A callback function pointer that can free a type value. The **digest* and **mem_usage** methods should currently be omitted since diff --git a/src/modules/TYPES.md b/src/modules/TYPES.md index 4e663b870..4d497356a 100644 --- a/src/modules/TYPES.md +++ b/src/modules/TYPES.md @@ -55,7 +55,7 @@ be stored in the global variable. .free = MyTypeFree }; - MyType = RedisModule_CreateDataType("MyType-AZ", + MyType = RedisModule_CreateDataType(ctx, "MyType-AZ", MYTYPE_ENCODING_VERSION, &tm); if (MyType == NULL) return REDISMODULE_ERR; } @@ -115,7 +115,7 @@ registration function: `rdb_load`, `rdb_save`, `aof_rewrite`, `digest` and * `rdb_save` is called when saving data to the RDB file. * `aof_rewrite` is called when the AOF is being rewritten, and the module needs to tell Redis what is the sequence of commands to recreate the content of a given key. * `digest` is called when `DEBUG DIGEST` is executed and a key holding this module type is found. Currently this is not yet implemented so the function ca be left empty. -* `mem_usage` is called when the `MEMORY` command ask for the total memory consumed by a specific key, and is used in order to get the amount of bytes used by the module value. +* `mem_usage` is called when the `MEMORY` command asks for the total memory consumed by a specific key, and is used in order to get the amount of bytes used by the module value. * `free` is called when a key with the module native type is deleted via `DEL` or in any other mean, in order to let the module reclaim the memory associated with such a value. Ok, but *why* modules types require a 9 characters name? |