glocalfile: add private worker monitor APIs

Add a convenient and race-free method of watching local files from the
GLib worker thread.

Without this, the race-free way to create a monitor that dispatches
events to the worker thread looked something like this:

 - dispatch an idle to the worker thread
 - from the idle, create the monitor and connect signals
 - from the original thread, wait (on a cond?) until the worker thread
   has finished setting up the monitor
 - read the file that you were monitoring

which is just ridiculously complicated...

To use the new API:

  monitor = g_local_file_monitor_new_in_worker ("/path/to/some/file",
                                                G_FILE_MONITOR_NONE,
                                                &error);
  g_assert_no_error (error);

  g_signal_connect (monitor, "changed", G_CALLBACK (callback), NULL);

  g_local_file_monitor_start (monitor);

'callback' will run from the GLib worker thread.

This is the reason that the start() call was introduced in the previous
commit.  The backends that don't use the start() call will have a very
thin race between creating the monitor and connecting the signal, but
hopefully they will be fixed soon.

These new APIs will be used (at least) from gdesktopappinfo to watch for
changes in the desktop file directories.

https://bugzilla.gnome.org/show_bug.cgi?id=704887
This commit is contained in:
Ryan Lortie 2013-07-25 14:05:36 -04:00
parent 5409d7827e
commit 33762a4173
5 changed files with 48 additions and 8 deletions

View File

@ -200,9 +200,11 @@ mounts_changed (GUnixMountMonitor *mount_monitor,
GFileMonitor* GFileMonitor*
_g_local_directory_monitor_new (const char *dirname, _g_local_directory_monitor_new (const char *dirname,
GFileMonitorFlags flags, GFileMonitorFlags flags,
GMainContext *context,
gboolean is_remote_fs, gboolean is_remote_fs,
GError **error) gboolean do_start,
GError **error)
{ {
GFileMonitor *monitor = NULL; GFileMonitor *monitor = NULL;
GType type = G_TYPE_INVALID; GType type = G_TYPE_INVALID;
@ -218,12 +220,12 @@ _g_local_directory_monitor_new (const char *dirname,
G_STRUCT_OFFSET (GLocalDirectoryMonitorClass, is_supported)); G_STRUCT_OFFSET (GLocalDirectoryMonitorClass, is_supported));
if (type != G_TYPE_INVALID) if (type != G_TYPE_INVALID)
monitor = G_FILE_MONITOR (g_object_new (type, "dirname", dirname, "flags", flags, NULL)); monitor = G_FILE_MONITOR (g_object_new (type, "dirname", dirname, "flags", flags, "context", context, NULL));
else else
g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED, g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
_("Unable to find default local directory monitor type")); _("Unable to find default local directory monitor type"));
if (monitor) if (monitor && do_start)
g_local_directory_monitor_start (G_LOCAL_DIRECTORY_MONITOR (monitor)); g_local_directory_monitor_start (G_LOCAL_DIRECTORY_MONITOR (monitor));
return monitor; return monitor;

View File

@ -70,10 +70,17 @@ GType g_local_directory_monitor_get_type (void) G_GNUC_CONST;
GFileMonitor * _g_local_directory_monitor_new (const char *dirname, GFileMonitor * _g_local_directory_monitor_new (const char *dirname,
GFileMonitorFlags flags, GFileMonitorFlags flags,
GMainContext *context,
gboolean is_remote_fs, gboolean is_remote_fs,
gboolean do_start,
GError **error); GError **error);
void g_local_directory_monitor_start (GLocalDirectoryMonitor *local_monitor); void g_local_directory_monitor_start (GLocalDirectoryMonitor *local_monitor);
/* Actually in glocalfile.c */
GLocalDirectoryMonitor * g_local_directory_monitor_new_in_worker (const char *pathname,
GFileMonitorFlags flags,
GError **error);
G_END_DECLS G_END_DECLS
#endif /* __G_LOCAL_DIRECTORY_MONITOR_H__ */ #endif /* __G_LOCAL_DIRECTORY_MONITOR_H__ */

View File

