* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
- * Public License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Author: David Zeuthen <davidz@redhat.com>
*/
* %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is set).
*
* The generic #GDBusProxy::g-properties-changed and
- * #GDBusProxy::g-signal signals are not very convenient to work
- * with. Therefore, the recommended way of working with proxies is to
- * subclass #GDBusProxy, and have more natural properties and signals
- * in your derived class. See <xref linkend="gdbus-example-gdbus-codegen"/>
- * for how this can easily be done using the
- * <command><link linkend="gdbus-codegen">gdbus-codegen</link></command>
- * tool.
+ * #GDBusProxy::g-signal signals are not very convenient to work with.
+ * Therefore, the recommended way of working with proxies is to subclass
+ * #GDBusProxy, and have more natural properties and signals in your derived
+ * class. This [example][gdbus-example-gdbus-codegen] shows how this can
+ * easily be done using the [gdbus-codegen][gdbus-codegen] tool.
*
* A #GDBusProxy instance can be used from multiple threads but note
* that all signals (e.g. #GDBusProxy::g-signal, #GDBusProxy::g-properties-changed
* and #GObject::notify) are emitted in the
- * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
+ * [thread-default main context][g-main-context-push-thread-default]
* of the thread where the instance was constructed.
*
- * <example id="gdbus-wellknown-proxy"><title>GDBusProxy for a well-known-name</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-watch-proxy.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
+ * An example using a proxy for a well-known name can be found in
+ * [gdbus-example-watch-proxy.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-watch-proxy.c)
*/
-/* lock protecting the properties GHashTable */
+/* lock protecting the mutable properties: name_owner, timeout_msec,
+ * expected_interface, and the properties hash table
+ */
G_LOCK_DEFINE_STATIC (properties_lock);
/* ---------------------------------------------------------------------------------------------------- */
GDBusConnection *connection;
gchar *name;
+ /* mutable, protected by properties_lock */
gchar *name_owner;
gchar *object_path;
gchar *interface_name;
+ /* mutable, protected by properties_lock */
gint timeout_msec;
guint name_owner_changed_subscription_id;
GCancellable *get_all_cancellable;
- /* gchar* -> GVariant* */
+ /* gchar* -> GVariant*, protected by properties_lock */
GHashTable *properties;
+ /* mutable, protected by properties_lock */
GDBusInterfaceInfo *expected_interface;
guint properties_changed_subscription_id;
gboolean initialized;
+ /* mutable, protected by properties_lock */
GDBusObject *object;
SignalSubscriptionData *signal_subscription_data;
LAST_SIGNAL,
};
-guint signals[LAST_SIGNAL] = {0};
+static guint signals[LAST_SIGNAL] = {0};
static void dbus_interface_iface_init (GDBusInterfaceIface *dbus_interface_iface);
static void initable_iface_init (GInitableIface *initable_iface);
static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
G_DEFINE_TYPE_WITH_CODE (GDBusProxy, g_dbus_proxy, G_TYPE_OBJECT,
+ G_ADD_PRIVATE (GDBusProxy)
G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_INTERFACE, dbus_interface_iface_init)
G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
- G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
- );
+ G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init))
static void
g_dbus_proxy_dispose (GObject *object)
* GDBusProxy:g-interface-info:
*
* Ensure that interactions with this proxy conform to the given
- * interface. For example, when completing a method call, if the
- * type signature of the message isn't what's expected, the given
- * #GError is set. Signals that have a type signature mismatch are
- * simply dropped.
+ * interface. This is mainly to ensure that malformed data received
+ * from the other peer is ignored. The given #GDBusInterfaceInfo is
+ * said to be the "expected interface".
+ *
+ * The checks performed are:
+ * - When completing a method call, if the type signature of
+ * the reply message isn't what's expected, the reply is
+ * discarded and the #GError is set to %G_IO_ERROR_INVALID_ARGUMENT.
+ *
+ * - Received signals that have a type signature mismatch are dropped and
+ * a warning is logged via g_warning().
+ *
+ * - Properties received via the initial `GetAll()` call or via the
+ * `::PropertiesChanged` signal (on the
+ * [org.freedesktop.DBus.Properties](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties)
+ * interface) or set using g_dbus_proxy_set_cached_property()
+ * with a type signature mismatch are ignored and a warning is
+ * logged via g_warning().
+ *
+ * Note that these checks are never done on methods, signals and
+ * properties that are not referenced in the given
+ * #GDBusInterfaceInfo, since extending a D-Bus interface on the
+ * service-side is not considered an ABI break.
*
* Since: 2.26
*/
/**
* GDBusProxy:g-name-owner:
*
- * The unique name that owns #GDBusProxy:name or %NULL if no-one
+ * The unique name that owns #GDBusProxy:g-name or %NULL if no-one
* currently owns that name. You may connect to #GObject::notify signal to
* track changes to this property.
*
* that both @changed_properties and @invalidated_properties are
* guaranteed to never be %NULL (either may be empty though).
*
+ * If the proxy has the flag
+ * %G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES set, then
+ * @invalidated_properties will always be empty.
+ *
* This signal corresponds to the
- * <literal>PropertiesChanged</literal> D-Bus signal on the
- * <literal>org.freedesktop.DBus.Properties</literal> interface.
+ * `PropertiesChanged` D-Bus signal on the
+ * `org.freedesktop.DBus.Properties` interface.
*
* Since: 2.26
*/
/**
* GDBusProxy::g-signal:
* @proxy: The #GDBusProxy emitting the signal.
- * @sender_name: The sender of the signal or %NULL if the connection is not a bus connection.
+ * @sender_name: (allow-none): The sender of the signal or %NULL if the connection is not a bus connection.
* @signal_name: The name of the signal.
* @parameters: A #GVariant tuple with parameters for the signal.
*
G_TYPE_STRING,
G_TYPE_VARIANT);
-
- g_type_class_add_private (klass, sizeof (GDBusProxyPrivate));
}
static void
g_dbus_proxy_init (GDBusProxy *proxy)
{
- proxy->priv = G_TYPE_INSTANCE_GET_PRIVATE (proxy, G_TYPE_DBUS_PROXY, GDBusProxyPrivate);
+ proxy->priv = g_dbus_proxy_get_instance_private (proxy);
proxy->priv->signal_subscription_data = g_slice_new0 (SignalSubscriptionData);
proxy->priv->signal_subscription_data->ref_count = 1;
proxy->priv->signal_subscription_data->proxy = proxy;
return names;
}
+/* properties_lock must be held for as long as you will keep the
+ * returned value
+ */
static const GDBusPropertyInfo *
-lookup_property_info_or_warn (GDBusProxy *proxy,
- const gchar *property_name)
+lookup_property_info (GDBusProxy *proxy,
+ const gchar *property_name)
{
- const GDBusPropertyInfo *info;
+ const GDBusPropertyInfo *info = NULL;
if (proxy->priv->expected_interface == NULL)
- return NULL;
+ goto out;
info = g_dbus_interface_info_lookup_property (proxy->priv->expected_interface, property_name);
- if (info == NULL)
- {
- g_warning ("Trying to lookup property %s which isn't in expected interface %s",
- property_name,
- proxy->priv->expected_interface->name);
- }
+ out:
return info;
}
* blocking IO.
*
* If @proxy has an expected interface (see
- * #GDBusProxy:g-interface-info), then @property_name (for existence)
- * is checked against it.
+ * #GDBusProxy:g-interface-info) and @property_name is referenced by
+ * it, then @value is checked against the type of the property.
*
* Returns: A reference to the #GVariant instance that holds the value
* for @property_name or %NULL if the value is not in the cache. The
g_dbus_proxy_get_cached_property (GDBusProxy *proxy,
const gchar *property_name)
{
+ const GDBusPropertyInfo *info;
GVariant *value;
g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
value = g_hash_table_lookup (proxy->priv->properties, property_name);
if (value == NULL)
+ goto out;
+
+ info = lookup_property_info (proxy, property_name);
+ if (info != NULL)
{
- lookup_property_info_or_warn (proxy, property_name);
- /* no difference */
- goto out;
+ const gchar *type_string = g_variant_get_type_string (value);
+ if (g_strcmp0 (type_string, info->signature) != 0)
+ {
+ g_warning ("Trying to get property %s with type %s but according to the expected "
+ "interface the type is %s",
+ property_name,
+ type_string,
+ info->signature);
+ value = NULL;
+ goto out;
+ }
}
g_variant_ref (value);
* property cache.
*
* If @proxy has an expected interface (see
- * #GDBusProxy:g-interface-info), then @property_name (for existence)
- * and @value (for the type) is checked against it.
+ * #GDBusProxy:g-interface-info) and @property_name is referenced by
+ * it, then @value is checked against the type of the property.
*
* If the @value #GVariant is floating, it is consumed. This allows
* convenient 'inline' use of g_variant_new(), e.g.
- * |[
+ * |[<!-- language="C" -->
* g_dbus_proxy_set_cached_property (proxy,
* "SomeProperty",
* g_variant_new ("(si)",
* 42));
* ]|
*
- * Normally you will not need to use this method since @proxy is
- * tracking changes using the
- * <literal>org.freedesktop.DBus.Properties.PropertiesChanged</literal>
- * D-Bus signal. However, for performance reasons an object may decide
- * to not use this signal for some properties and instead use a
- * proprietary out-of-band mechanism to transmit changes.
+ * Normally you will not need to use this method since @proxy
+ * is tracking changes using the
+ * `org.freedesktop.DBus.Properties.PropertiesChanged`
+ * D-Bus signal. However, for performance reasons an object may
+ * decide to not use this signal for some properties and instead
+ * use a proprietary out-of-band mechanism to transmit changes.
*
* As a concrete example, consider an object with a property
- * <literal>ChatroomParticipants</literal> which is an array of
- * strings. Instead of transmitting the same (long) array every time
- * the property changes, it is more efficient to only transmit the
- * delta using e.g. signals <literal>ChatroomParticipantJoined(String
- * name)</literal> and <literal>ChatroomParticipantParted(String
- * name)</literal>.
+ * `ChatroomParticipants` which is an array of strings. Instead of
+ * transmitting the same (long) array every time the property changes,
+ * it is more efficient to only transmit the delta using e.g. signals
+ * `ChatroomParticipantJoined(String name)` and
+ * `ChatroomParticipantParted(String name)`.
*
* Since: 2.26
*/
if (value != NULL)
{
- info = lookup_property_info_or_warn (proxy, property_name);
+ info = lookup_property_info (proxy, property_name);
if (info != NULL)
{
if (g_strcmp0 (info->signature, g_variant_get_type_string (value)) != 0)
if (proxy == NULL)
{
G_UNLOCK (signal_subscription_lock);
- goto out;
+ return;
}
else
{
if (!proxy->priv->initialized)
goto out;
+ G_LOCK (properties_lock);
+
if (proxy->priv->name_owner != NULL && g_strcmp0 (sender_name, proxy->priv->name_owner) != 0)
- goto out;
+ {
+ G_UNLOCK (properties_lock);
+ goto out;
+ }
if (proxy->priv->expected_interface != NULL)
{
const GDBusSignalInfo *info;
- GVariantType *expected_type;
info = g_dbus_interface_info_lookup_signal (proxy->priv->expected_interface, signal_name);
- if (info == NULL)
- goto out;
- expected_type = _g_dbus_compute_complete_signature (info->args);
- if (!g_variant_type_equal (expected_type, g_variant_get_type (parameters)))
+ if (info != NULL)
{
+ GVariantType *expected_type;
+ expected_type = _g_dbus_compute_complete_signature (info->args);
+ if (!g_variant_type_equal (expected_type, g_variant_get_type (parameters)))
+ {
+ gchar *expected_type_string = g_variant_type_dup_string (expected_type);
+ g_warning ("Dropping signal %s of type %s since the type from the expected interface is %s",
+ info->name,
+ g_variant_get_type_string (parameters),
+ expected_type_string);
+ g_free (expected_type_string);
+ g_variant_type_free (expected_type);
+ G_UNLOCK (properties_lock);
+ goto out;
+ }
g_variant_type_free (expected_type);
- goto out;
}
- g_variant_type_free (expected_type);
}
+ G_UNLOCK (properties_lock);
+
g_signal_emit (proxy,
signals[SIGNAL_SIGNAL],
0,
sender_name,
signal_name,
parameters);
+
out:
if (proxy != NULL)
g_object_unref (proxy);
if (proxy->priv->expected_interface != NULL)
{
const GDBusPropertyInfo *info;
-
info = g_dbus_interface_info_lookup_property (proxy->priv->expected_interface, property_name);
- /* Ignore unknown properties */
- if (info == NULL)
- goto invalid;
-
- /* Ignore properties with the wrong type */
- if (g_strcmp0 (info->signature, g_variant_get_type_string (value)) != 0)
- goto invalid;
+ /* Only check known properties */
+ if (info != NULL)
+ {
+ /* Warn about properties with the wrong type */
+ if (g_strcmp0 (info->signature, g_variant_get_type_string (value)) != 0)
+ {
+ g_warning ("Received property %s with type %s does not match expected type "
+ "%s in the expected interface",
+ property_name,
+ g_variant_get_type_string (value),
+ info->signature);
+ goto invalid;
+ }
+ }
}
g_hash_table_insert (proxy->priv->properties,
g_free (property_name);
}
+typedef struct
+{
+ GDBusProxy *proxy;
+ gchar *prop_name;
+} InvalidatedPropGetData;
+
+static void
+invalidated_property_get_cb (GDBusConnection *connection,
+ GAsyncResult *res,
+ gpointer user_data)
+{
+ InvalidatedPropGetData *data = user_data;
+ const gchar *invalidated_properties[] = {NULL};
+ GVariantBuilder builder;
+ GVariant *value = NULL;
+ GVariant *unpacked_value = NULL;
+
+ /* errors are fine, the other end could have disconnected */
+ value = g_dbus_connection_call_finish (connection, res, NULL);
+ if (value == NULL)
+ {
+ goto out;
+ }
+
+ if (!g_variant_is_of_type (value, G_VARIANT_TYPE ("(v)")))
+ {
+ g_warning ("Expected type '(v)' for Get() reply, got '%s'", g_variant_get_type_string (value));
+ goto out;
+ }
+
+ g_variant_get (value, "(v)", &unpacked_value);
+
+ /* synthesize the a{sv} in the PropertiesChanged signal */
+ g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));
+ g_variant_builder_add (&builder, "{sv}", data->prop_name, unpacked_value);
+
+ G_LOCK (properties_lock);
+ insert_property_checked (data->proxy,
+ data->prop_name, /* adopts string */
+ unpacked_value); /* adopts value */
+ data->prop_name = NULL;
+ G_UNLOCK (properties_lock);
+
+ g_signal_emit (data->proxy,
+ signals[PROPERTIES_CHANGED_SIGNAL], 0,
+ g_variant_builder_end (&builder), /* consumed */
+ invalidated_properties);
+
+
+ out:
+ if (value != NULL)
+ g_variant_unref (value);
+ g_object_unref (data->proxy);
+ g_free (data->prop_name);
+ g_slice_free (InvalidatedPropGetData, data);
+}
+
static void
on_properties_changed (GDBusConnection *connection,
const gchar *sender_name,
gpointer user_data)
{
SignalSubscriptionData *data = user_data;
+ gboolean emit_g_signal = FALSE;
GDBusProxy *proxy;
const gchar *interface_name_for_signal;
GVariant *changed_properties;
if (!proxy->priv->initialized)
goto out;
+ G_LOCK (properties_lock);
+
if (proxy->priv->name_owner != NULL && g_strcmp0 (sender_name, proxy->priv->name_owner) != 0)
- goto out;
+ {
+ G_UNLOCK (properties_lock);
+ goto out;
+ }
if (!g_variant_is_of_type (parameters, G_VARIANT_TYPE ("(sa{sv}as)")))
{
- g_warning ("Value for PropertiesChanged signal with type `%s' does not match `(sa{sv}as)'",
+ g_warning ("Value for PropertiesChanged signal with type '%s' does not match '(sa{sv}as)'",
g_variant_get_type_string (parameters));
+ G_UNLOCK (properties_lock);
goto out;
}
&invalidated_properties);
if (g_strcmp0 (interface_name_for_signal, proxy->priv->interface_name) != 0)
- goto out;
-
- G_LOCK (properties_lock);
+ {
+ G_UNLOCK (properties_lock);
+ goto out;
+ }
g_variant_iter_init (&iter, changed_properties);
while (g_variant_iter_next (&iter, "{sv}", &key, &value))
insert_property_checked (proxy,
key, /* adopts string */
value); /* adopts value */
+ emit_g_signal = TRUE;
}
- for (n = 0; invalidated_properties[n] != NULL; n++)
+ if (proxy->priv->flags & G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES)
+ {
+ if (proxy->priv->name_owner != NULL)
+ {
+ for (n = 0; invalidated_properties[n] != NULL; n++)
+ {
+ InvalidatedPropGetData *data;
+ data = g_slice_new0 (InvalidatedPropGetData);
+ data->proxy = g_object_ref (proxy);
+ data->prop_name = g_strdup (invalidated_properties[n]);
+ g_dbus_connection_call (proxy->priv->connection,
+ proxy->priv->name_owner,
+ proxy->priv->object_path,
+ "org.freedesktop.DBus.Properties",
+ "Get",
+ g_variant_new ("(ss)", proxy->priv->interface_name, data->prop_name),
+ G_VARIANT_TYPE ("(v)"),
+ G_DBUS_CALL_FLAGS_NONE,
+ -1, /* timeout */
+ NULL, /* GCancellable */
+ (GAsyncReadyCallback) invalidated_property_get_cb,
+ data);
+ }
+ }
+ }
+ else
{
- g_hash_table_remove (proxy->priv->properties, invalidated_properties[n]);
+ emit_g_signal = TRUE;
+ for (n = 0; invalidated_properties[n] != NULL; n++)
+ {
+ g_hash_table_remove (proxy->priv->properties, invalidated_properties[n]);
+ }
}
G_UNLOCK (properties_lock);
- /* emit signal */
- g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
- 0,
- changed_properties,
- invalidated_properties);
+ if (emit_g_signal)
+ {
+ g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
+ 0,
+ changed_properties,
+ invalidated_properties);
+ }
out:
if (changed_properties != NULL)
if (!g_variant_is_of_type (result, G_VARIANT_TYPE ("(a{sv})")))
{
- g_warning ("Value for GetAll reply with type `%s' does not match `(a{sv})'",
+ g_warning ("Value for GetAll reply with type '%s' does not match '(a{sv})'",
g_variant_get_type_string (result));
goto out;
}
/* and finally we can notify */
if (!cancelled)
{
+ G_LOCK (properties_lock);
g_free (data->proxy->priv->name_owner);
data->proxy->priv->name_owner = data->name_owner;
data->name_owner = NULL; /* to avoid an extra copy, we steal the string */
-
- G_LOCK (properties_lock);
g_hash_table_remove_all (data->proxy->priv->properties);
G_UNLOCK (properties_lock);
if (result != NULL)
if (strlen (new_owner) == 0)
{
+ G_LOCK (properties_lock);
g_free (proxy->priv->name_owner);
proxy->priv->name_owner = NULL;
- G_LOCK (properties_lock);
-
/* Synthesize ::g-properties-changed changed */
if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES) &&
g_hash_table_size (proxy->priv->properties) > 0)
}
else
{
+ G_LOCK (properties_lock);
+
/* ignore duplicates - this can happen when activating the service */
if (g_strcmp0 (new_owner, proxy->priv->name_owner) == 0)
- goto out;
+ {
+ G_UNLOCK (properties_lock);
+ goto out;
+ }
if (proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES)
{
g_free (proxy->priv->name_owner);
proxy->priv->name_owner = g_strdup (new_owner);
- G_LOCK (properties_lock);
+
g_hash_table_remove_all (proxy->priv->properties);
G_UNLOCK (properties_lock);
g_object_notify (G_OBJECT (proxy), "g-name-owner");
{
LoadPropertiesOnNameOwnerChangedData *data;
+ G_UNLOCK (properties_lock);
+
/* start loading properties.. only then emit notify::g-name-owner .. we
* need to be able to cancel this in the event another NameOwnerChanged
* signal suddenly happens
async_init_data_free (data);
}
-
static void
-async_init_get_name_owner_cb (GDBusConnection *connection,
- GAsyncResult *res,
- gpointer user_data)
+async_init_data_set_name_owner (AsyncInitData *data,
+ const gchar *name_owner)
{
- AsyncInitData *data = user_data;
gboolean get_all;
- if (res != NULL)
- {
- GError *error;
- GVariant *result;
- error = NULL;
- result = g_dbus_connection_call_finish (connection,
- res,
- &error);
- if (result == NULL)
- {
- if (error->domain == G_DBUS_ERROR &&
- error->code == G_DBUS_ERROR_NAME_HAS_NO_OWNER)
- {
- g_error_free (error);
- }
- else
- {
- g_simple_async_result_take_error (data->simple, error);
- g_simple_async_result_complete_in_idle (data->simple);
- async_init_data_free (data);
- goto out;
- }
- }
- else
- {
- g_variant_get (result,
- "(s)",
- &data->proxy->priv->name_owner);
- g_variant_unref (result);
- }
+ if (name_owner != NULL)
+ {
+ /* it starts as NULL anyway */
+ G_LOCK (properties_lock);
+ data->proxy->priv->name_owner = g_strdup (name_owner);
+ G_UNLOCK (properties_lock);
}
get_all = TRUE;
/* Don't load properties if the API user doesn't want them */
get_all = FALSE;
}
- else if (data->proxy->priv->name_owner == NULL &&
- data->proxy->priv->name != NULL)
+ else if (name_owner == NULL && data->proxy->priv->name != NULL)
{
/* Don't attempt to load properties if the name_owner is NULL (which
* usually means the name isn't owned), unless name is also NULL (which
{
/* load all properties asynchronously */
g_dbus_connection_call (data->proxy->priv->connection,
- data->proxy->priv->name_owner,
+ name_owner,
data->proxy->priv->object_path,
"org.freedesktop.DBus.Properties",
"GetAll",
g_simple_async_result_complete_in_idle (data->simple);
async_init_data_free (data);
}
+}
- out:
- ;
+static void
+async_init_get_name_owner_cb (GDBusConnection *connection,
+ GAsyncResult *res,
+ gpointer user_data)
+{
+ AsyncInitData *data = user_data;
+ GError *error;
+ GVariant *result;
+
+ error = NULL;
+ result = g_dbus_connection_call_finish (connection,
+ res,
+ &error);
+ if (result == NULL)
+ {
+ if (error->domain == G_DBUS_ERROR &&
+ error->code == G_DBUS_ERROR_NAME_HAS_NO_OWNER)
+ {
+ g_error_free (error);
+ async_init_data_set_name_owner (data, NULL);
+ }
+ else
+ {
+ g_simple_async_result_take_error (data->simple, error);
+ g_simple_async_result_complete_in_idle (data->simple);
+ async_init_data_free (data);
+ }
+ }
+ else
+ {
+ /* borrowed from result to avoid an extra copy */
+ const gchar *name_owner;
+
+ g_variant_get (result, "(&s)", &name_owner);
+ async_init_data_set_name_owner (data, name_owner);
+ g_variant_unref (result);
+ }
}
static void
* org.freedesktop.DBus.Error.ServiceUnknown: The name org.gnome.Epiphany2
* was not provided by any .service files
*
+ * or (see #677718)
+ *
+ * org.freedesktop.systemd1.Masked: Unit polkit.service is masked.
+ *
* This doesn't mean that the name doesn't have an owner, just
- * that it's not provided by a .service file. So just proceed to
- * invoke GetNameOwner() if dealing with that error.
+ * that it's not provided by a .service file or can't currently
+ * be started.
+ *
+ * In particular, in both cases, it could be that a service
+ * owner will actually appear later. So instead of erroring out,
+ * we just proceed to invoke GetNameOwner() if dealing with the
+ * kind of errors above.
*/
- if (error->domain == G_DBUS_ERROR &&
- error->code == G_DBUS_ERROR_SERVICE_UNKNOWN)
+ if (error->domain == G_DBUS_ERROR && error->code == G_DBUS_ERROR_SERVICE_UNKNOWN)
{
g_error_free (error);
}
else
{
- g_prefix_error (&error,
- _("Error calling StartServiceByName for %s: "),
- data->proxy->priv->name);
- goto failed;
+ gchar *remote_error = g_dbus_error_get_remote_error (error);
+ if (g_strcmp0 (remote_error, "org.freedesktop.systemd1.Masked") == 0)
+ {
+ g_error_free (error);
+ g_free (remote_error);
+ }
+ else
+ {
+ g_prefix_error (&error,
+ _("Error calling StartServiceByName for %s: "),
+ data->proxy->priv->name);
+ g_free (remote_error);
+ goto failed;
+ }
}
}
else
callback,
user_data,
NULL);
+ g_simple_async_result_set_check_cancellable (data->simple, cancellable);
/* Check name ownership asynchronously - possibly also start the service */
if (proxy->priv->name == NULL)
{
/* Do nothing */
- async_init_get_name_owner_cb (proxy->priv->connection, NULL, data);
+ async_init_data_set_name_owner (data, NULL);
}
else if (g_dbus_is_unique_name (proxy->priv->name))
{
- proxy->priv->name_owner = g_strdup (proxy->priv->name);
- async_init_get_name_owner_cb (proxy->priv->connection, NULL, data);
+ async_init_data_set_name_owner (data, proxy->priv->name);
}
else
{
- if (proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START)
+ if ((proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START) ||
+ (proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION))
{
async_init_call_get_name_owner (data);
}
data->callback,
data->user_data,
NULL);
+ g_simple_async_result_set_check_cancellable (simple, data->cancellable);
g_simple_async_result_take_error (simple, error);
g_simple_async_result_complete_in_idle (simple);
g_object_unref (simple);
* @name: (allow-none): A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.
* @object_path: An object path.
* @interface_name: A D-Bus interface name.
- * @cancellable: A #GCancellable or %NULL.
+ * @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: Callback function to invoke when the proxy is ready.
* @user_data: User data to pass to @callback.
*
* to handle signals from the remote object.
*
* If @name is a well-known name and the
- * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag isn't set and no name
- * owner currently exists, the message bus will be requested to launch
- * a name owner for the name.
+ * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START and %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION
+ * flags aren't set and no name owner currently exists, the message bus
+ * will be requested to launch a name owner for the name.
*
* This is a failable asynchronous constructor - when the proxy is
* ready, @callback will be invoked and you can use
*
* See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
*
- * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
+ * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* Since: 2.26
*/
* to handle signals from the remote object.
*
* If @name is a well-known name and the
- * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag isn't set and no name
- * owner currently exists, the message bus will be requested to launch
- * a name owner for the name.
+ * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START and %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION
+ * flags aren't set and no name owner currently exists, the message bus
+ * will be requested to launch a name owner for the name.
*
* This is a synchronous failable constructor. See g_dbus_proxy_new()
* and g_dbus_proxy_new_finish() for the asynchronous version.
*
- * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
+ * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
*
* @name: A bus name (well-known or unique).
* @object_path: An object path.
* @interface_name: A D-Bus interface name.
- * @cancellable: A #GCancellable or %NULL.
+ * @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: Callback function to invoke when the proxy is ready.
* @user_data: User data to pass to @callback.
*
* Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection.
*
- * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
+ * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* Since: 2.26
*/
* @name: A bus name (well-known or unique).
* @object_path: An object path.
* @interface_name: A D-Bus interface name.
- * @cancellable: A #GCancellable or %NULL.
+ * @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.
*
- * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
+ * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
*
gchar *
g_dbus_proxy_get_name_owner (GDBusProxy *proxy)
{
+ gchar *ret;
+
g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
- return g_strdup (proxy->priv->name_owner);
+
+ G_LOCK (properties_lock);
+ ret = g_strdup (proxy->priv->name_owner);
+ G_UNLOCK (properties_lock);
+ return ret;
}
/**
gint
g_dbus_proxy_get_default_timeout (GDBusProxy *proxy)
{
+ gint ret;
+
g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), -1);
- return proxy->priv->timeout_msec;
+
+ G_LOCK (properties_lock);
+ ret = proxy->priv->timeout_msec;
+ G_UNLOCK (properties_lock);
+ return ret;
}
/**
g_return_if_fail (G_IS_DBUS_PROXY (proxy));
g_return_if_fail (timeout_msec == -1 || timeout_msec >= 0);
- /* TODO: locking? */
+ G_LOCK (properties_lock);
+
if (proxy->priv->timeout_msec != timeout_msec)
{
proxy->priv->timeout_msec = timeout_msec;
+ G_UNLOCK (properties_lock);
+
g_object_notify (G_OBJECT (proxy), "g-default-timeout");
}
+ else
+ {
+ G_UNLOCK (properties_lock);
+ }
}
/**
* g_dbus_proxy_get_interface_info:
* @proxy: A #GDBusProxy
*
- * Returns the #GDBusInterfaceInfo, if any, specifying the minimal
- * interface that @proxy conforms to.
- *
- * See the #GDBusProxy:g-interface-info property for more details.
+ * Returns the #GDBusInterfaceInfo, if any, specifying the interface
+ * that @proxy conforms to. See the #GDBusProxy:g-interface-info
+ * property for more details.
*
* Returns: A #GDBusInterfaceInfo or %NULL. Do not unref the returned
* object, it is owned by @proxy.
GDBusInterfaceInfo *
g_dbus_proxy_get_interface_info (GDBusProxy *proxy)
{
+ GDBusInterfaceInfo *ret;
+
g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
- return proxy->priv->expected_interface;
+
+ G_LOCK (properties_lock);
+ ret = proxy->priv->expected_interface;
+ G_UNLOCK (properties_lock);
+ /* FIXME: returning a borrowed ref with no guarantee that nobody will
+ * call g_dbus_proxy_set_interface_info() and make it invalid...
+ */
+ return ret;
}
/**
* @info: (allow-none): Minimum interface this proxy conforms to or %NULL to unset.
*
* Ensure that interactions with @proxy conform to the given
- * interface. For example, when completing a method call, if the type
- * signature of the message isn't what's expected, the given #GError
- * is set. Signals that have a type signature mismatch are simply
- * dropped.
- *
- * See the #GDBusProxy:g-interface-info property for more details.
+ * interface. See the #GDBusProxy:g-interface-info property for more
+ * details.
*
* Since: 2.26
*/
GDBusInterfaceInfo *info)
{
g_return_if_fail (G_IS_DBUS_PROXY (proxy));
+ G_LOCK (properties_lock);
+
if (proxy->priv->expected_interface != NULL)
{
g_dbus_interface_info_cache_release (proxy->priv->expected_interface);
proxy->priv->expected_interface = info != NULL ? g_dbus_interface_info_ref (info) : NULL;
if (proxy->priv->expected_interface != NULL)
g_dbus_interface_info_cache_build (proxy->priv->expected_interface);
+
+ G_UNLOCK (properties_lock);
}
/* ---------------------------------------------------------------------------------------------------- */
g_object_unref (simple);
}
+/* properties_lock must be held for as long as you will keep the
+ * returned value
+ */
static const GDBusMethodInfo *
-lookup_method_info_or_warn (GDBusProxy *proxy,
- const gchar *method_name)
+lookup_method_info (GDBusProxy *proxy,
+ const gchar *method_name)
{
- const GDBusMethodInfo *info;
+ const GDBusMethodInfo *info = NULL;
if (proxy->priv->expected_interface == NULL)
- return NULL;
+ goto out;
info = g_dbus_interface_info_lookup_method (proxy->priv->expected_interface, method_name);
- if (info == NULL)
- {
- g_warning ("Trying to invoke method %s which isn't in expected interface %s",
- method_name, proxy->priv->expected_interface->name);
- }
+out:
return info;
}
+/* properties_lock must be held for as long as you will keep the
+ * returned value
+ */
static const gchar *
get_destination_for_call (GDBusProxy *proxy)
{
const gchar *split_method_name;
const gchar *target_method_name;
const gchar *target_interface_name;
- const gchar *destination;
+ gchar *destination;
GVariantType *reply_type;
+ GAsyncReadyCallback my_callback;
g_return_if_fail (G_IS_DBUS_PROXY (proxy));
g_return_if_fail (g_dbus_is_member_name (method_name) || g_dbus_is_interface_name (method_name));
reply_type = NULL;
split_interface_name = NULL;
- simple = g_simple_async_result_new (G_OBJECT (proxy),
- callback,
- user_data,
- g_dbus_proxy_call_internal);
+ /* g_dbus_connection_call() is optimised for the case of a NULL
+ * callback. If we get a NULL callback from our user then make sure
+ * we pass along a NULL callback for ourselves as well.
+ */
+ if (callback != NULL)
+ {
+ my_callback = (GAsyncReadyCallback) reply_cb;
+ simple = g_simple_async_result_new (G_OBJECT (proxy),
+ callback,
+ user_data,
+ g_dbus_proxy_call_internal);
+ g_simple_async_result_set_check_cancellable (simple, cancellable);
+ }
+ else
+ {
+ my_callback = NULL;
+ simple = NULL;
+ }
+
+ G_LOCK (properties_lock);
was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
target_method_name = was_split ? split_method_name : method_name;
if (!was_split)
{
const GDBusMethodInfo *expected_method_info;
- expected_method_info = lookup_method_info_or_warn (proxy, target_method_name);
+ expected_method_info = lookup_method_info (proxy, target_method_name);
if (expected_method_info != NULL)
reply_type = _g_dbus_compute_complete_signature (expected_method_info->out_args);
}
destination = NULL;
if (proxy->priv->name != NULL)
{
- destination = get_destination_for_call (proxy);
+ destination = g_strdup (get_destination_for_call (proxy));
if (destination == NULL)
{
- g_simple_async_result_set_error (simple,
- G_IO_ERROR,
- G_IO_ERROR_FAILED,
- _("Cannot invoke method; proxy is for a well-known name without an owner and proxy was constructed with the G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag"));
+ if (simple != NULL)
+ {
+ g_simple_async_result_set_error (simple,
+ G_IO_ERROR,
+ G_IO_ERROR_FAILED,
+ _("Cannot invoke method; proxy is for a well-known name without an owner and proxy was constructed with the G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag"));
+ g_simple_async_result_complete_in_idle (simple);
+ g_object_unref (simple);
+ }
+ G_UNLOCK (properties_lock);
goto out;
}
}
+ G_UNLOCK (properties_lock);
+
#ifdef G_OS_UNIX
g_dbus_connection_call_with_unix_fd_list (proxy->priv->connection,
destination,
timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
fd_list,
cancellable,
- (GAsyncReadyCallback) reply_cb,
+ my_callback,
simple);
#else
g_dbus_connection_call (proxy->priv->connection,
flags,
timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
cancellable,
- (GAsyncReadyCallback) reply_cb,
+ my_callback,
simple);
#endif
if (reply_type != NULL)
g_variant_type_free (reply_type);
+ g_free (destination);
g_free (split_interface_name);
}
const gchar *split_method_name;
const gchar *target_method_name;
const gchar *target_interface_name;
- const gchar *destination;
+ gchar *destination;
GVariantType *reply_type;
g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
reply_type = NULL;
+ G_LOCK (properties_lock);
+
was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
target_method_name = was_split ? split_method_name : method_name;
target_interface_name = was_split ? split_interface_name : proxy->priv->interface_name;
if (!was_split)
{
const GDBusMethodInfo *expected_method_info;
- expected_method_info = lookup_method_info_or_warn (proxy, target_method_name);
+ expected_method_info = lookup_method_info (proxy, target_method_name);
if (expected_method_info != NULL)
reply_type = _g_dbus_compute_complete_signature (expected_method_info->out_args);
}
destination = NULL;
if (proxy->priv->name != NULL)
{
- destination = get_destination_for_call (proxy);
+ destination = g_strdup (get_destination_for_call (proxy));
if (destination == NULL)
{
g_set_error_literal (error,
G_IO_ERROR_FAILED,
_("Cannot invoke method; proxy is for a well-known name without an owner and proxy was constructed with the G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag"));
ret = NULL;
+ G_UNLOCK (properties_lock);
goto out;
}
}
+ G_UNLOCK (properties_lock);
+
#ifdef G_OS_UNIX
ret = g_dbus_connection_call_with_unix_fd_list_sync (proxy->priv->connection,
destination,
if (reply_type != NULL)
g_variant_type_free (reply_type);
+ g_free (destination);
g_free (split_interface_name);
return ret;
* @flags: Flags from the #GDBusCallFlags enumeration.
* @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning
* "infinite") or -1 to use the proxy default timeout.
- * @cancellable: A #GCancellable or %NULL.
- * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
+ * @cancellable: (allow-none): A #GCancellable or %NULL.
+ * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
* care about the result of the method invocation.
* @user_data: The data to pass to @callback.
*
*
* If the @parameters #GVariant is floating, it is consumed. This allows
* convenient 'inline' use of g_variant_new(), e.g.:
- * |[
+ * |[<!-- language="C" -->
* g_dbus_proxy_call (proxy,
* "TwoStrings",
* g_variant_new ("(ss)",
* -1,
* NULL,
* (GAsyncReadyCallback) two_strings_done,
- * &data);
+ * &data);
* ]|
*
+ * If @proxy has an expected interface (see
+ * #GDBusProxy:g-interface-info) and @method_name is referenced by it,
+ * then the return value is checked against the return type.
+ *
* This is an asynchronous method. When the operation is finished,
* @callback will be invoked in the
- * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
+ * [thread-default main context][g-main-context-push-thread-default]
* of the thread you are calling this method from.
* You can then call g_dbus_proxy_call_finish() to get the result of
* the operation. See g_dbus_proxy_call_sync() for the synchronous
* version of this method.
*
+ * If @callback is %NULL then the D-Bus method call message will be sent with
+ * the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.
+ *
* Since: 2.26
*/
void
GAsyncReadyCallback callback,
gpointer user_data)
{
- return g_dbus_proxy_call_internal (proxy, method_name, parameters, flags, timeout_msec, NULL, cancellable, callback, user_data);
+ g_dbus_proxy_call_internal (proxy, method_name, parameters, flags, timeout_msec, NULL, cancellable, callback, user_data);
}
/**
* @flags: Flags from the #GDBusCallFlags enumeration.
* @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning
* "infinite") or -1 to use the proxy default timeout.
- * @cancellable: A #GCancellable or %NULL.
+ * @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously invokes the @method_name method on @proxy.
*
* If the @parameters #GVariant is floating, it is consumed. This allows
* convenient 'inline' use of g_variant_new(), e.g.:
- * |[
+ * |[<!-- language="C" -->
* g_dbus_proxy_call_sync (proxy,
* "TwoStrings",
* g_variant_new ("(ss)",
* G_DBUS_CALL_FLAGS_NONE,
* -1,
* NULL,
- * &error);
+ * &error);
* ]|
*
* The calling thread is blocked until a reply is received. See
* g_dbus_proxy_call() for the asynchronous version of this
* method.
*
+ * If @proxy has an expected interface (see
+ * #GDBusProxy:g-interface-info) and @method_name is referenced by it,
+ * then the return value is checked against the return type.
+ *
* Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
* return values. Free with g_variant_unref().
*
* @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning
* "infinite") or -1 to use the proxy default timeout.
* @fd_list: (allow-none): A #GUnixFDList or %NULL.
- * @cancellable: A #GCancellable or %NULL.
- * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
+ * @cancellable: (allow-none): A #GCancellable or %NULL.
+ * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
* care about the result of the method invocation.
* @user_data: The data to pass to @callback.
*
GAsyncReadyCallback callback,
gpointer user_data)
{
- return g_dbus_proxy_call_internal (proxy, method_name, parameters, flags, timeout_msec, fd_list, cancellable, callback, user_data);
+ g_dbus_proxy_call_internal (proxy, method_name, parameters, flags, timeout_msec, fd_list, cancellable, callback, user_data);
}
/**
* g_dbus_proxy_call_with_unix_fd_list_finish:
* @proxy: A #GDBusProxy.
- * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.
+ * @out_fd_list: (out) (allow-none): Return location for a #GUnixFDList or %NULL.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call_with_unix_fd_list().
* @error: Return location for error or %NULL.
*
* @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning
* "infinite") or -1 to use the proxy default timeout.
* @fd_list: (allow-none): A #GUnixFDList or %NULL.
- * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.
- * @cancellable: A #GCancellable or %NULL.
+ * @out_fd_list: (out) (allow-none): Return location for a #GUnixFDList or %NULL.
+ * @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Like g_dbus_proxy_call_sync() but also takes and returns #GUnixFDList objects.
return proxy->priv->object;
}
+static GDBusObject *
+_g_dbus_proxy_dup_object (GDBusInterface *interface)
+{
+ GDBusProxy *proxy = G_DBUS_PROXY (interface);
+ GDBusObject *ret = NULL;
+
+ G_LOCK (properties_lock);
+ if (proxy->priv->object != NULL)
+ ret = g_object_ref (proxy->priv->object);
+ G_UNLOCK (properties_lock);
+ return ret;
+}
+
static void
_g_dbus_proxy_set_object (GDBusInterface *interface,
GDBusObject *object)
{
GDBusProxy *proxy = G_DBUS_PROXY (interface);
+ G_LOCK (properties_lock);
if (proxy->priv->object != NULL)
g_object_remove_weak_pointer (G_OBJECT (proxy->priv->object), (gpointer *) &proxy->priv->object);
proxy->priv->object = object;
if (proxy->priv->object != NULL)
g_object_add_weak_pointer (G_OBJECT (proxy->priv->object), (gpointer *) &proxy->priv->object);
+ G_UNLOCK (properties_lock);
}
static void
{
dbus_interface_iface->get_info = _g_dbus_proxy_get_info;
dbus_interface_iface->get_object = _g_dbus_proxy_get_object;
+ dbus_interface_iface->dup_object = _g_dbus_proxy_dup_object;
dbus_interface_iface->set_object = _g_dbus_proxy_set_object;
}
projects / platform / upstream / glib.git / blobdiff