Eric Redis queues documentation

Eric Redis queues documentation#

A Redis implementation of persistence layer of eric-sse:

Reference#

class AbstractRedisQueue#

Bases: PersistableQueue, ABC

__init__(listener_id, host='127.0.0.1', port=6379, db=0)#
Parameters:

listener_id (str)

property kv_key: str#

The key to use when persisting object

property kv_value_as_dict#

Returns value that will be persisted as a dictionary.

setup_by_dict(setup)#

Does necessary post-creation setup of object given its persisted values

Parameters:

setup (dict)

property kv_constructor_params_as_dict: dict#

Class constructor parameters as dict

class RedisQueue#

Bases: AbstractRedisQueue

pop()#

Next message from the queue.

Raises a NoMessagesException if the queue is empty.

Return type:

Any | None

class BlockingRedisQueue#

Bases: RedisQueue

Implements a blocking queue. See pop() documentation

pop()#

Behaviour relies on https://redis.io/docs/latest/commands/blpop/ , so calls to it with block program execution until a new message is pushed.

Return type:

Any | None

class AbstractRedisConnectionRepository#

Bases: ConnectionRepositoryInterface, ABC

__init__(host='127.0.0.1', port=6379, db=0)#
abstract create_queue(listener_id)#

Returns a concrete Queue instance.

Parameters:

listener_id (str) – Corresponding listener id

Return type:

AbstractRedisQueue

load_all()#

Returns an Iterable of all persisted connections

Return type:

Iterable[Connection]

load(channel_id)#

Returns an Iterable of all persisted connections of a given channel

Parameters:

channel_id (str)

Return type:

Iterable[Connection]

delete(channel_id, listener_id)#

Deletes a listener given its channel id and listener id.

Parameters:

  • channel_id (str)

  • listener_id (str)

class RedisConnectionsRepository#

Bases: AbstractRedisConnectionRepository

create_queue(listener_id)#

Returns a concrete Queue instance.

Parameters:

listener_id (str) – Corresponding listener id

Return type:

RedisQueue

class RedisBlockingQueuesRepository#

Bases: AbstractRedisConnectionRepository

create_queue(listener_id)#

Creates a new blocking queue.

Parameters:

listener_id (str)

Return type:

BlockingRedisQueue

class RedisSSEChannelRepository#

Bases: ChannelRepositoryInterface

__init__(host='127.0.0.1', port=6379, db=0, connection_factory='eric_redis_queues.RedisConnectionsRepository')#
Parameters:

  • host

  • port

  • db

  • connection_factory (str) – Connection factory name to use to connect to Redis. Accepted literals are ‘RedisConnectionsRepository’ and ‘RedisBlockingQueuesRepository’

load()#

Returns all channels from the repository.

Return type:

Iterable[SSEChannel]

Contents