redis#
Redis Message Queue.
RedisMessageQueueConfig #
Bases: BaseSettings
Redis message queue configuration.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
type |
Literal[str]
|
|
'redis'
|
url |
str
|
|
'redis://localhost:6379'
|
host |
str | None
|
|
None
|
port |
int | None
|
|
None
|
db |
int | None
|
|
None
|
username |
str | None
|
|
None
|
password |
str | None
|
|
None
|
ssl |
bool | None
|
|
None
|
Source code in llama_deploy/message_queues/redis.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
|
RedisConsumerMetadata #
Bases: BaseModel
Parameters:
Name | Type | Description | Default |
---|---|---|---|
message_type |
str
|
|
required |
start_consuming_callable |
Callable[..., Coroutine[Any, Any, None]]
|
|
required |
pubsub |
Any
|
|
None
|
Source code in llama_deploy/message_queues/redis.py
63 64 65 66 |
|
RedisMessageQueue #
Bases: BaseMessageQueue
Redis integration for message queue.
This class uses Redis Pub/Sub functionality for message distribution.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url |
str
|
|
'redis://localhost:6379'
|
Attributes:
Name | Type | Description |
---|---|---|
url |
str
|
The Redis URL string to connect to the Redis server |
redis |
Redis
|
The Redis connection |
Examples:
from llama_deploy.message_queues.redis import RedisMessageQueue
message_queue = RedisMessageQueue() # uses the default url
Source code in llama_deploy/message_queues/redis.py
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
|
from_url_params
classmethod
#
from_url_params(host: str, port: int = 6379, db: int = 0, username: Optional[str] = None, password: Optional[str] = None, ssl: bool = False) -> RedisMessageQueue
Convenience constructor from url params.
Source code in llama_deploy/message_queues/redis.py
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
new_connection
async
#
new_connection() -> Redis
Returns a new connection to the Redis server.
Source code in llama_deploy/message_queues/redis.py
115 116 117 118 119 |
|
register_consumer
async
#
register_consumer(consumer: BaseMessageQueueConsumer) -> StartConsumingCallable
Register a new consumer.
Source code in llama_deploy/message_queues/redis.py
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
|
deregister_consumer
async
#
deregister_consumer(consumer: BaseMessageQueueConsumer) -> Any
Deregister a consumer.
Source code in llama_deploy/message_queues/redis.py
170 171 172 173 174 175 176 177 178 179 |
|
processing_loop
async
#
processing_loop() -> None
A loop for getting messages from queues and sending to consumer.
Not relevant for this class as Redis uses pub/sub model.
Source code in llama_deploy/message_queues/redis.py
181 182 183 184 185 186 |
|
launch_local
async
#
launch_local() -> Task
Launch the message queue locally, in-process.
Launches a dummy task.
Source code in llama_deploy/message_queues/redis.py
188 189 190 191 192 193 |
|
launch_server
async
#
launch_server() -> None
Launch the message queue server.
Not relevant for this class. Redis server should be running separately.
Source code in llama_deploy/message_queues/redis.py
195 196 197 198 199 |
|
cleanup_local
async
#
cleanup_local(message_types: List[str], *args: Any, **kwargs: Dict[str, Any]) -> None
Perform any cleanup before shutting down.
Source code in llama_deploy/message_queues/redis.py
201 202 203 204 205 206 207 208 209 |
|