There are a number of new and interesting redis module apis that are not documented in the api-ref.

Here are a few:

  • RedisModule_GetKeyNameFromModuleKey
  • RedisModule_SignalModifiedKey
  • RedisModule_BlockClientOnKeys
  • RedisModule_SignalKeyAsReady
  • RedisModule_GetBlockedClientReadyKey
  • RedisModule_NotifyKeyspaceEvent
  • RedisModule_GetNotifyKeyspaceEvents

Without the documentation is difficult to know how to use these new features. It would be helpful to have a description of how to use these functions. Can the API ref be updated and perhaps some examples provided?

Comment From: yossigo

@rkedward thanks for pointing this out, it's updated now. The API is actually documented inline in module.c and there's a script that generates the markdown version, but we'll need to make sure we update that on a regular basis.

You can see a few examples in src/modules (but only for the basic API) and most newer API functions have test cases in tests/modules.