Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the semantics of receiveWait and similar #261

Open
facundominguez opened this issue Nov 2, 2015 · 1 comment
Open

Document the semantics of receiveWait and similar #261

facundominguez opened this issue Nov 2, 2015 · 1 comment
Projects

Comments

@facundominguez
Copy link
Contributor

Currently the documentation reads:

-- | Test the matches in order against each message in the queue
receiveWait :: [Match b] -> Process b Source

This is not sufficient, I think, to understand how receiveWait works in the presence of multiple messages in the mailbox and multiple match clauses. The order in which matches are done should be stated less succinctly.

I suppose we should also say that this function:

  • blocks when no message matches
  • it is interruptible when no message matches (can it be interrupted even if some message matches?).
@hyperthunk
Copy link
Member

it is interruptible when no message matches (can it be interrupted even if some message matches?).

Yes, and we need to point out that if it is interrupted even if some message matches, the mailbox is not modified...

@hyperthunk hyperthunk added this to To do in Release 0.8 Nov 21, 2018
@hyperthunk hyperthunk moved this from Backlog to Prioritised Backlog in Release 0.8 Nov 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Release 0.8
  
Prioritised Backlog
Development

No branches or pull requests

2 participants