Scieneer Common Lisp 1.3.9 online documentation

ext:stream-timeout stream[Generic Function]

Return the current timeout for the stream in seconds, or nil if there is no timeout. The timeout is implemented for file descriptor based streams which includes network socket streams, and SSL streams, and also methods are provided for composite streams to set the source and target stream timeout. When appropriate, user defined composite streams should provide a method to return the source or target stream timeout. A default method is provided for the class stream that returns nil. See also ext:stream-expiration.

(setf (ext:stream-timeout stream) timeout)[Generic Function]

Set the timeout for the stream. The timeout may be either a real number specifying the timeout in seconds, or nil for no timeout. When a timeout is specified, blocking operations on the stream may timeout and generate an ext:io-timeout error. The stream timeout sets a time limit on individual stream operations and can be useful for placing a time limit on idle streams. A time limit can be placed on a series of stream operations by setting the ext:stream-expiration. The effective timeout is reduced to be no greater than the time to stream expiration if any.

The timeout is implemented for file descriptor based streams which includes network socket streams, and SSL streams, and also methods are provided for composite stream to set the source and target stream timeout. When appropriate, user defined composite streams should provide a method to set the source and target stream timeout. A default method is provided for the class stream that does nothing if the new timeout is nil, otherwise it signals an error.