mux
BlockMuxStream ¶
BlockMuxStream(reader, start=None, timeout=0, on_gap=ONGAP_DEFAULT, stride=None, label=None)
Bases: Generic[T]
A time-aware, gap-handling multiplexer for SeriesBlock streams.
Given SeriesBlocks from multiple named streams with monotonically increasing integer timestamps, this data structure can be used to pull out sets of synchronized blocks, all with the same timestamps. If data on the streams is not available before timeouts are reached, gap blocks will be returned.
The oldest items will be held until either all named streams are available or until the timeout has been reached. If a start time has been set, any items with an older timestamp will be rejected.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
reader
|
StreamReader
|
StreamReader object producing multiple stream to multiplex. |
required |
start
|
int
|
GPS start time of stream, in nanoseconds. |
None
|
timeout
|
int = 0
|
Overall timeout for the muxer, in nanoseconds. Overrides individual queue timeouts. If not specified the mux timeout will be the max of the individual queue timeouts. |
0
|
on_gap
|
str
|
Policy for strides in which no stream has any data. 'fill'
(default) emits masked gap blocks so the output timeline is
continuous; 'skip' emits nothing for such strides (sparse
output, no cost for absence); 'raise' raises |
ONGAP_DEFAULT
|
stride
|
int
|
Duration of output blocks, in nanoseconds. Must be an integer multiple of the native stride — the least common multiple of the individual stream strides — which is also the default. Larger strides aggregate multiple native blocks into each output block. |
None
|
Source code in arrakis/mux.py
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 | |
__getitem__ ¶
__getitem__(key)
Access an individual queue.
Source code in arrakis/mux.py
608 609 610 | |
declare_complete ¶
declare_complete(time_ns)
Declare all data before time_ns final: absence is gap.
Advances every queue's known horizon to at least time_ns
(rounded up to each queue's stride) without storing anything,
so pulls can serve the span with missing data synthesized as
gaps. For a bounded request whose source is exhausted, this
lets the stream finish with explicit gaps instead of waiting
forever for data that cannot arrive; data older than the
declared horizon arriving afterwards is dropped as too old.
Source code in arrakis/mux.py
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 | |
pull ¶
pull(stride=None)
Pull synchronized, concatenated, combined blocks from all streams covering the overall specified stride.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
stride
|
int
|
Duration to pull, in nanoseconds. Defaults to the output stride; the end-of-stream tail flush pulls at the native stride. |
None
|
Returns:
| Type | Description |
|---|---|
SeriesBlock or None
|
The combined block for the next stride, or None if the
stride held no data and was skipped ( |
Source code in arrakis/mux.py
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 | |
push ¶
push(stream_name, block)
Push an element for time into a particular queue.
Source code in arrakis/mux.py
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 | |
ready ¶
ready()
True if all queues have the expected number of elements
covering the overall muxer stride.
Source code in arrakis/mux.py
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 | |
TimedQueue ¶
TimedQueue(stride, timeout, start=None, *, name='')
Bases: Generic[T]
A sequential, time-stamped queue handling gaps and timeouts.
The queue stores only real elements; the spans between them are gaps, synthesized lazily when pulled. Two integer cursors define the queue state:
cursor: the next timestamp to be served by :meth:pull.horizon: the end (exclusive) of the known span. Every stride in[cursor, horizon)is either a stored element or a gap. Elements older than the horizon are rejected.
The horizon advances when an element is pushed (per-stream delivery is assumed to be in time order, so an element at time T implies nothing older is still coming) and, for live streams, when the timeout deadline passes (absence past the deadline is declared to be a gap). A discontinuity of any size therefore costs no memory: it is served as synthesized gaps between the two stored elements that surround it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
start
|
int
|
GPS start time of queue, in nanoseconds. |
None
|
stride
|
int
|
Time step for elements in the queue, in nanoseconds. |
required |
timeout
|
int
|
Timeout for elements in the queue, in nanoseconds. |
required |
Source code in arrakis/mux.py
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 | |
initialized
property
¶
initialized
Whether the queue has aligned to its first element (live queues) or was given a start time.
__len__ ¶
__len__()
Number of buffered real elements (gap spans are implicit).
Source code in arrakis/mux.py
194 195 196 | |
count_drop ¶
count_drop(kind, detail)
Count a dropped element; log a summary at most once per DROP_LOG_INTERVAL seconds per kind (first drop logs immediately), so sustained loss leaves a fingerprint in the logs without flooding them.
Source code in arrakis/mux.py
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | |
drain_until ¶
drain_until(target_time)
Advance the cursor so serving resumes at or after target_time.
Source code in arrakis/mux.py
447 448 449 450 451 452 453 454 455 456 457 458 | |
ensure_buffer ¶
ensure_buffer(duration)
Raise the backpressure cap to hold at least the given span of elements, with the usual 2x headroom (used when the muxer serves multiples of the queue stride).
Source code in arrakis/mux.py
286 287 288 289 290 | |
finish_drop ¶
finish_drop(kind)
End a drop episode for kind: return and clear the unreported count and the rate-limit state, so the next drop of this kind warns immediately again.
Source code in arrakis/mux.py
180 181 182 183 184 185 | |
front_time ¶
front_time()
Return the next timestamp to be served, or None if nothing is known.
Source code in arrakis/mux.py
440 441 442 443 444 445 | |
next_element_time ¶
next_element_time()
Return the timestamp of the oldest buffered element, or None.
Unlike :meth:front_time this ignores gap spans: it reports
where the next real element is, however far ahead.
Source code in arrakis/mux.py
429 430 431 432 433 434 435 436 437 438 | |
pull ¶
pull(duration=None, *, update_timeout=True)
Drain the queue.
Gaps are represented by None elements, synthesized on the fly.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
duration
|
int
|
Duration to extract, in nanoseconds. If the specified duration is not available, no elements will be returned. If not specified, the known span will be drained. |
None
|
update_timeout
|
bool
|
Whether to trigger timeout gap-filling before pulling. Default is True. Set to False when the caller has already updated timeouts (e.g. BlockMuxStream.pull()). |
True
|
Yields:
| Type | Description |
|---|---|
tuple[time, element]
|
The element from the queue and it's associated timestamp. |
Source code in arrakis/mux.py
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 | |
push ¶
push(time, element, on_drop=ONDROP_DEFAULT)
Push an element into the queue.
The time being pushed into the queue must be a multiple of the time stride specified at initialization of the queue.
If the time associated with the pushed element is older than the queue's horizon (already served or declared gap), the element will be dropped and this operation will be a no-op.
Pushing None declares the span up to time to be a gap
without storing anything.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
time
|
int
|
GPS time associated with the element, in nanoseconds |
required |
element
|
Any
|
element being pushed into the queue. |
required |
on_drop
|
str
|
Per-event behavior when the item is dropped as too old (e.g. it arrived after the timeout declared its span a gap, or it is a duplicate). Options are 'ignore', 'raise', or 'warn'. Default is 'ignore': drops are expected under the latency contract, and are always counted and summarized in the log at most once per DROP_LOG_INTERVAL regardless of this policy. |
ONDROP_DEFAULT
|
Source code in arrakis/mux.py
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 | |
ready ¶
ready(duration, *, update_timeout=True)
Check if queue holds duration worth of elements
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
duration
|
int
|
Duration to check for, in nanoseconds. |
required |
update_timeout
|
bool
|
Whether to trigger timeout gap-filling before checking. Default is True. Set to False when the caller has already updated timeouts (e.g. BlockMuxStream.ready()). |
True
|
Returns:
| Type | Description |
|---|---|
int or None
|
Returns either the number of elements that span duration, or None if the known span does not cover duration. |
Source code in arrakis/mux.py
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 | |
update_timeout ¶
update_timeout(now_ns=None)
Declare absence past the timeout deadline a gap.
now_ns is the current GPS time in nanoseconds; a caller
updating many queues at once passes one reading to all of them.
Source code in arrakis/mux.py
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 | |
describe_stream ¶
describe_stream(stream_name, channels, label=None)
A readable name for a stream's queue in log messages.
Stream keys are transport identifiers (a partition id, a Flight endpoint), so the name leads with the channels the stream carries, keeps the key for correlation, and takes an optional caller label for context (e.g. which reader or request the queue belongs to).
Source code in arrakis/mux.py
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 | |