DefaultSubscriber
faststream.kafka.subscriber.usecase.DefaultSubscriber #
DefaultSubscriber(
config: KafkaSubscriberConfig,
specification: SubscriberSpecification[Any, Any],
calls: CallsCollection[ConsumerRecord],
)
Bases: LogicSubscriber['ConsumerRecord']
Source code in faststream/kafka/subscriber/usecase.py
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | |
parser instance-attribute #
parser = AioKafkaParser(
msg_class=KafkaMessage
if config.ack_first
else KafkaAckableMessage,
regex=reg,
)
pattern property #
pattern: Address | None
The pattern this Subscriber was declared with, and its Broker address.
partitions property #
partitions: list[TopicPartition]
The assignment as the consumer receives it: the client library's tuples, prefixed.
Declared with faststream.kafka.TopicPartition; handed to aiokafka as its own.
get_msg async #
get_msg(consumer: AIOKafkaConsumer) -> ConsumerRecord
Source code in faststream/kafka/subscriber/usecase.py
319 320 321 322 | |
get_log_context #
get_log_context(
message: Optional[StreamMessage[ConsumerRecord]],
) -> dict[str, str]
Source code in faststream/kafka/subscriber/usecase.py
324 325 326 327 328 329 330 331 332 333 334 335 336 337 | |
start async #
start() -> None
Start the consumer.
Source code in faststream/kafka/subscriber/usecase.py
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 | |
stop async #
stop() -> None
Source code in faststream/kafka/subscriber/usecase.py
152 153 154 155 156 157 | |
add_call #
add_call(
*,
parser_: Optional[CustomCallable],
decoder_: Optional[CustomCallable],
dependencies_: Sequence[Dependant],
codec_: Optional[CodecProto] = None,
) -> Self
Source code in faststream/_internal/endpoint/subscriber/usecase.py
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 | |
consume async #
consume(msg: MsgType) -> Any
Consume a message asynchronously.
Source code in faststream/_internal/endpoint/subscriber/usecase.py
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 | |
process_message async #
process_message(msg: MsgType) -> Response
Execute all message processing stages.
Source code in faststream/_internal/endpoint/subscriber/usecase.py
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 | |
get_one async #
get_one(*, timeout: float = 5.0) -> KafkaMessage | None
Source code in faststream/kafka/subscriber/usecase.py
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 | |
schema #
schema() -> dict[str, SubscriberSpec]
Source code in faststream/_internal/endpoint/subscriber/usecase.py
518 519 520 | |
add_task #
add_task(
func: Callable[..., Coroutine[Any, Any, Any]],
func_args: tuple[Any, ...] | None = None,
func_kwargs: dict[str, Any] | None = None,
*,
restart_on_failure: bool = True,
) -> None
Source code in faststream/_internal/endpoint/subscriber/mixins.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 | |
consume_one async #
consume_one(msg: MsgType) -> None
Source code in faststream/kafka/subscriber/usecase.py
267 268 | |
build_log_context staticmethod #
build_log_context(
message: Optional[StreamMessage[Any]],
topic: str,
group_id: str | None = None,
) -> dict[str, str]
Source code in faststream/kafka/subscriber/usecase.py
283 284 285 286 287 288 289 290 291 292 293 | |