Signals close to the peer, then waits up to timeout seconds for the peer to
close (or die). The peer confirms only after it has finished reading its
messages, which is what makes it safe to release the resources held by sent
payloads. On that confirmation, all resources are released and the region
name is deleted. The handle is dead afterwards, and closing it again does
nothing. On timeout the handle stays usable, and the resources are released
at garbage collection, which runs the same check again.
Arguments
- ch
a channel handle from
mizu_channel()(or thechbinding inside a peer expression).- timeout
seconds to wait for the close of the peer.
Details
After either side signals close, sends on both sides return the
mizu_closed sentinel, and receives drain the remaining messages before
they return the same.
Examples
ch <- mizu_channel(quote(mizu_send(ch, "done")))
mizu_recv(ch, timeout = 5)
#> [1] "done"
mizu_close(ch)