Brokers¶
The broker is the main entry point. It wires the registry, pipeline, and transport.
Import paths¶
# Recommended — top-level re-export
from rabbitkit import AsyncBroker, SyncBroker
# Also fine — canonical submodule path
from rabbitkit.async_ import AsyncBroker
from rabbitkit.sync import SyncBroker
# Full path
from rabbitkit.async_.broker import AsyncBroker
from rabbitkit.sync.broker import SyncBroker
rabbitkit.aio is a deprecated alias for rabbitkit.async_ — importing it
emits a DeprecationWarning; use rabbitkit.async_ instead.
AsyncBroker¶
AsyncBroker
¶
Async broker — wires registry + pipeline + AsyncTransportImpl.
Usage::
config = RabbitConfig(connection=ConnectionConfig(host="localhost"))
broker = AsyncBroker(config)
@broker.subscriber(queue="orders", exchange="events")
async def handle_order(body: bytes) -> None:
...
await broker.start()
Source code in src/rabbitkit/async_/broker.py
61 62 63 64 65 66 67 68 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 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 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 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 | |
Attributes¶
flow_controller: Any | None
property
writable
¶
Optional FlowController used to throttle the publish path.
started: bool
property
¶
True between a successful start() and stop().
Public counterpart of _started — health checks
(:func:rabbitkit.health.broker_health_check) read this instead of
falling back to the private attribute (which emits a
DeprecationWarning).
publish_middlewares: list[BaseMiddleware]
property
¶
Middlewares applied to every broker.publish() call (e.g. signing).
Set via the constructor's middlewares= param. See the comment on
self._publish_middlewares for why reassigning (not mutating) is
required to change this after construction.
worker_pool: AsyncWorkerPool | None
property
¶
Return the worker pool (if configured).
consumer_config: ConsumerConfig
property
¶
Effective consumer config (may reflect WorkerConfig.prefetch override).
Methods:¶
subscriber(queue: RabbitQueue | str, exchange: RabbitExchange | str | None = None, routing_key: str = '', ack_policy: AckPolicy = AckPolicy.AUTO, middlewares: list[BaseMiddleware] | None = None, serializer: Serializer[Any] | None = None, retry: RetryConfig | RetryDisabled | None = None, tags: frozenset[str] | set[str] | None = None, description: str = '', name: str | None = None, prefetch_count: int | None = None, filter_fn: Callable[[RabbitMessage], bool] | None = None, reject_without_dlx: str | None = None) -> Callable[[Callable[..., Any]], Callable[..., Any]]
¶
Register a subscriber handler.
Source code in src/rabbitkit/async_/broker.py
publisher(exchange: RabbitExchange | str | None = None, routing_key: str = '') -> Callable[[Callable[..., Any]], Callable[..., Any]]
¶
Register a result publisher.
Source code in src/rabbitkit/async_/broker.py
include_router(router: RabbitRouter, prefix: str = '') -> None
¶
start(worker_config: WorkerConfig | None = None, *, install_signal_handlers: bool = True) -> None
async
¶
Start the broker - connect, declare topology, start consuming.
- Connect to RabbitMQ
- Declare exchanges, queues, bindings per TopologyMode
- Declare retry topology (delay queues, DLQ)
- Optionally create a worker pool for concurrent processing
- Start consuming from all registered queues
When install_signal_handlers is True (default), SIGINT/SIGTERM are
trapped so the common await broker.start() pattern drains gracefully
instead of hard-dying (H-SRE5). Pass False when an outer lifecycle
manager (e.g. RabbitApp) owns signal handling.
L14: last_heartbeat is initialized here (not left None until
the first message/tick) so a broker that is wedged from the very
start -- before it ever processes a message or a periodic heartbeat
tick -- is still caught by :func:health.broker_liveness's
staleness check, instead of bypassing it entirely (a None
heartbeat is treated as "no signal available" there, which
previously meant "always alive").
Source code in src/rabbitkit/async_/broker.py
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 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 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 | |
run(worker_config: WorkerConfig | None = None) -> None
async
¶
Start, wait for a shutdown signal, then stop (H11).
await broker.start() alone installs signal handlers whose drain is
fire-and-forget — nothing joins the stop() task they create, so
whether in-flight messages actually finish draining depends on
incidental event-loop lifetime (e.g. it can be cut short by
asyncio.run() cancelling outstanding tasks once the awaited
coroutine returns). run() is the direct-use equivalent of
RabbitApp.run_async(): it does not return until the drain
triggered by SIGINT/SIGTERM (or :meth:request_shutdown) has fully
completed, so awaiting it end-to-end guarantees in-flight messages are
settled before the process exits::
broker = AsyncBroker(config)
@broker.subscriber(queue="orders")
async def handle_order(body: bytes) -> None: ...
asyncio.run(broker.run())
Use plain start()/stop() instead when an outer lifecycle
manager (RabbitApp) owns the run loop.
Source code in src/rabbitkit/async_/broker.py
request_shutdown() -> None
¶
Request a graceful shutdown from any context — e.g. a failing
health check or a management command (H11). Equivalent to receiving
SIGINT/SIGTERM: if run() is awaiting shutdown it performs the
drain; otherwise this schedules a fire-and-forget stop().
Source code in src/rabbitkit/async_/broker.py
stop(timeout: float | None = None) -> None
async
¶
Stop the broker - cancel consumers, drain pool, drain in-flight, disconnect.
timeout defaults to ConsumerConfig.graceful_timeout (C-2). The
whole sequence is bounded by an overall deadline.
C5: consumers are cancelled FIRST, before the worker pool is drained.
Draining the pool before cancelling left the consumer active for the
entire (potentially graceful_timeout-long) drain wait — a message
delivered in that window was submitted via AsyncWorkerPool.submit(),
which creates a task unconditionally (it never checks _running) and
adds it to _tasks. If that submit happens after .stop() already
cleared _tasks, the new task is never awaited by anything — an
orphaned background task racing the event loop's shutdown, with the
message never cleanly settled before disconnect(), so it is
redelivered (duplicate-processing risk) on the next connection.
Cancelling first stops new deliveries outright, so the pool only ever
drains work that was already in flight.
Source code in src/rabbitkit/async_/broker.py
publish(envelope: MessageEnvelope | None = None, *, exchange: str = '', routing_key: str = '', body: bytes | str | dict[str, Any] | None = None, headers: dict[str, Any] | None = None, content_type: str = 'application/json', correlation_id: str | None = None, reply_to: str | None = None) -> PublishOutcome
async
¶
Publish a message.
Accepts either a pre-built MessageEnvelope or individual kwargs::
# Envelope form (full control):
await broker.publish(MessageEnvelope(routing_key="orders.created", body=b"..."))
# Kwargs form (convenient):
await broker.publish(
exchange="orders",
routing_key="orders.created",
body={"order_id": 123},
headers={"x-tenant": "acme"},
)
When body is a dict or str it is JSON-encoded automatically.
When an opt-in FlowController is configured (broker.flow_controller
= fc), a publish slot is acquired/released around the transport publish
so backpressure/rate-limiting applies to the hot path. Without a
controller this is a plain pass-through.
When middlewares=[...] was passed to the constructor, each
middleware's publish_scope_async wraps this call (e.g.
SigningMiddleware signs the envelope) — see publish_middlewares.
Middleware wraps OUTSIDE both flow control and batching, so a
middleware-transformed envelope is what gets rate-limited/batched, and
what actually reaches the wire.
Source code in src/rabbitkit/async_/broker.py
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 | |
request(routing_key: str, body: bytes, *, timeout: float = 5.0, exchange: str = '', headers: dict[str, Any] | None = None) -> RabbitMessage
async
¶
Send an RPC request and wait for a response.
Lazily initializes an AsyncRPCClient on first call. The client is shared across calls and closed in stop().
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
routing_key
|
str
|
Target queue/routing key. |
required |
body
|
bytes
|
Request body as bytes. |
required |
timeout
|
float
|
Max seconds to wait for response. |
5.0
|
exchange
|
str
|
Exchange to publish to (default ""). |
''
|
headers
|
dict[str, Any] | None
|
Optional AMQP headers. |
None
|
Returns:
| Type | Description |
|---|---|
RabbitMessage
|
RabbitMessage containing the response. |
Raises:
| Type | Description |
|---|---|
RuntimeError
|
If broker is not started. |
RPCTimeoutError
|
If no response within timeout. |
Source code in src/rabbitkit/async_/broker.py
SyncBroker¶
SyncBroker
¶
Sync broker — wires registry + pipeline + SyncTransport.
Usage::
config = RabbitConfig(connection=ConnectionConfig(host="localhost"))
broker = SyncBroker(config)
@broker.subscriber(queue="orders", exchange="events")
def handle_order(body: bytes) -> None:
...
broker.start()
Source code in src/rabbitkit/sync/broker.py
59 60 61 62 63 64 65 66 67 68 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 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 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 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 | |
Attributes¶
flow_controller: Any | None
property
writable
¶
Optional FlowController used to throttle the publish path.
started: bool
property
¶
True between a successful start() and stop().
Public counterpart of _started — health checks
(:func:rabbitkit.health.broker_health_check) read this instead of
falling back to the private attribute (which emits a
DeprecationWarning).
publish_middlewares: list[BaseMiddleware]
property
¶
Middlewares applied to every broker.publish() call (e.g. signing).
Set via the constructor's middlewares= param. See the comment on
self._publish_middlewares for why reassigning (not mutating) is
required to change this after construction.
worker_pool: SyncWorkerPool | None
property
¶
Return the worker pool (if configured).
consumer_config: ConsumerConfig
property
¶
Effective consumer config (may reflect WorkerConfig.prefetch override).
Methods:¶
subscriber(queue: RabbitQueue | str, exchange: RabbitExchange | str | None = None, routing_key: str = '', ack_policy: AckPolicy = AckPolicy.AUTO, middlewares: list[BaseMiddleware] | None = None, serializer: Serializer[Any] | None = None, retry: RetryConfig | RetryDisabled | None = None, tags: frozenset[str] | set[str] | None = None, description: str = '', name: str | None = None, prefetch_count: int | None = None, filter_fn: Callable[[RabbitMessage], bool] | None = None, reject_without_dlx: str | None = None) -> Callable[[Callable[..., Any]], Callable[..., Any]]
¶
Register a subscriber handler.
Source code in src/rabbitkit/sync/broker.py
publisher(exchange: RabbitExchange | str | None = None, routing_key: str = '') -> Callable[[Callable[..., Any]], Callable[..., Any]]
¶
Register a result publisher.
Source code in src/rabbitkit/sync/broker.py
include_router(router: RabbitRouter, prefix: str = '') -> None
¶
start(worker_config: WorkerConfig | None = None) -> None
¶
Start the broker — connect, declare topology, start consuming.
- Connect to RabbitMQ
- Declare exchanges, queues, bindings per TopologyMode
- Declare retry topology (delay queues, DLQ)
- Optionally create a worker pool for concurrent processing
- Start consuming from all registered queues
L14: last_heartbeat is initialized here (not left None until
the first message/tick) so a broker that is wedged from the very
start -- before it ever processes a message or a
start_consuming() loop iteration -- is still caught by
:func:health.broker_liveness's staleness check, instead of
bypassing it entirely (a None heartbeat is treated as "no
signal available" there, which previously meant "always alive").
Source code in src/rabbitkit/sync/broker.py
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 | |
stop(timeout: float | None = None) -> None
¶
Stop the broker - cancel consumers, drain pool, drain in-flight, disconnect.
timeout defaults to ConsumerConfig.graceful_timeout (C-2). The
whole stop sequence is bounded by an overall deadline.
C5: consumers are cancelled FIRST, before the worker pool is drained.
Draining the pool before cancelling left the consumer active for the
entire (potentially graceful_timeout-long) drain wait — a message
delivered in that window was submitted to a pool already mid-shutdown:
SyncWorkerPool.submit() either raises RuntimeError (uncaught,
propagating into pika's callback machinery) or, once .stop() has
fully returned, silently runs the handler inline on the pika I/O
thread — either way the message is never cleanly settled before
disconnect(), so it is redelivered (duplicate-processing risk) on
the next connection. Cancelling first stops new deliveries outright,
so the pool only ever drains work that was already in flight.
Source code in src/rabbitkit/sync/broker.py
run(worker_config: WorkerConfig | None = None) -> None
¶
Start and run the blocking consume loop.
Blocks until SIGINT/SIGTERM or stop() is called. Installs a SIGTERM handler (C-1) so k8s pod termination drains instead of hard-killing. Recovers from connection drops by reconnecting, re-declaring topology, and re-subscribing all consumers - pika's BlockingConnection has no built-in recovery, so without this a single blip kills the consumer.
worker_config is forwarded to :meth:start, so a multi-worker
consumer (worker_count > 1) also gets the recovery loop.
Source code in src/rabbitkit/sync/broker.py
pump_idle(time_limit: float = 0.05) -> None
¶
Service the connection's I/O loop without consuming (idle keep-alive).
run()/start_consuming() pumps process_data_events()
continuously while consumers are registered, which incidentally
keeps the (single, shared) connection's heartbeats serviced too —
see sync/transport.py's module docstring on the one-connection
model. A publish-only broker (no registered routes, or one that
never calls run()) has nothing driving that pump: the connection
is only touched when publish() actually runs, so a long idle gap
can get it heartbeat-timed-out broker-side, and a dead connection is
only discovered (and reconnected) on the next publish attempt.
Call this periodically — from the SAME thread that called
start(), same invariant as every other transport call — from
your own idle loop (e.g. between polling for work) to reconnect
proactively if the connection died, service pending heartbeat
frames, and refresh the liveness heartbeat (see
health.broker_liveness) even though no message was delivered.
A no-op if the broker is not started.
Source code in src/rabbitkit/sync/broker.py
publish(envelope: MessageEnvelope | None = None, *, exchange: str = '', routing_key: str = '', body: bytes | str | dict[str, Any] | None = None, headers: dict[str, Any] | None = None, content_type: str = 'application/json', correlation_id: str | None = None, reply_to: str | None = None) -> PublishOutcome
¶
Publish a message.
Accepts either a pre-built MessageEnvelope or individual kwargs::
# Envelope form (full control):
broker.publish(MessageEnvelope(routing_key="orders.created", body=b"..."))
# Kwargs form (convenient):
broker.publish(
exchange="orders",
routing_key="orders.created",
body={"order_id": 123},
headers={"x-tenant": "acme"},
)
When body is a dict or str it is JSON-encoded automatically.
When an opt-in FlowController is configured (broker.flow_controller
= fc), a publish slot is acquired before and released after the
transport publish so backpressure/rate-limiting applies to the hot path.
Without a controller this is a plain pass-through.
When middlewares=[...] was passed to the constructor, each
middleware's publish_scope wraps this call (e.g. SigningMiddleware
signs the envelope) — see publish_middlewares. Middleware wraps
OUTSIDE the flow-control gate, so a middleware-transformed envelope is
what gets rate-limited/blocked, and what the transport actually sends.
Throughput note (H6): with publisher confirms on (the default), this waits for a broker confirm per message on a single channel, so it is RTT-bound at ~0.9k msg/s and does NOT scale with worker_count — pika's BlockingConnection serializes confirms, it cannot pipeline them. To drain a large backlog fast, use AsyncBroker + AsyncBatchPublisher (pipelined confirms, ~6.1k msg/s) or more processes.
Source code in src/rabbitkit/sync/broker.py
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 | |
request(routing_key: str, body: bytes, *, timeout: float = 5.0, exchange: str = '', headers: dict[str, Any] | None = None) -> RabbitMessage
¶
Send an RPC request and wait for a response (sync).
Lazily initializes an RPCClient on first call. The client is shared across calls and closed in stop().
Source code in src/rabbitkit/sync/broker.py
RabbitApp (lifecycle)¶
RabbitApp
¶
Application lifecycle manager.
Manages startup/shutdown hooks and signal handling. Idempotent: start() twice is safe (no-op if already running). Startup failure rollback: if any startup hook fails → on_shutdown still called.
startup_timeout bounds each startup/after-startup hook so a hung hook
fails fast instead of hanging until SIGKILL. The default (120.0) is
finite; pass None explicitly to disable the bound.
Source code in src/rabbitkit/core/app.py
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 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 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 | |
Methods:¶
on_startup(func: Callable[[], Any]) -> Callable[[], Any]
¶
after_startup(func: Callable[[], Any]) -> Callable[[], Any]
¶
on_shutdown(func: Callable[[], Any]) -> Callable[[], Any]
¶
after_shutdown(func: Callable[[], Any]) -> Callable[[], Any]
¶
start() -> None
¶
Start the application (sync).
Idempotent and concurrency-safe — no-op if already running. On startup hook failure → on_shutdown is still called.
Source code in src/rabbitkit/core/app.py
stop() -> None
¶
Stop the application (sync).
Idempotent and concurrency-safe — no-op if already stopped.
Source code in src/rabbitkit/core/app.py
start_async() -> None
async
¶
Start the application (async).
Idempotent and concurrency-safe — no-op if already running. On startup hook failure → on_shutdown is still called.
Source code in src/rabbitkit/core/app.py
stop_async() -> None
async
¶
Stop the application (async).
Idempotent and concurrency-safe — no-op if already stopped.
Source code in src/rabbitkit/core/app.py
run_async() -> None
async
¶
Start, wait for shutdown signal, then stop (async).
Installs SIGINT/SIGTERM handlers for graceful shutdown. Falls back to
signal.signal on platforms/threads where loop.add_signal_handler
is unavailable (e.g. Windows, non-main-thread).
Source code in src/rabbitkit/core/app.py
request_shutdown() -> None
¶
AppState
¶
Bases: str, Enum
Application lifecycle states.
Canonical home for this enum is core/types.py per the project rule that
types.py is the SINGLE canonical location for all enums and data types.