Add e_cal_client_connect_sync().
authorMatthew Barnes <mbarnes@redhat.com>
Tue, 4 Sep 2012 01:35:38 +0000 (21:35 -0400)
committerMatthew Barnes <mbarnes@redhat.com>
Wed, 30 Jan 2013 15:00:47 +0000 (10:00 -0500)
Replaces e_cal_client_new() and e_client_open_sync().

e_cal_client_new() is deprecated for covertly making synchronous D-Bus
calls with no way to cancel.  e_client_open_sync() is just a cumbersome
extra step now that clients are not involved in authentication.

This also adds asynchronous versions:

    e_cal_client_connect()
    e_cal_client_connect_finish()

calendar/libecal/e-cal-client.c
calendar/libecal/e-cal-client.h
docs/reference/calendar/libecal/libecal-sections.txt

index 9670229..3feaba7 100644 (file)
@@ -1503,6 +1503,224 @@ e_cal_client_init (ECalClient *client)
 }
 
 /**
+ * e_cal_client_connect_sync:
+ * @source: an #ESource
+ * @source_type: source type of the calendar
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
+ * @error: return location for a #GError, or %NULL
+ *
+ * Creates a new #ECalClient for @source and @source_type.  If an error
+ * occurs, the function will set @error and return %FALSE.
+ *
+ * Unlike with e_cal_client_new(), there is no need to call
+ * e_client_open_sync() after obtaining the #ECalClient.
+ *
+ * Returns: a new #ECalClient, or %NULL
+ *
+ * Since: 3.8
+ **/
+EClient *
+e_cal_client_connect_sync (ESource *source,
+                           ECalClientSourceType source_type,
+                           GCancellable *cancellable,
+                           GError **error)
+{
+       ECalClient *client;
+       gboolean success;
+
+       g_return_val_if_fail (E_IS_SOURCE (source), NULL);
+       g_return_val_if_fail (
+               source_type == E_CAL_CLIENT_SOURCE_TYPE_EVENTS ||
+               source_type == E_CAL_CLIENT_SOURCE_TYPE_TASKS ||
+               source_type == E_CAL_CLIENT_SOURCE_TYPE_MEMOS, NULL);
+
+       client = g_object_new (
+               E_TYPE_CAL_CLIENT,
+               "source", source,
+               "source-type", source_type, NULL);
+
+       success = g_initable_init (
+               G_INITABLE (client), cancellable, error);
+
+       if (success)
+               success = e_dbus_calendar_call_open_sync (
+                       client->priv->dbus_proxy, cancellable, error);
+
+       if (!success) {
+               g_object_unref (client);
+               return NULL;
+       }
+
+       return E_CLIENT (client);
+}
+
+/* Helper for e_cal_client_connect() */
+static void
+cal_client_connect_open_cb (GObject *source_object,
+                            GAsyncResult *result,
+                            gpointer user_data)
+{
+       GSimpleAsyncResult *simple;
+       GError *error = NULL;
+
+       simple = G_SIMPLE_ASYNC_RESULT (user_data);
+
+       e_dbus_calendar_call_open_finish (
+               E_DBUS_CALENDAR (source_object), result, &error);
+
+       if (error != NULL)
+               g_simple_async_result_take_error (simple, error);
+
+       g_simple_async_result_complete (simple);
+
+       g_object_unref (simple);
+}
+
+/* Helper for e_cal_client_connect() */
+static void
+cal_client_connect_init_cb (GObject *source_object,
+                            GAsyncResult *result,
+                            gpointer user_data)
+{
+       GSimpleAsyncResult *simple;
+       GCancellable *cancellable;
+       ECalClientPrivate *priv;
+       GError *error = NULL;
+
+       simple = G_SIMPLE_ASYNC_RESULT (user_data);
+
+       g_async_initable_init_finish (
+               G_ASYNC_INITABLE (source_object), result, &error);
+
+       if (error != NULL) {
+               g_simple_async_result_take_error (simple, error);
+               g_simple_async_result_complete (simple);
+               goto exit;
+       }
+
+       /* Note, we're repurposing some function parameters. */
+
+       result = G_ASYNC_RESULT (simple);
+       source_object = g_async_result_get_source_object (result);
+       cancellable = g_simple_async_result_get_op_res_gpointer (simple);
+
+       priv = E_CAL_CLIENT_GET_PRIVATE (source_object);
+
+       e_dbus_calendar_call_open (
+               priv->dbus_proxy, cancellable,
+               cal_client_connect_open_cb,
+               g_object_ref (simple));
+
+       g_object_unref (source_object);
+
+exit:
+       g_object_unref (simple);
+}
+
+/**
+ * e_cal_client_connect:
+ * @source: an #ESource
+ * @source_type: source tpe of the calendar
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
+ * @callback: (scope async): a #GAsyncReadyCallback to call when the request
+ *            is satisfied
+ * @user_data: (closure): data to pass to the callback function
+ *
+ * Asynchronously creates a new #ECalClient for @source and @source_type.
+ *
+ * Unlike with e_cal_client_new(), there is no need to call e_client_open()
+ * after obtaining the #ECalClient.
+ *
+ * When the operation is finished, @callback will be called.  You can then
+ * call e_cal_client_connect_finish() to get the result of the operation.
+ *
+ * Since: 3.8
+ **/
+void
+e_cal_client_connect (ESource *source,
+                      ECalClientSourceType source_type,
+                      GCancellable *cancellable,
+                      GAsyncReadyCallback callback,
+                      gpointer user_data)
+{
+       GSimpleAsyncResult *simple;
+       ECalClient *client;
+
+       g_return_if_fail (E_IS_SOURCE (source));
+       g_return_if_fail (
+               source_type == E_CAL_CLIENT_SOURCE_TYPE_EVENTS ||
+               source_type == E_CAL_CLIENT_SOURCE_TYPE_TASKS ||
+               source_type == E_CAL_CLIENT_SOURCE_TYPE_MEMOS);
+
+       /* Two things with this: 1) instantiate the client object
+        * immediately to make sure the thread-default GMainContext
+        * gets plucked, and 2) do not call the D-Bus open() method
+        * from our designated D-Bus thread -- it may take a long
+        * time and block other clients from receiving signals. */
+
+       client = g_object_new (
+               E_TYPE_CAL_CLIENT,
+               "source", source,
+               "source-type", source_type, NULL);
+
+       simple = g_simple_async_result_new (
+               G_OBJECT (client), callback,
+               user_data, e_cal_client_connect);
+
+       g_simple_async_result_set_check_cancellable (simple, cancellable);
+
+       if (G_IS_CANCELLABLE (cancellable)) {
+               /* XXX Stuff the GCancellable in the GSimpleAsyncResult
+                *     so we don't have to carry an AsyncContext struct. */
+               g_simple_async_result_set_op_res_gpointer (
+                       simple, g_object_ref (cancellable),
+                       (GDestroyNotify) g_object_unref);
+       }
+
+       g_async_initable_init_async (
+               G_ASYNC_INITABLE (client),
+               G_PRIORITY_DEFAULT, cancellable,
+               cal_client_connect_init_cb,
+               g_object_ref (simple));
+
+       g_object_unref (simple);
+       g_object_unref (client);
+}
+
+/**
+ * e_cal_client_connect_finish:
+ * @result: a #GAsyncResult
+ * @error: return location for a #GError, or %NULL
+ *
+ * Finishes the operation started with e_cal_client_connect().  If an
+ * error occurs in connecting to the D-Bus service, the function sets
+ * @error and returns %NULL.
+ *
+ * Returns: a new #ECalClient, or %NULL
+ *
+ * Since: 3.8
+ **/
+EClient *
+e_cal_client_connect_finish (GAsyncResult *result,
+                             GError **error)
+{
+       GSimpleAsyncResult *simple;
+       gpointer source_tag;
+
+       g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result), NULL);
+
+       simple = G_SIMPLE_ASYNC_RESULT (result);
+
+       source_tag = g_simple_async_result_get_source_tag (simple);
+       g_return_val_if_fail (source_tag == e_cal_client_connect, NULL);
+
+       if (g_simple_async_result_propagate_error (simple, error))
+               return NULL;
+
+       return E_CLIENT (g_async_result_get_source_object (result));
+}
+
+/**
  * e_cal_client_new:
  * @source: An #ESource pointer
  * @source_type: source type of the calendar
@@ -1515,6 +1733,11 @@ e_cal_client_init (ECalClient *client)
  * Returns: a new but unopened #ECalClient.
  *
  * Since: 3.2
+ *
+ * Deprecated: 3.8: It covertly makes synchronous D-Bus calls, with no
+ *                  way to cancel.  Use e_cal_client_connect() instead,
+ *                  which combines e_cal_client_new() and e_client_open()
+ *                  into one step.
  **/
 ECalClient *
 e_cal_client_new (ESource *source,
@@ -1529,7 +1752,8 @@ e_cal_client_new (ESource *source,
 
        return g_initable_new (
                E_TYPE_CAL_CLIENT, NULL, error,
-               "source", source, "source-type", source_type, NULL);
+               "source", source,
+               "source-type", source_type, NULL);
 }
 
 /**
index 731c695..18ba439 100644 (file)
@@ -139,8 +139,16 @@ GError *   e_cal_client_error_create       (ECalClientError code,
                                                 const gchar *custom_msg);
 
 GType          e_cal_client_get_type           (void) G_GNUC_CONST;
-ECalClient *   e_cal_client_new                (ESource *source,
+EClient *      e_cal_client_connect_sync       (ESource *source,
                                                 ECalClientSourceType source_type,
+                                                GCancellable *cancellable,
+                                                GError **error);
+void           e_cal_client_connect            (ESource *source,
+                                                ECalClientSourceType source_type,
+                                                GCancellable *cancellable,
+                                                GAsyncReadyCallback callback,
+                                                gpointer user_data);
+EClient *      e_cal_client_connect_finish     (GAsyncResult *result,
                                                 GError **error);
 ECalClientSourceType
                e_cal_client_get_source_type    (ECalClient *client);
@@ -502,6 +510,12 @@ gboolean   e_cal_client_add_timezone_sync  (ECalClient *client,
                                                 GCancellable *cancellable,
                                                 GError **error);
 
+#ifndef E_CAL_DISABLE_DEPRECATED
+ECalClient *   e_cal_client_new                (ESource *source,
+                                                ECalClientSourceType source_type,
+                                                GError **error);
+#endif /* E_CAL_DISABLE_DEPRECATED */
+
 G_END_DECLS
 
 #endif /* E_CAL_CLIENT_H */
index ba1f1d1..887c9e5 100644 (file)
@@ -99,7 +99,9 @@ E_CAL_CLIENT_ERROR
 ECalClientError
 e_cal_client_error_to_string
 e_cal_client_error_create
-e_cal_client_new
+e_cal_client_connect_sync
+e_cal_client_connect
+e_cal_client_connect_finish
 e_cal_client_get_source_type
 e_cal_client_get_local_attachment_store
 e_cal_client_set_default_timezone
@@ -175,6 +177,8 @@ e_cal_client_get_timezone_sync
 e_cal_client_add_timezone
 e_cal_client_add_timezone_finish
 e_cal_client_add_timezone_sync
+<SUBSECTION Deprecated>
+e_cal_client_new
 <SUBSECTION Standard>
 E_CAL_CLIENT
 E_IS_CAL_CLIENT