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

concurrency.messaging-docs: add help for handle-synchronous

factor-shell
Alexander Iljin 2018-01-05 00:59:27 +03:00 committed by John Benediktsson
parent d97a83889a
commit 737597fd5a
2 changed files with 9 additions and 3 deletions
basis/concurrency/messaging

10
basis/concurrency/messaging/messaging-docs.factor
View File

@ -24,6 +24,12 @@ HELP: receive-if
{ $description "Return the first message from the current thread's mailbox that satisfies the predicate. To satisfy the predicate, " { $snippet "pred" } " is called with the item on the stack and the predicate should leave a boolean indicating whether it was satisfied or not. If nothing in the mailbox satisfies the predicate then the thread will block until something does." } { $description "Return the first message from the current thread's mailbox that satisfies the predicate. To satisfy the predicate, " { $snippet "pred" } " is called with the item on the stack and the predicate should leave a boolean indicating whether it was satisfied or not. If nothing in the mailbox satisfies the predicate then the thread will block until something does." }
{ $see-also send receive } ; { $see-also send receive } ;
HELP: handle-synchronous
{ $values { "quot" "a " { $link quotation } " with stack effect " { $snippet "( ... message -- ... reply )" } }
}
{ $description "Receive a message that was sent with " { $link send-synchronous } ", call " { $snippet "quot" } " to transform it into a response and use " { $link reply-synchronous } " to reply."
} ;
HELP: spawn-linked HELP: spawn-linked
{ $values { "quot" quotation } { $values { "quot" quotation }
{ "name" string } { "name" string }
@ -52,13 +58,13 @@ ARTICLE: "concurrency-synchronous-sends" "Synchronous sends"
"The " { $link send } " word sends a message asynchronously, and the sending thread continues immediately. It is also possible to send a message to a thread and block until a response is received:" "The " { $link send } " word sends a message asynchronously, and the sending thread continues immediately. It is also possible to send a message to a thread and block until a response is received:"
{ $subsections send-synchronous } { $subsections send-synchronous }
"To reply to a synchronous message:" "To reply to a synchronous message:"
{ $subsections reply-synchronous } { $subsections reply-synchronous handle-synchronous }
"An example:" "An example:"
{ $example { $example
"USING: concurrency.messaging threads ;" "USING: concurrency.messaging threads ;"
"IN: scratchpad" "IN: scratchpad"
": pong-server ( -- )" ": pong-server ( -- )"
" receive [ \"pong\" ] dip reply-synchronous ;" " [ drop \"pong\" ] handle-synchronous ;"
"[ pong-server t ] \"pong-server\" spawn-server" "[ pong-server t ] \"pong-server\" spawn-server"
"\"ping\" swap send-synchronous ." "\"ping\" swap send-synchronous ."
"\"pong\"" "\"pong\""

2
basis/concurrency/messaging/messaging.factor
View File

@ -66,7 +66,7 @@ M: cannot-send-synchronous-to-self summary
: reply-synchronous ( message synchronous -- ) : reply-synchronous ( message synchronous -- )
[ <reply> ] keep sender>> send ; [ <reply> ] keep sender>> send ;
: handle-synchronous ( quot -- ) : handle-synchronous ( quot: ( ... message -- ... reply ) -- )
receive [ receive [
data>> swap call data>> swap call
] keep reply-synchronous ; inline ] keep reply-synchronous ; inline