aboutsummaryrefslogtreecommitdiffstats
path: root/src/termhooks.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/termhooks.h')
-rw-r--r--src/termhooks.h15
1 files changed, 3 insertions, 12 deletions
diff --git a/src/termhooks.h b/src/termhooks.h
index 46962a1217d..53e401de409 100644
--- a/src/termhooks.h
+++ b/src/termhooks.h
@@ -592,23 +592,14 @@ struct terminal
592 592
593 TERMINAL indicates which terminal device to read from. Input 593 TERMINAL indicates which terminal device to read from. Input
594 events should be read into BUF, the size of which is given in 594 events should be read into BUF, the size of which is given in
595 SIZE. EXPECTED is non-zero if the caller suspects that new input 595 SIZE.
596 is available.
597 596
598 A positive return value indicates that that many input events 597 A positive return value indicates that that many input events
599 where read into BUF. 598 were read into BUF.
600 Zero means no events were immediately available. 599 Zero means no events were immediately available.
601 A value of -1 means a transient read error, while -2 indicates 600 A value of -1 means a transient read error, while -2 indicates
602 that the device was closed (hangup), and it should be deleted. 601 that the device was closed (hangup), and it should be deleted. */
603
604 XXX Please note that a non-zero value of EXPECTED only means that
605 there is available input on at least one of the currently opened
606 terminal devices -- but not necessarily on this device.
607 Therefore, in most cases EXPECTED should be simply ignored.
608
609 XXX This documentation needs to be updated. */
610 int (*read_socket_hook) (struct terminal *terminal, 602 int (*read_socket_hook) (struct terminal *terminal,
611 int expected,
612 struct input_event *hold_quit); 603 struct input_event *hold_quit);
613 604
614 /* Called when a frame's display becomes entirely up to date. */ 605 /* Called when a frame's display becomes entirely up to date. */