async-io-state-get-buffered-data

async-io-state-get-buffered-data Function

Summary

Copies buffered data from an async-io-state and discards it from the state.

Package

comm

Signature

async-io-state-get-buffered-data async-io-state buffer &key start end => length

Arguments

`async-io-state`⇩	An async-io-state.
`buffer`⇩	A cl:base-string or an 8-bit cl:simple-array.
`start`⇩	A lower bounding index designator for `buffer`.
`end`⇩	An upper bounding index designator for `buffer`.

Values

length⇩

A non-negative integer.

Description

The function async-io-state-get-buffered-data copies to the buffer buffer (between start and end) as much as possible of the buffered data in async-io-state and discards it from async-io-state.

The default value of start is 0. The default value of end is the length of buffer.

The return value length is the number of elements copied into buffer.

async-io-state-get-buffered-data cannot be called while an operation is active in async-io-state, that is between the call to async-io-state-read-buffer or async-io-state-write-buffer, and the call to the callback or async-io-state-abort, or between a call to async-io-state-read-with-checking and the call to async-io-state-finish or async-io-state-abort.

Notes

Use async-io-state-buffered-data-length to find how much buffered data there is in async-io-state.