GIO Overview Introduction GIO is striving to provide a modern, easy-to-use VFS API that sits at the right level in the library stack. The goal is to overcome the shortcomings of GnomeVFS and provide an API that is so good that developers prefer it over raw POSIX calls. Among other things that means using GObject. It also means not cloning the POSIX API, but providing higher-level, document-centric interfaces. The abstract file system model of GIO consists of a number of interfaces and base classes for I/O and files: GFile reference to a file GFileInfo information about a file or filesystem GFileEnumerator list files in directories GDrive represents a drive GVolume represents a file system in an abstract way GMount represents a mounted file system Then there is a number of stream classes, similar to the input and output stream hierarchies that can be found in frameworks like Java: GInputStream read data GOutputStream write data GSeekable interface optionally implemented by streams to support seeking There are interfaces related to applications and the types of files they handle: GAppInfo information about an installed application GIcon abstract type for file and application icons Beyond these, GIO provides facilities for file monitoring, asynchronous I/O and filename completion. In addition to the interfaces, GIO provides implementations for the local case. Implementations for various network file systems are provided by the GVFS package as loadable modules. Other design choices which consciously break with the GnomeVFS design are to move backends out-of-process, which minimizes the dependency bloat and makes the whole system more robust. The backends are not included in GIO, but in the separate GVFS package. The GVFS package also contains the GVFS daemon, which spawn further mount daemons for each individual connection.
GIO in the GTK+ library stack
The GIO model of I/O is stateful: if an application establishes e.g. a SFTP connection to a server, it becomes available to all applications in the session; the user does not have to enter his password over and over again. One of the big advantages of putting the VFS in the GLib layer is that GTK+ can directly use it, e.g. in the filechooser.
Compiling GIO applications GIO comes with a gio-2.0.pc file that you should use together with pkg-config to obtain the necessary information about header files and libraries. See the pkg-config man page or the GLib documentation for more information on how to use pkg-config to compile your application. If you are using GIO on UNIX-like systems, you may want to use UNIX-specific GIO interfaces such as #GUnixInputStream, #GUnixOutputStream, #GUnixMount or #GDesktopAppInfo. To do so, use the gio-unix-2.0.pc file instead of gio-2.0.pc Running GIO applications GIO inspects a few of environment variables in addition to the ones used by GLib. <envar>XDG_DATA_HOME</envar>, <envar>XDG_DATA_DIRS</envar> GIO uses these environment variables to locate MIME information. For more information, see the Shared MIME-info Database and the Base Directory Specification. The following environment variables are only useful for debugging GIO itself or modules that it loads. They should not be set in a production environment. <envar>GIO_USE_VFS</envar> This environment variable can be set to the name of a #GVfs implementation to override the default for debugging purposes. The #GVfs implementation for local files that is included in GIO has the name "local", the implementation in the gvfs module has the name "gvfs". <envar>GIO_USE_VOLUME_MONITOR</envar> This variable can be set to the name of a #GVolumeMonitor implementation to override the default for debugging purposes. The #GVolumeMonitor implementation for local files that is included in GIO has the name "unix", the hal-based implementation in the gvfs module has the name "hal". <envar>GIO_USE_URI_ASSOCIATION</envar> This variable can be set to the name of a #GDesktopAppInfoLookup implementation to override the dfeault for debugging purposes. GIO does not include a #GDesktopAppInfoLookup implementation, the GConf-based implementation in the gvfs module has the name "gconf". <envar>GVFS_INOTIFY_DIAG</envar> When this environment variable is set and GIO has been built with inotify support, a dump of diagnostic inotify information will be written every 20 seconds to a file named /tmp/gvfsdid.pid. Extending GIO A lot of the functionality that is accessible through GIO is implemented in loadable modules, and modules provide a convenient way to extend GIO. In addition to the #GIOModule API which supports writing such modules, GIO has a mechanism to define extension points, and register implementations thereof, see #GIOExtensionPoint. The following extension points are currently defined by GIO: G_VFS_EXTENSION_POINT_NAME Allows to override the functionality of the #GVfs class. Implementations of this extension point must be derived from #GVfs. GIO uses the implementation with the highest priority that is active, see g_vfs_is_active(). GIO implements this extension point for local files, gvfs contains an implementation that supports all the backends in gvfs. G_VOLUME_MONITOR_EXTENSION_POINT_NAME Allows to add more volume monitors. Implementations of this extension point must be derived from #GVolumeMonitor. GIO uses all registered extensions. gvfs contains an implementation that works together with the #GVfs implementation in gvfs. G_NATIVE_VOLUME_MONITOR_EXTENSION_POINT_NAME Allows to override the 'native' volume monitor. Implementations of this extension point must be derived from #GNativeVolumeMonitor. GIO uses the implementation with the highest priority that is supported, as determined by the is_supported() vfunc in #GVolumeMonitorClass. GIO implements this extension point for local mounts, gvfs contains a hal-based implementation. G_LOCAL_FILE_MONITOR_EXTENSION_POINT_NAME Allows to override the file monitor implementation for local files. Implementations of this extension point must be derived from #GLocalFileMonitor. GIO uses the implementation with the highest priority that is supported, as determined by the is_supported() vfunc in #GLocalFileMonitorClass. GIO uses this extension point internally, to switch between its fam-based and inotify-based file monitoring implementations. G_LOCAL_DIRECTORY_MONITOR_EXTENSION_POINT_NAME Allows to override the directory monitor implementation for local files. Implementations of this extension point must be derived from #GLocalDirectoryMonitor. GIO uses the implementation with the highest priority that is supported, as determined by the is_supported() vfunc in #GLocalDirectoryMonitorClass. GIO uses this extension point internally, to switch between its fam-based and inotify-based directory monitoring implementations. G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME Unix-only. Allows to provide a way to associate default handlers with URI schemes. Implementations of this extension point must implement the #GDesktopAppInfoLookup interface. GIO uses the implementation with the highest priority. gvfs contains a GConf-based implementation that uses the same GConf keys as gnome-vfs.