diff options
| author | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2012-01-18 13:39:50 +0000 |
|---|---|---|
| committer | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2012-01-18 13:39:50 +0000 |
| commit | 82ad14175cbcc7c0c660720c7a31f8e6f1cefe4e (patch) | |
| tree | 8c20d19ebbf277de41a1d89167576a4b087f6011 /man/termkey_advisereadable.3 | |
| parent | 082b49f0f8790e2cf98346a03c53f492d9d5dcba (diff) | |
| download | termo-82ad14175cbcc7c0c660720c7a31f8e6f1cefe4e.tar.gz termo-82ad14175cbcc7c0c660720c7a31f8e6f1cefe4e.tar.xz termo-82ad14175cbcc7c0c660720c7a31f8e6f1cefe4e.zip | |
Added termkey_push_bytes(), a new API for providing input bytes
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 06e0467..3c63fdd 100644 --- a/man/termkey_advisereadable.3 +++ b/man/termkey_advisereadable.3 @@ -12,7 +12,7 @@ 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. .PP -This function, along with \fBtermkey_getkey\fP(3) make it possible to use the termkey instance in an asynchronous program. +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 For synchronous usage, \fBtermkey_waitkey\fP(3) performs the input blocking task. .SH "RETURN VALUE" |