@ -72,6 +72,8 @@
#endif #endif
#include "glib-private.h" #include "glib-private.h"
#include "glib-private.h"
#ifdef G_OS_WIN32 #ifdef G_OS_WIN32
#include <windows.h> #include <windows.h>
#include <io.h> #include <io.h>
@ -2505,7 +2507,7 @@ g_local_file_monitor_dir (GFile *file,
GError **error) GError **error)
{ {
GLocalFile* local_file = G_LOCAL_FILE(file); GLocalFile* local_file = G_LOCAL_FILE(file);
return _g_local_directory_monitor_new (local_file->filename, flags, is_remote (local_file->filename), error); return _g_local_directory_monitor_new (local_file->filename, flags, NULL, is_remote (local_file->filename), TRUE, error);
} }
static GFileMonitor* static GFileMonitor*
@ -2515,7 +2517,27 @@ g_local_file_monitor_file (GFile *file,
GError **error) GError **error)
{ {
GLocalFile* local_file = G_LOCAL_FILE(file); GLocalFile* local_file = G_LOCAL_FILE(file);
return _g_local_file_monitor_new (local_file->filename, flags, is_remote (local_file->filename), error); return _g_local_file_monitor_new (local_file->filename, flags, NULL, is_remote (local_file->filename), TRUE, error);
}
GLocalDirectoryMonitor *
g_local_directory_monitor_new_in_worker (const char *pathname,
GFileMonitorFlags flags,
GError **error)
{
return (gpointer) _g_local_directory_monitor_new (pathname, flags,
GLIB_PRIVATE_CALL (g_get_worker_context) (),
is_remote (pathname), FALSE, error);
}
GLocalFileMonitor *
g_local_file_monitor_new_in_worker (const char *pathname,
GFileMonitorFlags flags,
GError **error)
{
return (gpointer) _g_local_file_monitor_new (pathname, flags,
GLIB_PRIVATE_CALL (g_get_worker_context) (),
is_remote (pathname), FALSE, error);
} }

View File

@ -122,7 +122,9 @@ static void g_local_file_monitor_class_init (GLocalFileMonitorClass *klass)
GFileMonitor* GFileMonitor*
_g_local_file_monitor_new (const char *pathname, _g_local_file_monitor_new (const char *pathname,
GFileMonitorFlags flags, GFileMonitorFlags flags,
GMainContext *context,
gboolean is_remote_fs, gboolean is_remote_fs,
gboolean do_start,
GError **error) GError **error)
{ {
GFileMonitor *monitor = NULL; GFileMonitor *monitor = NULL;
@ -139,12 +141,12 @@ _g_local_file_monitor_new (const char *pathname,
G_STRUCT_OFFSET (GLocalFileMonitorClass, is_supported)); G_STRUCT_OFFSET (GLocalFileMonitorClass, is_supported));
if (type != G_TYPE_INVALID) if (type != G_TYPE_INVALID)
monitor = G_FILE_MONITOR (g_object_new (type, "filename", pathname, "flags", flags, NULL)); monitor = G_FILE_MONITOR (g_object_new (type, "filename", pathname, "flags", flags, "context", context, NULL));
else else
g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED, g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
_("Unable to find default local file monitor type")); _("Unable to find default local file monitor type"));
if (monitor) if (monitor && do_start)
g_local_file_monitor_start (G_LOCAL_FILE_MONITOR (monitor)); g_local_file_monitor_start (G_LOCAL_FILE_MONITOR (monitor));
return monitor; return monitor;

View File

@ -63,10 +63,17 @@ GType g_local_file_monitor_get_type (void) G_GNUC_CONST;
GFileMonitor * _g_local_file_monitor_new (const char *pathname, GFileMonitor * _g_local_file_monitor_new (const char *pathname,
GFileMonitorFlags flags, GFileMonitorFlags flags,
GMainContext *context,
gboolean is_remote_fs, gboolean is_remote_fs,
gboolean do_start,
GError **error); GError **error);
void g_local_file_monitor_start (GLocalFileMonitor *local_monitor); void g_local_file_monitor_start (GLocalFileMonitor *local_monitor);
/* Actually in glocalfile.c */
GLocalFileMonitor * g_local_file_monitor_new_in_worker (const char *pathname,
GFileMonitorFlags flags,
GError **error);
G_END_DECLS G_END_DECLS
#endif /* __G_LOCAL_FILE_MONITOR_H__ */ #endif /* __G_LOCAL_FILE_MONITOR_H__ */