async_redis_objects

In most cases it is sufficient to import only ObjectClient, then construct whatever objects you need from it.

class async_redis_objects.ObjectClient(redis_client, encoder=None, decoder=None)

A client object to represent a redis server.

Can be used as a factory to access data structures in the server as python objects.

queue(name, encoder=None, decoder=None)

Load a list to be used as a queue.

Return type

Queue

priority_queue(name, encoder=None, decoder=None)

Load a stateful-set to be used as a priority queue.

Return type

PriorityQueue

hash(name, encoder=None, decoder=None)

Load a hashtable.

Return type

Hash

set(name, encoder=None, decoder=None)

Load a set.

Return type

Set

lock(name, max_duration=60, timeout=None)

A redis resident lock to create mutex blocks across devices.

Parameters

• name (str) – A unique identifier for the lock

• max_duration (int) – Max time to hold the lock in seconds

• timeout (Optional[int]) – Max time to wait to acquire the mutex

Returns

publisher(channel, encoder=None)

Generate a publisher for redis’ PUBSUB system.

Parameters

• channel – Channel this publisher writes to by default.

• encoder – Method to transform messages into strings to broadcast

Return type

Publisher