Scieneer Common Lisp 1.3.9 online documentation

sys:make-fd-stream file-descriptor &key input output element-type external-format buffering timeout expiration in-buffer-size out-buffer-size name auto-close file original delete-original close-abort-remove pathname interactive[Function]

Create a stream for the given unix file-descriptor.

:input
If true, allow input operations. This is the default if neither :input or :output is specified.
:output
If true, allow output operations.
:element-type
Indicates the element type to use. Only subtypes of character and '(unsigned-byte 8) types are supported.
:external-format
The external format to use. The default value is :default for which the value of ext:*default-external-format* is used. The external format may be a keyword representing a character set to use for character streams, or a list of formats that convert from the desired character or binary stream to the binary stream read and/or written to the file descriptor. Leading character based formats are ignored for binary streams.
:buffering
Indicates the kind of output buffer flushing to use which may be one of: :none, :line, or the default :full. Line buffering is only applicable to character streams.
:timeout
The number of seconds to wait upon an input or output operation. If false, which is the default, then wait forever. When a timeout occurs the sys:io-timeout condition is signaled.
:expiration
The number of seconds before the stream expires. If false, which is the default, then the stream does not expire. When the stream expires, the sys:io-timeout condition is signaled until the expiration time is reset.
:pathname
The file pathname for a file-stream. This will be returned by pathname and causes a file-stream to be created.
:file
The namestring of the file pathname. This must be supplied whenever the pathname is supplied.
:name
Used to identify the stream when printed.
:auto-close
When true, a finalization is created to ensure the file-descriptor is closed when there are no more references to the returned stream, and the file descriptor will also be closed upon a throw output of this function which can occur upon an error. When true, the caller must not close the file descriptor upon an error because it may already have been closed. When false, it is the responsibility of the caller to close the file descriptor, even upon an error.
:interactive
When t or nil, flag the stream as interactive or non-interactive respectively. When :tty, which is the default, the stream is flagged as interactive if it is associated with a tty device. The state of the stream may be read or written using interactive-stream-p.