write-no-hang-p

Arguments: stream

If the argument stream is an integer, write-no-hang-p views that integer as an output file-descriptor, and it just checks the file-descriptor for readiness.

When stream is a stream, the output-handle of stream is queried to see if writing can be done. true is returned if writing can be done, else nil is returned. If the handle is itself a stream (an encapsulation), the stream is examined for output availability. If an error would be signalled on the stream, then true is returned, as if writing can be done.

In more detail, regardless of the type of stream, the buffer is checked for fullness. If it is not full, then true is returned.

If the buffer is full, then device-write is called with nil as the buffer, 0 as both start and end arguments, and blocking set to nil. If these return an indication that a write is possible, then true is returned, otherwise nil is returned.

See streams.htm for information on the simple-streams implementation in Allegro CL.

Copyright (c) 1998-2019, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.2 page.
Created 2012.5.30.