Philip Withnall 4314944e56 introspection: Drop Unix and Win32 prefixes from platform specific APIs
So now introspection users will have to call `GLibUnix.open_pipe()`
rather than `GLibUnix.unix_open_pipe()` — or
`GLibWin32.check_windows_version()` rather than
`GLibWin32.win32_check_windows_version()`.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
2024-02-12 17:54:36 +00:00

49 lines
1.2 KiB
Markdown

Title: Unix-specific Utilities
SPDX-License-Identifier: LGPL-2.1-or-later
SPDX-FileCopyrightText: 2011 Colin Walters
# Unix-specific Utilities
Most of GLib is intended to be portable; in contrast, this set of
functions is designed for programs which explicitly target Unix,
or are using it to build higher level abstractions which would be
conditionally compiled if the platform matches `G_OS_UNIX`.
To use these functions, you must explicitly include the
`glib-unix.h` header.
## File Descriptors
* [func@GLibUnix.open_pipe]
* [func@GLibUnix.set_fd_nonblocking]
## Pipes
The [struct@GLibUnix.Pipe] structure can be used to conveniently open and
manipulate a Unix pipe.
<!-- FIXME: https://gitlab.gnome.org/GNOME/gi-docgen/-/issues/173 -->
The methods for it are all static inline for efficiency. They are:
* `g_unix_pipe_open()`
* `g_unix_pipe_get()`
* `g_unix_pipe_steal()`
* `g_unix_pipe_close()`
* `g_unix_pipe_clear()`
## Signals
* [func@GLibUnix.signal_add]
* [func@GLibUnix.signal_add_full]
* [func@GLibUnix.signal_source_new]
## Polling
* [func@GLibUnix.fd_add]
* [func@GLibUnix.fd_add_full]
* [func@GLibUnix.fd_source_new]
## User Database
* [func@GLibUnix.get_passwd_entry]