GDrive

GDrive — Virtual File System drive management

Synopsis


#include <gio/gio.h>

                    GDrive;
                    GDriveIface;
char*               g_drive_get_name                    (GDrive *drive);
GIcon*              g_drive_get_icon                    (GDrive *drive);
gboolean            g_drive_has_volumes                 (GDrive *drive);
GList*              g_drive_get_volumes                 (GDrive *drive);
gboolean            g_drive_can_eject                   (GDrive *drive);
gboolean            g_drive_can_poll_for_media          (GDrive *drive);
void                g_drive_poll_for_media              (GDrive *drive,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            g_drive_poll_for_media_finish       (GDrive *drive,
                                                         GAsyncResult *result,
                                                         GError **error);
gboolean            g_drive_has_media                   (GDrive *drive);
gboolean            g_drive_is_media_check_automatic    (GDrive *drive);
gboolean            g_drive_is_media_removable          (GDrive *drive);
void                g_drive_eject                       (GDrive *drive,
                                                         GMountUnmountFlags flags,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            g_drive_eject_finish                (GDrive *drive,
                                                         GAsyncResult *result,
                                                         GError **error);
char**              g_drive_enumerate_identifiers       (GDrive *drive);
char*               g_drive_get_identifier              (GDrive *drive,
                                                         const char *kind);

Object Hierarchy

  GInterface
   +----GDrive

Prerequisites

GDrive requires GObject.

Signals

  "changed"                                        : Run Last
  "disconnected"                                   : Run Last
  "eject-button"                                   : Run Last

Description

GDrive - this represent a piece of hardware connected to the machine. Its generally only created for removable hardware or hardware with removable media.

GDrive is a container class for GVolume objects that stem from the same piece of media. As such, GDrive abstracts a drive with (or without) removable media and provides operations for querying whether media is available, determing whether media change is automatically detected and ejecting the media.

If the GDrive reports that media isn't automatically detected, one can poll for media; typically one should not do this periodically as a poll for media operation is potententially expensive and may spin up the drive creating noise.

For porting from GnomeVFS note that there is no equivalent of GDrive in that API.

Details

GDrive

typedef struct _GDrive GDrive;

Opaque drive object.

GDriveIface

typedef struct {
  GTypeInterface g_iface;

  /* signals */
  void (*changed)                      (GDrive              *drive);
  void (*disconnected)                 (GDrive              *drive);
  void (*eject_button)                 (GDrive              *drive);
  
  /* Virtual Table */
  char *   (*get_name)                 (GDrive              *drive);
  GIcon *  (*get_icon)                 (GDrive              *drive);
  gboolean (*has_volumes)              (GDrive              *drive);
  GList *  (*get_volumes)              (GDrive              *drive);
  gboolean (*is_media_removable)       (GDrive              *drive);
  gboolean (*has_media)                (GDrive              *drive);
  gboolean (*is_media_check_automatic) (GDrive              *drive);
  gboolean (*can_eject)                (GDrive              *drive);
  gboolean (*can_poll_for_media)       (GDrive              *drive);
  void     (*eject)                    (GDrive              *drive,
					GMountUnmountFlags   flags,
                                        GCancellable        *cancellable,
                                        GAsyncReadyCallback  callback,
                                        gpointer             user_data);
  gboolean (*eject_finish)             (GDrive              *drive,
                                        GAsyncResult        *result,
                                        GError             **error);
  void     (*poll_for_media)           (GDrive              *drive,
                                        GCancellable        *cancellable,
                                        GAsyncReadyCallback  callback,
                                        gpointer             user_data);
  gboolean (*poll_for_media_finish)    (GDrive              *drive,
                                        GAsyncResult        *result,
                                        GError             **error);

  char *   (*get_identifier)           (GDrive              *drive,
					const char          *kind);
  char **  (*enumerate_identifiers)    (GDrive              *drive);
} GDriveIface;

Interface for creating GDrive implementations.

GTypeInterface g_iface; The parent interface.
changed () Signal emitted when the drive is changed.
disconnected () The removed signal that is emitted when the GDrive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized.
eject_button () Signal emitted when the physical eject button (if any) of a drive have been pressed.
get_name () Returns the name for the given GDrive.
get_icon () Returns a GIcon for the given GDrive.
has_volumes () Returns TRUE if the GDrive has mountable volumes.
get_volumes () Returns a list GList of GVolume for the GDrive.
is_media_removable () Returns TRUE if the GDrive supports removal and insertion of media.
has_media () Returns TRUE if the GDrive has media inserted.
is_media_check_automatic () Returns TRUE if the GDrive is capabable of automatically detecting media changes.
can_eject () Returns TRUE if the GDrive can eject media.
can_poll_for_media () Returns TRUE if the GDrive is capable of manually polling for media change.
eject () Ejects a GDrive.
eject_finish () Finishes an eject operation.
poll_for_media () Poll for media insertion/removal on a GDrive.
poll_for_media_finish () Finishes a media poll operation.
get_identifier () Returns the identifier of the given kind, or NULL if the GDrive doesn't have one.
enumerate_identifiers () Returns an array strings listing the kinds of identifiers which the GDrive has.

g_drive_get_name ()

char*               g_drive_get_name                    (GDrive *drive);

Gets the name of drive.

drive : a GDrive.
Returns : a string containing drive's name. The returned string should be freed when no longer needed.

g_drive_get_icon ()

GIcon*              g_drive_get_icon                    (GDrive *drive);

Gets the icon for drive.

drive : a GDrive.
Returns : GIcon for the drive.

g_drive_has_volumes ()

gboolean            g_drive_has_volumes                 (GDrive *drive);

Check if drive has any mountable volumes.

drive : a GDrive.
Returns : TRUE if the drive contains volumes, FALSE otherwise.

g_drive_get_volumes ()

GList*              g_drive_get_volumes                 (GDrive *drive);

Get a list of mountable volumes for drive.

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

drive : a GDrive.
Returns : GList containing any GVolumes on the given drive.

g_drive_can_eject ()

gboolean            g_drive_can_eject                   (GDrive *drive);

Checks if a drive can be ejected.

drive : pointer to a GDrive.
Returns : TRUE if the drive can be ejected. FALSE otherwise.

g_drive_can_poll_for_media ()

gboolean            g_drive_can_poll_for_media          (GDrive *drive);

Checks if a drive can be polled for media changes.

drive : a GDrive.
Returns : TRUE if the drive can be polled for media changes. FALSE otherwise.

g_drive_poll_for_media ()

void                g_drive_poll_for_media              (GDrive *drive,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Polls drive to see if media has been inserted or removed.

drive : a GDrive.
cancellable : optional GCancellable object, NULL to ignore.
callback : a GAsyncReadyCallback, or NULL.
user_data : a gpointer.

g_drive_poll_for_media_finish ()

gboolean            g_drive_poll_for_media_finish       (GDrive *drive,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes poll_for_mediaing a drive.

drive : a GDrive.
result : a GAsyncResult.
error : a GError.
Returns : TRUE if the drive has been poll_for_mediaed successfully, FALSE otherwise.

g_drive_has_media ()

gboolean            g_drive_has_media                   (GDrive *drive);

Checks if the drive has media. Note that the OS may not be polling the drive for media changes; see g_drive_is_media_check_automatic() for more details.

drive : a GDrive.
Returns : TRUE if drive has media, FALSE otherwise.

g_drive_is_media_check_automatic ()

gboolean            g_drive_is_media_check_automatic    (GDrive *drive);

Checks if drive is capabable of automatically detecting media changes.

drive : a GDrive.
Returns : TRUE if the drive is capabable of automatically detecting media changes, FALSE otherwise.

g_drive_is_media_removable ()

gboolean            g_drive_is_media_removable          (GDrive *drive);

Checks if the drive supports removable media.

drive : a GDrive.
Returns : TRUE if drive supports removable media, FALSE otherwise.

g_drive_eject ()

void                g_drive_eject                       (GDrive *drive,
                                                         GMountUnmountFlags flags,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Ejects a drive.

drive : a GDrive.
flags : flags affecting the unmount if required for eject
cancellable : optional GCancellable object, NULL to ignore.
callback : a GAsyncReadyCallback, or NULL.
user_data : a gpointer.

g_drive_eject_finish ()

gboolean            g_drive_eject_finish                (GDrive *drive,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes ejecting a drive.

drive : a GDrive.
result : a GAsyncResult.
error : a GError.
Returns : TRUE if the drive has been ejected successfully, FALSE otherwise.

g_drive_enumerate_identifiers ()

char**              g_drive_enumerate_identifiers       (GDrive *drive);

Gets the kinds of identifiers that drive has. Use g_drive_get_identifer() to obtain the identifiers themselves.

drive : a GDrive
Returns : a NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free.

g_drive_get_identifier ()

char*               g_drive_get_identifier              (GDrive *drive,
                                                         const char *kind);

Gets the identifier of the given kind for drive.

drive : a GDrive
kind : the kind of identifier to return
Returns : a newly allocated string containing the requested identfier, or NULL if the GDrive doesn't have this kind of identifier

Signal Details

The "changed" signal

void                user_function                      (GDrive  *drive,
                                                        gpointer user_data)      : Run Last

Emitted when the drive's state has changed.

drive : a GDrive.
user_data : user data set when the signal handler was connected.

The "disconnected" signal

void                user_function                      (GDrive  *drive,
                                                        gpointer user_data)      : Run Last

This signal is emitted when the GDrive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized.

drive : a GDrive.
user_data : user data set when the signal handler was connected.

The "eject-button" signal

void                user_function                      (GDrive  *drive,
                                                        gpointer user_data)      : Run Last

Emitted when the physical eject button (if any) of a drive have been pressed.

drive : a GDrive.
user_data : user data set when the signal handler was connected.