GVolumeMonitor

GVolumeMonitor — Volume Monitor

Object Hierarchy

    GObject
    ╰── GVolumeMonitor

Includes

#include <gio/gio.h>

Description

GVolumeMonitor is for listing the user interesting devices and volumes on the computer. In other words, what a file selector or file manager would show in a sidebar.

GVolumeMonitor is not thread-default-context aware, and so should not be used other than from the main thread, with no thread-default-context active.

Functions

g_volume_monitor_get ()

GVolumeMonitor *
g_volume_monitor_get (void);

Gets the volume monitor used by gio.

Returns

a reference to the GVolumeMonitor used by gio. Call g_object_unref() when done with it.

[transfer full]


g_volume_monitor_get_connected_drives ()

GList *
g_volume_monitor_get_connected_drives (GVolumeMonitor *volume_monitor);

Gets a list of drives connected to the system.

The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref().

Parameters

volume_monitor

a GVolumeMonitor.

 

Returns

a GList of connected GDrive objects.

[element-type GDrive][transfer full]


g_volume_monitor_get_volumes ()

GList *
g_volume_monitor_get_volumes (GVolumeMonitor *volume_monitor);

Gets a list of the volumes on the system.

The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref().

Parameters

volume_monitor

a GVolumeMonitor.

 

Returns

a GList of GVolume objects.

[element-type GVolume][transfer full]


g_volume_monitor_get_mounts ()

GList *
g_volume_monitor_get_mounts (GVolumeMonitor *volume_monitor);

Gets a list of the mounts on the system.

The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref().

Parameters

volume_monitor

a GVolumeMonitor.

 

Returns

a GList of GMount objects.

[element-type GMount][transfer full]


g_volume_monitor_adopt_orphan_mount ()

GVolume *
g_volume_monitor_adopt_orphan_mount (GMount *mount);

g_volume_monitor_adopt_orphan_mount has been deprecated since version 2.20 and should not be used in newly-written code.

Instead of using this function, GVolumeMonitor implementations should instead create shadow mounts with the URI of the mount they intend to adopt. See the proxy volume monitor in gvfs for an example of this. Also see g_mount_is_shadowed(), g_mount_shadow() and g_mount_unshadow() functions.

This function should be called by any GVolumeMonitor implementation when a new GMount object is created that is not associated with a GVolume object. It must be called just before emitting the mount_added signal.

If the return value is not NULL, the caller must associate the returned GVolume object with the GMount. This involves returning it in its g_mount_get_volume() implementation. The caller must also listen for the "removed" signal on the returned object and give up its reference when handling that signal

Similary, if implementing g_volume_monitor_adopt_orphan_mount(), the implementor must take a reference to mount and return it in its g_volume_get_mount() implemented. Also, the implementor must listen for the "unmounted" signal on mount and give up its reference upon handling that signal.

There are two main use cases for this function.

One is when implementing a user space file system driver that reads blocks of a block device that is already represented by the native volume monitor (for example a CD Audio file system driver). Such a driver will generate its own GMount object that needs to be associated with the GVolume object that represents the volume.

The other is for implementing a GVolumeMonitor whose sole purpose is to return GVolume objects representing entries in the users "favorite servers" list or similar.

Parameters

mount

a GMount object to find a parent for

 

Returns

the GVolume object that is the parent for mount or NULL if no wants to adopt the GMount.

[transfer full]


g_volume_monitor_get_mount_for_uuid ()

GMount *
g_volume_monitor_get_mount_for_uuid (GVolumeMonitor *volume_monitor,
                                     const char *uuid);

Finds a GMount object by its UUID (see g_mount_get_uuid())

Parameters

volume_monitor

a GVolumeMonitor.

 

uuid

the UUID to look for

 

Returns

a GMount or NULL if no such mount is available. Free the returned object with g_object_unref().

[transfer full]


g_volume_monitor_get_volume_for_uuid ()

GVolume *
g_volume_monitor_get_volume_for_uuid (GVolumeMonitor *volume_monitor,
                                      const char *uuid);

Finds a GVolume object by its UUID (see g_volume_get_uuid())

Parameters

volume_monitor

a GVolumeMonitor.

 

uuid

the UUID to look for

 

Returns

a GVolume or NULL if no such volume is available. Free the returned object with g_object_unref().

[transfer full]

Types and Values

GVolumeMonitor

typedef struct _GVolumeMonitor GVolumeMonitor;

A Volume Monitor that watches for volume events.


G_VOLUME_MONITOR_EXTENSION_POINT_NAME

#define G_VOLUME_MONITOR_EXTENSION_POINT_NAME "gio-volume-monitor"

Extension point for volume monitor functionality. See Extending GIO.

Signal Details

The “drive-changed” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GDrive         *drive,
               gpointer        user_data)

Emitted when a drive changes.

Parameters

volume_monitor

The volume monitor emitting the signal.

 

drive

the drive that changed

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “drive-connected” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GDrive         *drive,
               gpointer        user_data)

Emitted when a drive is connected to the system.

Parameters

volume_monitor

The volume monitor emitting the signal.

 

drive

a GDrive that was connected.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “drive-disconnected” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GDrive         *drive,
               gpointer        user_data)

Emitted when a drive is disconnected from the system.

Parameters

volume_monitor

The volume monitor emitting the signal.

 

drive

a GDrive that was disconnected.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “drive-eject-button” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GDrive         *drive,
               gpointer        user_data)

Emitted when the eject button is pressed on drive .

Parameters

volume_monitor

The volume monitor emitting the signal.

 

drive

the drive where the eject button was pressed

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 2.18


The “drive-stop-button” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GDrive         *drive,
               gpointer        user_data)

Emitted when the stop button is pressed on drive .

Parameters

volume_monitor

The volume monitor emitting the signal.

 

drive

the drive where the stop button was pressed

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 2.22


The “mount-added” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GMount         *mount,
               gpointer        user_data)

Emitted when a mount is added.

Parameters

volume_monitor

The volume monitor emitting the signal.

 

mount

a GMount that was added.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “mount-changed” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GMount         *mount,
               gpointer        user_data)

Emitted when a mount changes.

Parameters

volume_monitor

The volume monitor emitting the signal.

 

mount

a GMount that changed.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “mount-pre-unmount” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GMount         *mount,
               gpointer        user_data)

Emitted when a mount is about to be removed.

Parameters

volume_monitor

The volume monitor emitting the signal.

 

mount

a GMount that is being unmounted.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “mount-removed” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GMount         *mount,
               gpointer        user_data)

Emitted when a mount is removed.

Parameters

volume_monitor

The volume monitor emitting the signal.

 

mount

a GMount that was removed.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “volume-added” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GVolume        *volume,
               gpointer        user_data)

Emitted when a mountable volume is added to the system.

Parameters

volume_monitor

The volume monitor emitting the signal.

 

volume

a GVolume that was added.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “volume-changed” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GVolume        *volume,
               gpointer        user_data)

Emitted when mountable volume is changed.

Parameters

volume_monitor

The volume monitor emitting the signal.

 

volume

a GVolume that changed.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “volume-removed” signal

void
user_function (GVolumeMonitor *volume_monitor,
               GVolume        *volume,
               gpointer        user_data)

Emitted when a mountable volume is removed from the system.

Parameters

volume_monitor

The volume monitor emitting the signal.

 

volume

a GVolume that was removed.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

See Also

GFileMonitor