steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

concurrency.mailboxes: some cleanup and docs.

factor-shell
John Benediktsson 2018-01-22 07:51:43 -08:00
parent 12166d3693
commit be20da972a
2 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
basis/concurrency/mailboxes/mailboxes-docs.factor
View File

@ -1,4 +1,4 @@
USING: help.markup help.syntax kernel arrays calendar ; USING: help.markup help.syntax kernel calendar sequences ;
IN: concurrency.mailboxes IN: concurrency.mailboxes
HELP: <mailbox> HELP: <mailbox>
@ -29,15 +29,19 @@ HELP: block-if-empty
{ $values { "mailbox" mailbox } { $values { "mailbox" mailbox }
{ "timeout" { $maybe duration } } { "timeout" { $maybe duration } }
} }
{ $description "Block the thread if the mailbox is empty." } ; { $description "Block the thread for " { $snippet "timeout" } " if the mailbox is empty." } ;
HELP: mailbox-get HELP: mailbox-get
{ $values { "mailbox" mailbox } { "obj" object } } { $values { "mailbox" mailbox } { "obj" object } }
{ $description "Get the first item put into the mailbox. If it is empty, the thread blocks until an item is put into it. The thread then resumes, leaving the item on the stack." } ; { $description "Get the first item put into the mailbox. If it is empty, the thread blocks until an item is put into it. The thread then resumes, leaving the item on the stack." } ;
HELP: mailbox-get-all-timeout
{ $values { "mailbox" mailbox } { "timeout" { $maybe duration } } { "seq" sequence } }
{ $description "Blocks the thread for " { $snippet "timeout" } " if the mailbox is empty, then removes all objects in the mailbox and returns a sequence containing the objects." } ;
HELP: mailbox-get-all HELP: mailbox-get-all
{ $values { "mailbox" mailbox } { "array" array } } { $values { "mailbox" mailbox } { "seq" sequence } }
{ $description "Blocks the thread if the mailbox is empty, otherwise removes all objects in the mailbox and returns an array containing the objects." } ; { $description "Blocks the thread if the mailbox is empty, then removes all objects in the mailbox and returns a sequence containing the objects." } ;
HELP: while-mailbox-empty HELP: while-mailbox-empty
{ $values { "mailbox" mailbox } { $values { "mailbox" mailbox }
@ -69,7 +73,10 @@ ARTICLE: "concurrency.mailboxes" "Mailboxes"
mailbox-get-timeout? mailbox-get-timeout?
} }
"Emptying out a mailbox:" "Emptying out a mailbox:"
{ $subsections mailbox-get-all } { $subsections
mailbox-get-all
mailbox-get-all-timeout
}
"Adding an element:" "Adding an element:"
{ $subsections mailbox-put } { $subsections mailbox-put }
"Testing if a mailbox is empty:" "Testing if a mailbox is empty:"

4
basis/concurrency/mailboxes/mailboxes.factor
View File

@ -47,10 +47,10 @@ M: mailbox mailbox-get-timeout block-if-empty data>> pop-back ;
: mailbox-get ( mailbox -- obj ) : mailbox-get ( mailbox -- obj )
f mailbox-get-timeout ; inline f mailbox-get-timeout ; inline
: mailbox-get-all-timeout ( mailbox timeout -- array ) : mailbox-get-all-timeout ( mailbox timeout -- seq )
block-if-empty data>> [ ] collector [ slurp-deque ] dip ; block-if-empty data>> [ ] collector [ slurp-deque ] dip ;
: mailbox-get-all ( mailbox -- array ) : mailbox-get-all ( mailbox -- seq )
f mailbox-get-all-timeout ; f mailbox-get-all-timeout ;
: while-mailbox-empty ( mailbox quot -- ) : while-mailbox-empty ( mailbox quot -- )