close-async-io-state Function

Summary

Closes an async-io-state and removes it from any internal structures.

Package

comm

Signature

close-async-io-state async-io-state &key keep-alive-p => buffered-data-length

Arguments

async-io-state⇩	An async-io-state.
keep-alive-p⇩	A generalized boolean.

Values

buffered-data-length

A non-negative integer.

Description

The function close-async-io-state closes async-io-state and removes it from any internal structures. Once async-io-state has been closed, you cannot perform I/O operations on it.

By default, close-async-io-state also closes the object in async-io-state (that is, the argument to create-async-io-state). This closing can be prevented by supplying true for keep-alive-p, so you can perform further I/O operations on that object. In this case you will need to close object later.

async-io-state may contain some buffered data that it read from the object but did not use yet. The return value is the length of such data and you can use async-io-state-get-buffered-data to get it.

Notes

If async-io-state is attached to SSL, then it is detached. This occurs even if keep-alive-p is true.

See also

25.7.2 The Async-I/O-State API
25 TCP and UDP socket communication and SSL