Skip to content

Commit c8ec94a

Browse files
committed
Slight Supply.throttle reorganization
1 parent 42f7864 commit c8ec94a

File tree

1 file changed

+36
-33
lines changed

1 file changed

+36
-33
lines changed

doc/Type/Supply.pod

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -387,39 +387,7 @@ for the types of messages that you can send to control the throttle.
387387
388388
The :status named parameter optionally specifies a Supply that will receive
389389
any status messages. If specified, it will at least send one status message
390-
after the original Supply is exhausted. The status message is a hash with
391-
the following keys:
392-
393-
=item allowed
394-
395-
The current number of messages / callables that is still allowed to be
396-
passed / executed.
397-
398-
=item bled
399-
400-
The number of messages routed to the :bleed Supply.
401-
402-
=item buffered
403-
404-
The number of messages currently buffered because of overflow.
405-
406-
=item emitted
407-
408-
The number of messages emitted (passed through).
409-
410-
=item id
411-
412-
The id of this status message (a monotonically increasing number). Handy
413-
if you want to log status messages.
414-
415-
=item limit
416-
417-
The current limit that is being applied.
418-
419-
=item vent-at
420-
421-
The maximum number of messages that may be buffered before they're
422-
automatically re-routed to the :bleed Supply.
390+
after the original Supply is exhausted. See L<status message> below.
423391
424392
The :bleed named parameter optionally specifies a Supply that will receive
425393
any values that were either explicitly bled (with the B<bleed> control
@@ -457,6 +425,41 @@ rerouting of buffered values to match the new maximum.
457425
458426
Send a status message to the :status Supply with the given id.
459427
428+
=head3 status message
429+
430+
The status return message is a hash with the following keys:
431+
432+
=item allowed
433+
434+
The current number of messages / callables that is still allowed to be
435+
passed / executed.
436+
437+
=item bled
438+
439+
The number of messages routed to the :bleed Supply.
440+
441+
=item buffered
442+
443+
The number of messages currently buffered because of overflow.
444+
445+
=item emitted
446+
447+
The number of messages emitted (passed through).
448+
449+
=item id
450+
451+
The id of this status message (a monotonically increasing number). Handy
452+
if you want to log status messages.
453+
454+
=item limit
455+
456+
The current limit that is being applied.
457+
458+
=item vent-at
459+
460+
The maximum number of messages that may be buffered before they're
461+
automatically re-routed to the :bleed Supply.
462+
460463
=head2 method stable
461464
462465
method stable(Supply:D: $seconds, :$scheduler) returns Supply:D

0 commit comments

Comments
 (0)