Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Clarify timeout doc to mention that close! should not be called on a timeout channel

Description

After running into a race-condition involving closed timeout channels, it seems like it would be appropriate to mention that `close!` should never be called on a timeout channel in its docstring. The attached patch tweaks the doc string to that effect. Please advise if you'd like the wording changed a bit.

Environment

None

Attachments

2

Activity

Show:

Kevin Downey June 9, 2022 at 10:23 PM
Edited

I’ve attached a patch that changes timeout on the clojure and clojurescript sides to return someting that only satisfies ReadPort. I updated the docstring too, but the wording is rather awkward.

Dimitrios Jim Piliouras September 12, 2020 at 9:59 AM
Edited

If ManyToManyChannel was a defrecord(rather than a deftype) it would support metadata, which would enable timeout to expose something to close!. But that of course will change equality semantics, so it’s not that trivial. I guess another approach would be for ManyToManyChannel to implement IObj, but that opens up its own can of worms. Something like alter-meta! seems more appropriate for channels, but at the same time they can’t be considered an IReference.

Finally, the impl/Channelprotocol could define an extra close? fn, the ManyToManyChanneldeftype an extra boolean ctor-param (defaulting to true), and the chan ctor-fn an extra arity (which timers/timeout would use to pass false).

Alex Miller November 19, 2018 at 8:34 PM

Yeah, I think it would be better to fix this than doc it.

Erik Assum December 30, 2014 at 2:25 PM

or alternately, make it a no-op?

Howard Lewis Ship December 12, 2014 at 5:03 PM

Alternately/additionally, it would be nice if close! on a timeout channel would throw an exception.

Details

Assignee

Reporter

Labels

Patch

Code

Priority

Created December 11, 2014 at 7:59 PM
Updated June 9, 2022 at 10:47 PM