Event loop basics + libuv

2026-06-22 15:48:22 +00:00 · 2016-09-03 22:04:25 -07:00
parent 7c40bcff53
commit 9597101f08
508 changed files with 104809 additions and 51 deletions
@@ -0,0 +1,101 @@
+
+.. _tty:
+
+:c:type:`uv_tty_t` --- TTY handle
+=================================
+
+TTY handles represent a stream for the console.
+
+:c:type:`uv_tty_t` is a 'subclass' of :c:type:`uv_stream_t`.
+
+
+Data types
+----------
+
+.. c:type:: uv_tty_t
+
+    TTY handle type.
+
+.. c:type:: uv_tty_mode_t
+
+    .. versionadded:: 1.2.0
+
+    TTY mode type:
+
+    ::
+
+      typedef enum {
+          /* Initial/normal terminal mode */
+          UV_TTY_MODE_NORMAL,
+          /* Raw input mode (On Windows, ENABLE_WINDOW_INPUT is also enabled) */
+          UV_TTY_MODE_RAW,
+          /* Binary-safe I/O mode for IPC (Unix-only) */
+          UV_TTY_MODE_IO
+      } uv_tty_mode_t;
+
+
+
+Public members
+^^^^^^^^^^^^^^
+
+N/A
+
+.. seealso:: The :c:type:`uv_stream_t` members also apply.
+
+
+API
+---
+
+.. c:function:: int uv_tty_init(uv_loop_t* loop, uv_tty_t* handle, uv_file fd, int readable)
+
+    Initialize a new TTY stream with the given file descriptor. Usually the
+    file descriptor will be:
+
+    * 0 = stdin
+    * 1 = stdout
+    * 2 = stderr
+
+    `readable`, specifies if you plan on calling :c:func:`uv_read_start` with
+    this stream. stdin is readable, stdout is not.
+
+    On Unix this function will determine the path of the fd of the terminal
+    using :man:`ttyname_r(3)`, open it, and use it if the passed file descriptor
+    refers to a TTY. This lets libuv put the tty in non-blocking mode without
+    affecting other processes that share the tty.
+
+    This function is not thread safe on systems that don't support
+    ioctl TIOCGPTN or TIOCPTYGNAME, for instance OpenBSD and Solaris.
+
+    .. note::
+        If reopening the TTY fails, libuv falls back to blocking writes for
+        non-readable TTY streams.
+
+    .. versionchanged:: 1.9.0: the path of the TTY is determined by
+                        :man:`ttyname_r(3)`. In earlier versions libuv opened
+                        `/dev/tty` instead.
+
+    .. versionchanged:: 1.5.0: trying to initialize a TTY stream with a file
+                        descriptor that refers to a file returns `UV_EINVAL`
+                        on UNIX.
+
+.. c:function:: int uv_tty_set_mode(uv_tty_t* handle, uv_tty_mode_t mode)
+
+    .. versionchanged:: 1.2.0: the mode is specified as a
+                        :c:type:`uv_tty_mode_t` value.
+
+    Set the TTY using the specified terminal mode.
+
+.. c:function:: int uv_tty_reset_mode(void)
+
+    To be called when the program exits. Resets TTY settings to default
+    values for the next process to take over.
+
+    This function is async signal-safe on Unix platforms but can fail with error
+    code ``UV_EBUSY`` if you call it when execution is inside
+    :c:func:`uv_tty_set_mode`.
+
+.. c:function:: int uv_tty_get_winsize(uv_tty_t* handle, int* width, int* height)
+
+    Gets the current Window size. On success it returns 0.
+
+.. seealso:: The :c:type:`uv_stream_t` API functions also apply.