2004-08-20 Michael Chastain <mec.gnu@mindspring.com>

[deliverable/binutils-gdb.git] / gdb / serial.h

diff --git a/gdb/serial.h b/gdb/serial.h
index a0dbe723acb1fb4922a2e61814abb05c3a8a7e8a..abe76b006797b07254f5712b72d73e843c543928 100644 (file)
--- a/gdb/serial.h
+++ b/gdb/serial.h
@@ -22,6 +22,8 @@
 #ifndef SERIAL_H
 #define SERIAL_H
 
+struct ui_file;
+
 /* For most routines, if a failure is indicated, then errno should be
    examined.  */
 
@@ -32,7 +34,10 @@ typedef void *serial_ttystate;
 struct serial;
 
 /* Try to open NAME.  Returns a new `struct serial *' on success, NULL
-   on failure. */
+   on failure. Note that some open calls can block and, if possible, 
+   should be  written to be non-blocking, with calls to ui_look_hook 
+   so they can be cancelled. An async interface for open could be
+   added to GDB if necessary. */
 
 extern struct serial *serial_open (const char *name);
 
@@ -57,8 +62,9 @@ extern void serial_un_fdopen (struct serial *scb);
 enum serial_rc {
   SERIAL_ERROR = -1,   /* General error. */
   SERIAL_TIMEOUT = -2, /* Timeout or data-not-ready during read.
-                          Unfortunately, through ui_loop_hook(), this
-                          can also be a QUIT indication.  */
+                          Unfortunately, through
+                          deprecated_ui_loop_hook(), this can also be
+                          a QUIT indication.  */
   SERIAL_EOF = -3      /* General end-of-file or remote target
                           connection closed, indication.  Includes
                           things like the line dropping dead. */