diff options
| author | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2012-01-18 14:03:39 +0000 |
|---|---|---|
| committer | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2012-01-18 14:03:39 +0000 |
| commit | 6d6afe788c3ec1f320e12449eee230fb366228c5 (patch) | |
| tree | a7f17b111e20dbe67bcaf5067f2ecd9c00d9f1db /man/termkey_advisereadable.3 | |
| parent | 82ad14175cbcc7c0c660720c7a31f8e6f1cefe4e (diff) | |
| download | termo-6d6afe788c3ec1f320e12449eee230fb366228c5.tar.gz termo-6d6afe788c3ec1f320e12449eee230fb366228c5.tar.xz termo-6d6afe788c3ec1f320e12449eee230fb366228c5.zip | |
Allow passing fd = -1 to constructor to make an instance not associated with an fd; must use push_bytes to provide it input
Diffstat (limited to 'man/termkey_advisereadable.3')
| -rw-r--r-- | man/termkey_advisereadable.3 | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/man/termkey_advisereadable.3 b/man/termkey_advisereadable.3 index 3c63fdd..2d7ca4a 100644 --- a/man/termkey_advisereadable.3 +++ b/man/termkey_advisereadable.3 @@ -10,7 +10,7 @@ termkey_advisereadable \- read more bytes from the underlying terminal .sp Link with \fI-ltermkey\fP. .SH DESCRIPTION -\fBtermkey_advisereadable\fP() informs the instance that new input may be available on the underlying file descriptor and so it should call \fBread\fP(2) to obtain it. If at least one more byte was read it will return \fBTERMKEY_RES_AGAIN\fP to indicate it may be useful to call \fBtermkey_getkey\fP(3) again. If no more input was read then \fBTERMKEY_RES_NONE\fP is returned. If there was no buffer space remaining, then \fBTERMKEY_RES_ERROR\fP is returned with \fIerrno\fP set to \fBENOMEM\fP. +\fBtermkey_advisereadable\fP() informs the instance that new input may be available on the underlying file descriptor and so it should call \fBread\fP(2) to obtain it. If at least one more byte was read it will return \fBTERMKEY_RES_AGAIN\fP to indicate it may be useful to call \fBtermkey_getkey\fP(3) again. If no more input was read then \fBTERMKEY_RES_NONE\fP is returned. If there was no buffer space remaining, then \fBTERMKEY_RES_ERROR\fP is returned with \fIerrno\fP set to \fBENOMEM\fP. If no filehandle is associated with this instance, \fBTERMKEY_RES_ERROR\fP is returned with \fIerrno\fP set to \fBEBADF\fP. .PP This function, along with \fBtermkey_getkey\fP(3) make it possible to use the termkey instance in an asynchronous program. To provide bytes without using a readable file handle, use \fBtermkey_push_bytes\fP(3). .PP |