fluencelabs/redis
1
0
Fork 0
mirror of https://github.com/fluencelabs/redis synced 2025-03-19 17:10:50 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3661 from itamarhaber/module-doc2

Browse Source 
Corrects a couple of omissions in the modules docs
This commit is contained in:
Salvatore Sanfilippo 2016-12-16 16:53:13 +01:00 committed by GitHub
commit 151af73118
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/modules/API.md
View File

@ -1062,6 +1062,7 @@ documentation, especially the TYPES.md file.
* **rdb_save**: A callback function pointer that saves data to RDB files. * **rdb_save**: A callback function pointer that saves data to RDB files.
* **aof_rewrite**: A callback function pointer that rewrites data as commands. * **aof_rewrite**: A callback function pointer that rewrites data as commands.
* **digest**: A callback function pointer that is used for `DEBUG DIGEST`. * **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. * **free**: A callback function pointer that can free a type value.
The **digest* and **mem_usage** methods should currently be omitted since The **digest* and **mem_usage** methods should currently be omitted since

4
src/modules/TYPES.md
View File

@ -55,7 +55,7 @@ be stored in the global variable.
.free = MyTypeFree .free = MyTypeFree
}; };
MyType = RedisModule_CreateDataType("MyType-AZ", MyType = RedisModule_CreateDataType(ctx, "MyType-AZ",
MYTYPE_ENCODING_VERSION, &tm); MYTYPE_ENCODING_VERSION, &tm);
if (MyType == NULL) return REDISMODULE_ERR; 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. * `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. * `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. * `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. * `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? Ok, but *why* modules types require a 9 characters name?