wait-for-wait-state-collection Function

Summary

Waits for a state in a collection to become active.

Package

comm

Signature

wait-for-wait-state-collection collection

Arguments

collection⇩

A wait-state-collection.

Description

The function wait-for-wait-state-collection waits for one of the states in collection to become active, or until some message arrives from another process. Such messages may be a result of creating a new async-io-state associated with collection, or a result of a call to apply-in-wait-state-collection-process. wait-for-wait-state-collection returns once any of the states in collection is ready or there is a message.

Notes

Typically you would not call wait-for-wait-state-collection yourself, but it will be called by loop-processing-wait-state-collection. However, sometimes you may want to create the looping code yourself. In the latter case, once wait-for-wait-state-collection returns, you will need to call call-wait-state-collection to handle the active states or messages in collection.

You can use apply-in-wait-state-collection-process with a function that does nothing (e.g. false) to wake up a waiting call to wait-for-wait-state-collection on a specific collection.

See also

create-and-run-wait-state-collection
loop-processing-wait-state-collection
25.7.2 The Async-I/O-State API
25 TCP and UDP socket communication and SSL