B4J Library Redis Client fast in-memory datastore

Hello everyone,
After reading the post by @hatzisn HERE titled 'Redis - A great tutorial', I decided to look more into Redis. Even though I personally cannot ever see myself using this Redis library (I prefer B4X KVS or in‑memory SQLite). But, B4X (B4J) developers might want to use it, and of course that means yet another useful library for B4J developers.

What is Redis?
Redis is a high‑performance, in‑memory datastore used for speed critical applications such as caching, messaging, real time analytics, and distributed systems. The one line takeaway is that Redis is a super fast key value database that lives in RAM and is perfect for real‑time workloads.

To run in memory you need to installed the following server locally or use an online server. There are only a few real online Redis servers in the world that you can connect to externally over TCP.

I've tested this library using the Developer Edition (RC) of Memurai in-memory datastore server linked below

Download Memurai for Windows | Memurai

Download for free. Fully compatible with Redis 7.4. Runs on Windows 7 64-bit or higher.

www.memurai.com

B4J library tab

Spoiler: B4J Redis in memory test logs

Redis Pool Initialized: true
Raw Pool GET Result: Hello from B4XPages!
Command: HSET | Success: true | Result: 1
HSET completed. Fetching field 'name'...
Command: SET | Success: true | Result: OK
Command: HDEL | Success: true | Result: 1
Hash field deleted successfully. Result: 1
Command: HSET | Success: true | Result: 0
HSET completed. Fetching field 'name'...
Command: HSET | Success: true | Result: 0
HSET completed. Fetching field 'name'...
Command: EXPIRE | Success: true | Result: 1
Expire set successfully. Result: 1
Command: EXISTS | Success: true | Result: true
Key Exists: true
Command: HEXISTS | Success: true | Result: true
Hash Field Exists: true
Command: HGETALL | Success: true | Result: {name=Peter, role=developer}
Retrieved All Hash Fields Count: 2
Command: LPUSH | Success: true | Result: 50
LPUSH list length: 50
Command: RPUSH | Success: true | Result: 49
RPUSH list length: 49
Command: SADD | Success: true | Result: 0
SADD added count: 0
Command: SMEMBERS | Success: true | Result: [unique_member]
SMEMBERS items count: 1
Command: LRANGE | Success: true | Result: [item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_left, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right, item_right]
LRANGE items count: 50
Command: HGET | Success: true | Result: Peter
Retrieved Hash Field Value: Peter
Command: HGET | Success: true | Result: Peter
Retrieved Hash Field Value: Peter
Command: HGET | Success: true | Result: Peter
Retrieved Hash Field Value: Peter
Command: GET | Success: true | Result: Hello from B4XPages!
Retrieved Value: Hello from B4XPages!

SS_Redis

Author: Peter Simpson
Version: 1.0

• Redis
  • Events:
    • CommandResult (Command As String, Success As Boolean, Result As Object)
    • Log (Message As String)
    • MessageReceived (Channel As String, Message As String)
    • PoolInitialized (Success As Boolean)
    • SubscribeError (Error As String)
    • TaskRejected (Command As String, Reason As String)
  • Functions:
    • Close
      Close everything: unsubscribe, close pool, shutdown executor.
    • DelAsync (key As String)
      Async DEL
    • ExistsAsync (key As String)
      Async EXISTS
      Checks if a key exists in Redis. Returns a boolean.
    • ExpireAsync (key As String, seconds As Long)
      Async EXPIRE
      Sets a timeout on a key in seconds.
    • GetAsync (key As String)
      Async GET
    • GetRawPool As redis.clients.jedis.JedisPool
      Expose raw pool for advanced usage. Use with caution.
    • HDelAsync (key As String, field As String)
      Async HDel - Hash
    • HExistsAsync (key As String, field As String)
      Async HEXISTS - Hash
      Checks if a specific hash field exists.
    • HGetAllAsync (key As String)
      Async HGETALL - Hash
      Retrieves all fields and values in a hash.
    • HGetAsync (key As String, field As String)
      Async HGET - Hash
    • HSetAsync (key As String, field As String, value As String)
      Async HSET - Hash
    • Initialize (maxThreads As Int)
      Initialize with default queue size (100).
    • InitializeEx (maxThreads As Int, queueSize As Int)
      Initialize with custom thread and queue sizes.
    • InitializePool (EventName As String, host As String, port As Int, timeoutMs As Int, password As String, database As Int, maxTotal As Int, maxIdle As Int)
      Initialises a Jedis Redis connection pool.
      EventName: B4X event prefix used for callbacks (e.g., EventName + "_PoolInitialized").
      Host: Redis server hostname or IP ("127.0.0.1" for local, cloud endpoint for hosted Redis).
      Port: Redis TCP port (default 6379).
      TimeoutMs: Socket timeout in milliseconds (typical 2000-5000).
      Password: Redis authentication password; empty if not required.
      Database: Logical Redis database index (0-15), default is 0.
      MaxTotal: Maximum total connections allowed in the pool.
      MaxIdle: Maximum idle connections kept ready for reuse.
      Notes:
      - Fires EventName + "_PoolInitialized" with success/failure.
      - Failure indicates DNS, socket, or authentication issues.
      - Call Redis.Close() on shutdown to release pool resources.
    • IsInitialized As Boolean
      Returns true if the object has been initialized and not yet closed.
    • LPushAsync (key As String, value As String)
      Async LPUSH - List
      Inserts a value at the head of a list.
    • LRangeAsync (key As String, start As Long, stop As Long)
      Async LRANGE - List
      Retrieves a range of elements from a list.
      So see all the elements, set stop to -1.
    • PublishAsync (channel As String, message As String)
      Async PUBLISH
    • RPushAsync (key As String, value As String)
      Async RPUSH - List
      Inserts a value at the tail of a list.
    • SAddAsync (key As String, member As String)
      Async SADD - Set
      Adds a unique member to a set.
    • SetAsync (key As String, value As String)
      Async SET
    • SetBlockingSubmit (blocking As Boolean)
      Configure whether submissions should block when the queue is full (CallerRunsPolicy) or use the default rejection handler.
      Must be called after Initialize/InitializeEx.
    • SetDebugMode (debug As Boolean)
      Enable or disable debug mode. When enabled, error results include stack traces.
    • SetSubscriberJoinTimeout (timeoutMs As Long)
      Set subscriber join timeout in milliseconds used when waiting for subscriber thread termination during Unsubscribe.
    • SMembersAsync (key As String)
      Async SMEMBERS - Set
      Returns all members of a set as a list.
    • Subscribe (channel As String)
      Subscribe to a channel. Uses a dedicated subscriber thread and Jedis instance.
    • Unsubscribe
      Unsubscribe and attempt to deterministically stop the subscriber thread.

PLEASE NOTE:
TO RUN THE ATTACHED EXAMPLE, YOU NEED TO DOWNLOAD THE THIRD-PARTY DEPENDENCIES LINKED BELOW, AS WELL AS USING THE ATTACHED POST LIBRARY.
CLICK HERE to download the dependencies <<<<<<<<<<<<<<<<<<<<<<<<


Enjoy...