Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gio.Objects.DBusProxy

Contents

Exported types
Methods
Properties
Signals
- gPropertiesChanged
- gSignal

Description

GDBusProxy is a base class used for proxies to access a D-Bus interface on a remote object. A GDBusProxy can be constructed for both well-known and unique names.

By default, GDBusProxy will cache all properties (and listen to changes) of the remote object, and proxy all signals that get emitted. This behaviour can be changed by passing suitable [flagsgio.DBusProxyFlags] when the proxy is created. If the proxy is for a well-known name, the property cache is flushed when the name owner vanishes and reloaded when a name owner appears.

The unique name owner of the proxy’s name is tracked and can be read from DBusProxy:gNameOwner. Connect to the Object::notify signal to get notified of changes. Additionally, only signals and property changes emitted from the current name owner are considered and calls are always sent to the current name owner. This avoids a number of race conditions when the name is lost by one owner and claimed by another. However, if no name owner currently exists, then calls will be sent to the well-known name which may result in the message bus launching an owner (unless G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is set).

If the proxy is for a stateless D-Bus service, where the name owner may be started and stopped between calls, the DBusProxy:gNameOwner tracking of GDBusProxy will cause the proxy to drop signal and property changes from the service after it has restarted for the first time. When interacting with a stateless D-Bus service, do not use GDBusProxy — use direct D-Bus method calls and signal connections.

The generic DBusProxy::gPropertiesChanged and DBusProxy::gSignal 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 shows how this can easily be done using the `gdbus-codegen` tool.

A GDBusProxy instance can be used from multiple threads but note that all signals (e.g. DBusProxy::gSignal, DBusProxy::gPropertiesChanged and Object::notify) are emitted in the thread-default main context (see mainContextPushThreadDefault) of the thread where the instance was constructed.

A watch proxy example

An example using a proxy for a well-known name can be found in `gdbus-example-watch-proxy.c`.

Since: 2.26

Synopsis

newtype DBusProxy = DBusProxy (ManagedPtr DBusProxy)
class (GObject o, IsDescendantOf DBusProxy o) => IsDBusProxy o
toDBusProxy :: (MonadIO m, IsDBusProxy o) => o -> m DBusProxy
type family ResolveDBusProxyMethod (t :: Symbol) o where ...
data DBusProxyCallMethodInfo
dBusProxyCall :: (HasCallStack, MonadIO m, IsDBusProxy a, IsCancellable b) => a -> Text -> Maybe GVariant -> [DBusCallFlags] -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
data DBusProxyCallFinishMethodInfo
dBusProxyCallFinish :: (HasCallStack, MonadIO m, IsDBusProxy a, IsAsyncResult b) => a -> b -> m GVariant
data DBusProxyCallSyncMethodInfo
dBusProxyCallSync :: (HasCallStack, MonadIO m, IsDBusProxy a, IsCancellable b) => a -> Text -> Maybe GVariant -> [DBusCallFlags] -> Int32 -> Maybe b -> m GVariant
data DBusProxyCallWithUnixFdListMethodInfo
dBusProxyCallWithUnixFdList :: (HasCallStack, MonadIO m, IsDBusProxy a, IsUnixFDList b, IsCancellable c) => a -> Text -> Maybe GVariant -> [DBusCallFlags] -> Int32 -> Maybe b -> Maybe c -> Maybe AsyncReadyCallback -> m ()
data DBusProxyCallWithUnixFdListFinishMethodInfo
dBusProxyCallWithUnixFdListFinish :: (HasCallStack, MonadIO m, IsDBusProxy a, IsAsyncResult b) => a -> b -> m (GVariant, Maybe UnixFDList)
data DBusProxyCallWithUnixFdListSyncMethodInfo
dBusProxyCallWithUnixFdListSync :: (HasCallStack, MonadIO m, IsDBusProxy a, IsUnixFDList b, IsCancellable c) => a -> Text -> Maybe GVariant -> [DBusCallFlags] -> Int32 -> Maybe b -> Maybe c -> m (GVariant, Maybe UnixFDList)
data DBusProxyGetCachedPropertyMethodInfo
dBusProxyGetCachedProperty :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> Text -> m (Maybe GVariant)
data DBusProxyGetCachedPropertyNamesMethodInfo
dBusProxyGetCachedPropertyNames :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> m (Maybe [Text])
data DBusProxyGetConnectionMethodInfo
dBusProxyGetConnection :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> m DBusConnection
data DBusProxyGetDefaultTimeoutMethodInfo
dBusProxyGetDefaultTimeout :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> m Int32
data DBusProxyGetFlagsMethodInfo
dBusProxyGetFlags :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> m [DBusProxyFlags]
data DBusProxyGetInterfaceInfoMethodInfo
dBusProxyGetInterfaceInfo :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> m (Maybe DBusInterfaceInfo)
data DBusProxyGetInterfaceNameMethodInfo
dBusProxyGetInterfaceName :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> m Text
data DBusProxyGetNameMethodInfo
dBusProxyGetName :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> m (Maybe Text)
data DBusProxyGetNameOwnerMethodInfo
dBusProxyGetNameOwner :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> m (Maybe Text)
data DBusProxyGetObjectPathMethodInfo
dBusProxyGetObjectPath :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> m Text
dBusProxyNew :: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b) => a -> [DBusProxyFlags] -> Maybe DBusInterfaceInfo -> Maybe Text -> Text -> Text -> Maybe b -> Maybe AsyncReadyCallback -> m ()
dBusProxyNewFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m DBusProxy
dBusProxyNewForBus :: (HasCallStack, MonadIO m, IsCancellable a) => BusType -> [DBusProxyFlags] -> Maybe DBusInterfaceInfo -> Text -> Text -> Text -> Maybe a -> Maybe AsyncReadyCallback -> m ()
dBusProxyNewForBusFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m DBusProxy
dBusProxyNewForBusSync :: (HasCallStack, MonadIO m, IsCancellable a) => BusType -> [DBusProxyFlags] -> Maybe DBusInterfaceInfo -> Text -> Text -> Text -> Maybe a -> m DBusProxy
dBusProxyNewSync :: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b) => a -> [DBusProxyFlags] -> Maybe DBusInterfaceInfo -> Maybe Text -> Text -> Text -> Maybe b -> m DBusProxy
data DBusProxySetCachedPropertyMethodInfo
dBusProxySetCachedProperty :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> Text -> Maybe GVariant -> m ()
data DBusProxySetDefaultTimeoutMethodInfo
dBusProxySetDefaultTimeout :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> Int32 -> m ()
data DBusProxySetInterfaceInfoMethodInfo
dBusProxySetInterfaceInfo :: (HasCallStack, MonadIO m, IsDBusProxy a) => a -> Maybe DBusInterfaceInfo -> m ()
data DBusProxyGBusTypePropertyInfo
constructDBusProxyGBusType :: (IsDBusProxy o, MonadIO m) => BusType -> m (GValueConstruct o)
dBusProxyGBusType :: AttrLabelProxy "gBusType"
data DBusProxyGConnectionPropertyInfo
constructDBusProxyGConnection :: (IsDBusProxy o, MonadIO m, IsDBusConnection a) => a -> m (GValueConstruct o)
dBusProxyGConnection :: AttrLabelProxy "gConnection"
getDBusProxyGConnection :: (MonadIO m, IsDBusProxy o) => o -> m (Maybe DBusConnection)
data DBusProxyGDefaultTimeoutPropertyInfo
constructDBusProxyGDefaultTimeout :: (IsDBusProxy o, MonadIO m) => Int32 -> m (GValueConstruct o)
dBusProxyGDefaultTimeout :: AttrLabelProxy "gDefaultTimeout"
getDBusProxyGDefaultTimeout :: (MonadIO m, IsDBusProxy o) => o -> m Int32
setDBusProxyGDefaultTimeout :: (MonadIO m, IsDBusProxy o) => o -> Int32 -> m ()
data DBusProxyGFlagsPropertyInfo
constructDBusProxyGFlags :: (IsDBusProxy o, MonadIO m) => [DBusProxyFlags] -> m (GValueConstruct o)
dBusProxyGFlags :: AttrLabelProxy "gFlags"
getDBusProxyGFlags :: (MonadIO m, IsDBusProxy o) => o -> m [DBusProxyFlags]
data DBusProxyGInterfaceInfoPropertyInfo
clearDBusProxyGInterfaceInfo :: (MonadIO m, IsDBusProxy o) => o -> m ()
constructDBusProxyGInterfaceInfo :: (IsDBusProxy o, MonadIO m) => DBusInterfaceInfo -> m (GValueConstruct o)
dBusProxyGInterfaceInfo :: AttrLabelProxy "gInterfaceInfo"
getDBusProxyGInterfaceInfo :: (MonadIO m, IsDBusProxy o) => o -> m (Maybe DBusInterfaceInfo)
setDBusProxyGInterfaceInfo :: (MonadIO m, IsDBusProxy o) => o -> DBusInterfaceInfo -> m ()
data DBusProxyGInterfaceNamePropertyInfo
constructDBusProxyGInterfaceName :: (IsDBusProxy o, MonadIO m) => Text -> m (GValueConstruct o)
dBusProxyGInterfaceName :: AttrLabelProxy "gInterfaceName"
getDBusProxyGInterfaceName :: (MonadIO m, IsDBusProxy o) => o -> m (Maybe Text)
data DBusProxyGNamePropertyInfo
constructDBusProxyGName :: (IsDBusProxy o, MonadIO m) => Text -> m (GValueConstruct o)
dBusProxyGName :: AttrLabelProxy "gName"
getDBusProxyGName :: (MonadIO m, IsDBusProxy o) => o -> m (Maybe Text)
data DBusProxyGNameOwnerPropertyInfo
dBusProxyGNameOwner :: AttrLabelProxy "gNameOwner"
getDBusProxyGNameOwner :: (MonadIO m, IsDBusProxy o) => o -> m (Maybe Text)
data DBusProxyGObjectPathPropertyInfo
constructDBusProxyGObjectPath :: (IsDBusProxy o, MonadIO m) => Text -> m (GValueConstruct o)
dBusProxyGObjectPath :: AttrLabelProxy "gObjectPath"
getDBusProxyGObjectPath :: (MonadIO m, IsDBusProxy o) => o -> m (Maybe Text)
type DBusProxyGPropertiesChangedCallback = GVariant -> [Text] -> IO ()
data DBusProxyGPropertiesChangedSignalInfo
afterDBusProxyGPropertiesChanged :: (IsDBusProxy a, MonadIO m) => a -> ((?self :: a) => DBusProxyGPropertiesChangedCallback) -> m SignalHandlerId
onDBusProxyGPropertiesChanged :: (IsDBusProxy a, MonadIO m) => a -> ((?self :: a) => DBusProxyGPropertiesChangedCallback) -> m SignalHandlerId
type DBusProxyGSignalCallback = Maybe Text -> Text -> GVariant -> IO ()
data DBusProxyGSignalSignalInfo
afterDBusProxyGSignal :: (IsDBusProxy a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => DBusProxyGSignalCallback) -> m SignalHandlerId
onDBusProxyGSignal :: (IsDBusProxy a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => DBusProxyGSignalCallback) -> m SignalHandlerId

Exported types

newtype DBusProxy Source #

Memory-managed wrapper type.

Constructors

DBusProxy (ManagedPtr DBusProxy)

Instances

Instances details

Eq DBusProxy Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods (==) :: DBusProxy -> DBusProxy -> Bool # (/=) :: DBusProxy -> DBusProxy -> Bool #
GObject DBusProxy Source #
Instance details Defined in GI.Gio.Objects.DBusProxy
ManagedPtrNewtype DBusProxy Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods toManagedPtr :: DBusProxy -> ManagedPtr DBusProxy #
TypedObject DBusProxy Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods glibType :: IO GType #
HasParentTypes DBusProxy Source #
Instance details Defined in GI.Gio.Objects.DBusProxy
HasAttributeList DBusProxy Source #
Instance details Defined in GI.Gio.Objects.DBusProxy
(info ~ ResolveDBusProxyMethod t DBusProxy, OverloadedMethod info DBusProxy p, HasField t DBusProxy p) => HasField (t :: Symbol) DBusProxy (p :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods getField :: DBusProxy -> p #
(info ~ ResolveDBusProxyMethod t DBusProxy, OverloadedMethodInfo info DBusProxy) => IsLabel t (MethodProxy info DBusProxy) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods fromLabel :: MethodProxy info DBusProxy #
(info ~ ResolveDBusProxyMethod t DBusProxy, OverloadedMethod info DBusProxy p) => IsLabel t (DBusProxy -> p) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods fromLabel :: DBusProxy -> p #
IsGValue (Maybe DBusProxy) Source #	Convert `DBusProxy` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gio.Objects.DBusProxy Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe DBusProxy -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe DBusProxy) #
type AttributeList DBusProxy Source #
Instance details Defined in GI.Gio.Objects.DBusProxy type AttributeList DBusProxy
type ParentTypes DBusProxy Source #
Instance details Defined in GI.Gio.Objects.DBusProxy type ParentTypes DBusProxy = '[Object, AsyncInitable, DBusInterface, Initable]
type SignalList DBusProxy Source #
Instance details Defined in GI.Gio.Objects.DBusProxy type SignalList DBusProxy

class (GObject o, IsDescendantOf DBusProxy o) => IsDBusProxy o Source #

Type class for types which can be safely cast to DBusProxy, for instance with toDBusProxy.

Instances

Instances details

(GObject o, IsDescendantOf DBusProxy o) => IsDBusProxy o Source #
Instance details Defined in GI.Gio.Objects.DBusProxy

toDBusProxy :: (MonadIO m, IsDBusProxy o) => o -> m DBusProxy Source #

Cast to DBusProxy, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Expand

Equations

ResolveDBusProxyMethod "bindProperty" o = ObjectBindPropertyMethodInfo
ResolveDBusProxyMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo
ResolveDBusProxyMethod "call" o = DBusProxyCallMethodInfo
ResolveDBusProxyMethod "callFinish" o = DBusProxyCallFinishMethodInfo
ResolveDBusProxyMethod "callSync" o = DBusProxyCallSyncMethodInfo
ResolveDBusProxyMethod "callWithUnixFdList" o = DBusProxyCallWithUnixFdListMethodInfo
ResolveDBusProxyMethod "callWithUnixFdListFinish" o = DBusProxyCallWithUnixFdListFinishMethodInfo
ResolveDBusProxyMethod "callWithUnixFdListSync" o = DBusProxyCallWithUnixFdListSyncMethodInfo
ResolveDBusProxyMethod "forceFloating" o = ObjectForceFloatingMethodInfo
ResolveDBusProxyMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo
ResolveDBusProxyMethod "getv" o = ObjectGetvMethodInfo
ResolveDBusProxyMethod "init" o = InitableInitMethodInfo
ResolveDBusProxyMethod "initAsync" o = AsyncInitableInitAsyncMethodInfo
ResolveDBusProxyMethod "initFinish" o = AsyncInitableInitFinishMethodInfo
ResolveDBusProxyMethod "isFloating" o = ObjectIsFloatingMethodInfo
ResolveDBusProxyMethod "notify" o = ObjectNotifyMethodInfo
ResolveDBusProxyMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo
ResolveDBusProxyMethod "ref" o = ObjectRefMethodInfo
ResolveDBusProxyMethod "refSink" o = ObjectRefSinkMethodInfo
ResolveDBusProxyMethod "runDispose" o = ObjectRunDisposeMethodInfo
ResolveDBusProxyMethod "stealData" o = ObjectStealDataMethodInfo
ResolveDBusProxyMethod "stealQdata" o = ObjectStealQdataMethodInfo
ResolveDBusProxyMethod "thawNotify" o = ObjectThawNotifyMethodInfo
ResolveDBusProxyMethod "unref" o = ObjectUnrefMethodInfo
ResolveDBusProxyMethod "watchClosure" o = ObjectWatchClosureMethodInfo
ResolveDBusProxyMethod "getCachedProperty" o = DBusProxyGetCachedPropertyMethodInfo
ResolveDBusProxyMethod "getCachedPropertyNames" o = DBusProxyGetCachedPropertyNamesMethodInfo
ResolveDBusProxyMethod "getConnection" o = DBusProxyGetConnectionMethodInfo
ResolveDBusProxyMethod "getData" o = ObjectGetDataMethodInfo
ResolveDBusProxyMethod "getDefaultTimeout" o = DBusProxyGetDefaultTimeoutMethodInfo
ResolveDBusProxyMethod "getFlags" o = DBusProxyGetFlagsMethodInfo
ResolveDBusProxyMethod "getInfo" o = DBusInterfaceGetInfoMethodInfo
ResolveDBusProxyMethod "getInterfaceInfo" o = DBusProxyGetInterfaceInfoMethodInfo
ResolveDBusProxyMethod "getInterfaceName" o = DBusProxyGetInterfaceNameMethodInfo
ResolveDBusProxyMethod "getName" o = DBusProxyGetNameMethodInfo
ResolveDBusProxyMethod "getNameOwner" o = DBusProxyGetNameOwnerMethodInfo
ResolveDBusProxyMethod "getObject" o = DBusInterfaceGetObjectMethodInfo
ResolveDBusProxyMethod "getObjectPath" o = DBusProxyGetObjectPathMethodInfo
ResolveDBusProxyMethod "getProperty" o = ObjectGetPropertyMethodInfo
ResolveDBusProxyMethod "getQdata" o = ObjectGetQdataMethodInfo
ResolveDBusProxyMethod "setCachedProperty" o = DBusProxySetCachedPropertyMethodInfo
ResolveDBusProxyMethod "setData" o = ObjectSetDataMethodInfo
ResolveDBusProxyMethod "setDataFull" o = ObjectSetDataFullMethodInfo
ResolveDBusProxyMethod "setDefaultTimeout" o = DBusProxySetDefaultTimeoutMethodInfo
ResolveDBusProxyMethod "setInterfaceInfo" o = DBusProxySetInterfaceInfoMethodInfo
ResolveDBusProxyMethod "setObject" o = DBusInterfaceSetObjectMethodInfo
ResolveDBusProxyMethod "setProperty" o = ObjectSetPropertyMethodInfo
ResolveDBusProxyMethod l o = MethodResolutionFailed l o :: Type

call

data DBusProxyCallMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> Maybe GVariant -> [DBusCallFlags] -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsDBusProxy a, IsCancellable b) => OverloadedMethod DBusProxyCallMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyCallMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyCall Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a, IsCancellable b)
=> a	`proxy`: A `DBusProxy`.
-> Text	`methodName`: Name of method to invoke.
-> Maybe GVariant	`parameters`: A `GVariant` tuple with parameters for the signal or `Nothing` if not passing parameters.
-> [DBusCallFlags]	`flags`: Flags from the `DBusCallFlags` enumeration.
-> Int32	`timeoutMsec`: The timeout in milliseconds (with `G_MAXINT` meaning "infinite") or -1 to use the proxy default timeout.
-> Maybe b	`cancellable`: A `Cancellable` or `Nothing`.
-> Maybe AsyncReadyCallback	`callback`: A `AsyncReadyCallback` to call when the request is satisfied or `Nothing` if you don't care about the result of the method invocation.
-> m ()

Asynchronously invokes the methodName method on proxy.

If methodName contains any dots, then name is split into interface and method name parts. This allows using proxy for invoking methods on other interfaces.

If the DBusConnection associated with proxy is closed then the operation will fail with IOErrorEnumClosed. If cancellable is canceled, the operation will fail with IOErrorEnumCancelled. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with IOErrorEnumInvalidArgument.

If the parameters GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.:

C code

g_dbus_proxy_call (proxy,
                   "TwoStrings",
                   g_variant_new ("(ss)",
                                  "Thing One",
                                  "Thing Two"),
                   G_DBUS_CALL_FLAGS_NONE,
                   -1,
                   NULL,
                   (GAsyncReadyCallback) two_strings_done,
                   &data);

If proxy has an expected interface (see DBusProxy:gInterfaceInfo) and methodName 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 thread-default main context (see mainContextPushThreadDefault) of the thread you are calling this method from. You can then call dBusProxyCallFinish to get the result of the operation. See dBusProxyCallSync for the synchronous version of this method.

If callback is Nothing then the D-Bus method call message will be sent with the DBusMessageFlagsNoReplyExpected flag set.

Since: 2.26

callFinish

data DBusProxyCallFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m GVariant), MonadIO m, IsDBusProxy a, IsAsyncResult b) => OverloadedMethod DBusProxyCallFinishMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyCallFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyCallFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a, IsAsyncResult b)
=> a	`proxy`: A `DBusProxy`.
-> b	`res`: A `AsyncResult` obtained from the `AsyncReadyCallback` passed to `dBusProxyCall`.
-> m GVariant	Returns: `Nothing` if `error` is set. Otherwise a `GVariant` tuple with return values. Free with `variantUnref`. (Can throw `GError`)

Finishes an operation started with dBusProxyCall.

Since: 2.26

callSync

data DBusProxyCallSyncMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> Maybe GVariant -> [DBusCallFlags] -> Int32 -> Maybe b -> m GVariant), MonadIO m, IsDBusProxy a, IsCancellable b) => OverloadedMethod DBusProxyCallSyncMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyCallSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyCallSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a, IsCancellable b)
=> a	`proxy`: A `DBusProxy`.
-> Text	`methodName`: Name of method to invoke.
-> Maybe GVariant	`parameters`: A `GVariant` tuple with parameters for the signal or `Nothing` if not passing parameters.
-> [DBusCallFlags]	`flags`: Flags from the `DBusCallFlags` enumeration.
-> Int32	`timeoutMsec`: The timeout in milliseconds (with `G_MAXINT` meaning "infinite") or -1 to use the proxy default timeout.
-> Maybe b	`cancellable`: A `Cancellable` or `Nothing`.
-> m GVariant	Returns: `Nothing` if `error` is set. Otherwise a `GVariant` tuple with return values. Free with `variantUnref`. (Can throw `GError`)

Synchronously invokes the methodName method on proxy.

If methodName contains any dots, then name is split into interface and method name parts. This allows using proxy for invoking methods on other interfaces.

If the DBusConnection associated with proxy is disconnected then the operation will fail with IOErrorEnumClosed. If cancellable is canceled, the operation will fail with IOErrorEnumCancelled. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with IOErrorEnumInvalidArgument.

If the parameters GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.:

C code

g_dbus_proxy_call_sync (proxy,
                        "TwoStrings",
                        g_variant_new ("(ss)",
                                       "Thing One",
                                       "Thing Two"),
                        G_DBUS_CALL_FLAGS_NONE,
                        -1,
                        NULL,
                        &error);

The calling thread is blocked until a reply is received. See dBusProxyCall for the asynchronous version of this method.

If proxy has an expected interface (see DBusProxy:gInterfaceInfo) and methodName is referenced by it, then the return value is checked against the return type.

Since: 2.26

callWithUnixFdList

data DBusProxyCallWithUnixFdListMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> Maybe GVariant -> [DBusCallFlags] -> Int32 -> Maybe b -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsDBusProxy a, IsUnixFDList b, IsCancellable c) => OverloadedMethod DBusProxyCallWithUnixFdListMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyCallWithUnixFdListMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyCallWithUnixFdList Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a, IsUnixFDList b, IsCancellable c)
=> a	`proxy`: A `DBusProxy`.
-> Text	`methodName`: Name of method to invoke.
-> Maybe GVariant	`parameters`: A `GVariant` tuple with parameters for the signal or `Nothing` if not passing parameters.
-> [DBusCallFlags]	`flags`: Flags from the `DBusCallFlags` enumeration.
-> Int32	`timeoutMsec`: The timeout in milliseconds (with `G_MAXINT` meaning "infinite") or -1 to use the proxy default timeout.
-> Maybe b	`fdList`: A `UnixFDList` or `Nothing`.
-> Maybe c	`cancellable`: A `Cancellable` or `Nothing`.
-> Maybe AsyncReadyCallback	`callback`: A `AsyncReadyCallback` to call when the request is satisfied or `Nothing` if you don't care about the result of the method invocation.
-> m ()

Like dBusProxyCall but also takes a UnixFDList object.

This method is only available on UNIX.

Since: 2.30

callWithUnixFdListFinish

data DBusProxyCallWithUnixFdListFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m (GVariant, Maybe UnixFDList)), MonadIO m, IsDBusProxy a, IsAsyncResult b) => OverloadedMethod DBusProxyCallWithUnixFdListFinishMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyCallWithUnixFdListFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyCallWithUnixFdListFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a, IsAsyncResult b)
=> a	`proxy`: A `DBusProxy`.
-> b	`res`: A `AsyncResult` obtained from the `AsyncReadyCallback` passed to `dBusProxyCallWithUnixFdList`.
-> m (GVariant, Maybe UnixFDList)	Returns: `Nothing` if `error` is set. Otherwise a `GVariant` tuple with return values. Free with `variantUnref`. (Can throw `GError`)

Finishes an operation started with dBusProxyCallWithUnixFdList.

Since: 2.30

callWithUnixFdListSync

data DBusProxyCallWithUnixFdListSyncMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> Maybe GVariant -> [DBusCallFlags] -> Int32 -> Maybe b -> Maybe c -> m (GVariant, Maybe UnixFDList)), MonadIO m, IsDBusProxy a, IsUnixFDList b, IsCancellable c) => OverloadedMethod DBusProxyCallWithUnixFdListSyncMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyCallWithUnixFdListSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyCallWithUnixFdListSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a, IsUnixFDList b, IsCancellable c)
=> a	`proxy`: A `DBusProxy`.
-> Text	`methodName`: Name of method to invoke.
-> Maybe GVariant	`parameters`: A `GVariant` tuple with parameters for the signal or `Nothing` if not passing parameters.
-> [DBusCallFlags]	`flags`: Flags from the `DBusCallFlags` enumeration.
-> Int32	`timeoutMsec`: The timeout in milliseconds (with `G_MAXINT` meaning "infinite") or -1 to use the proxy default timeout.
-> Maybe b	`fdList`: A `UnixFDList` or `Nothing`.
-> Maybe c	`cancellable`: A `Cancellable` or `Nothing`.
-> m (GVariant, Maybe UnixFDList)	Returns: `Nothing` if `error` is set. Otherwise a `GVariant` tuple with return values. Free with `variantUnref`. (Can throw `GError`)

Like dBusProxyCallSync but also takes and returns UnixFDList objects.

This method is only available on UNIX.

Since: 2.30

getCachedProperty

data DBusProxyGetCachedPropertyMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> m (Maybe GVariant)), MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxyGetCachedPropertyMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyGetCachedPropertyMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyGetCachedProperty Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`.
-> Text	`propertyName`: Property name.
-> m (Maybe GVariant)	Returns: A reference to the `GVariant` instance that holds the value for `propertyName` or `Nothing` if the value is not in the cache. The returned reference must be freed with `variantUnref`.

Looks up the value for a property from the cache. This call does no blocking IO.

If proxy has an expected interface (see DBusProxy:gInterfaceInfo) and propertyName is referenced by it, then value is checked against the type of the property.

Since: 2.26

getCachedPropertyNames

data DBusProxyGetCachedPropertyNamesMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe [Text]), MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxyGetCachedPropertyNamesMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyGetCachedPropertyNamesMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyGetCachedPropertyNames Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`.
-> m (Maybe [Text])	Returns: A `Nothing`-terminated array of strings or `Nothing` if `proxy` has no cached properties. Free the returned array with `strfreev`.

Gets the names of all cached properties on proxy.

Since: 2.26

getConnection

data DBusProxyGetConnectionMethodInfo Source #

Instances

Instances details

(signature ~ m DBusConnection, MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxyGetConnectionMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyGetConnectionMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyGetConnection Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`.
-> m DBusConnection	Returns: A `DBusConnection` owned by `proxy`. Do not free.

Gets the connection proxy is for.

Since: 2.26

getDefaultTimeout

data DBusProxyGetDefaultTimeoutMethodInfo Source #

Instances

Instances details

(signature ~ m Int32, MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxyGetDefaultTimeoutMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyGetDefaultTimeoutMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyGetDefaultTimeout Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`.
-> m Int32	Returns: Timeout to use for `proxy`.

Gets the timeout to use if -1 (specifying default timeout) is passed as timeoutMsec in the dBusProxyCall and dBusProxyCallSync functions.

See the DBusProxy:gDefaultTimeout property for more details.

Since: 2.26

getFlags

data DBusProxyGetFlagsMethodInfo Source #

Instances

Instances details

(signature ~ m [DBusProxyFlags], MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxyGetFlagsMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyGetFlagsMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyGetFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`.
-> m [DBusProxyFlags]	Returns: Flags from the `DBusProxyFlags` enumeration.

Gets the flags that proxy was constructed with.

Since: 2.26

getInterfaceInfo

data DBusProxyGetInterfaceInfoMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe DBusInterfaceInfo), MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxyGetInterfaceInfoMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyGetInterfaceInfoMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyGetInterfaceInfo Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`
-> m (Maybe DBusInterfaceInfo)	Returns: A `DBusInterfaceInfo` or `Nothing`. Do not unref the returned object, it is owned by `proxy`.

Returns the DBusInterfaceInfo, if any, specifying the interface that proxy conforms to. See the DBusProxy:gInterfaceInfo property for more details.

Since: 2.26

getInterfaceName

data DBusProxyGetInterfaceNameMethodInfo Source #

Instances

Instances details

(signature ~ m Text, MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxyGetInterfaceNameMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyGetInterfaceNameMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyGetInterfaceName Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`.
-> m Text	Returns: A string owned by `proxy`. Do not free.

Gets the D-Bus interface name proxy is for.

Since: 2.26

getName

data DBusProxyGetNameMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxyGetNameMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyGetNameMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`.
-> m (Maybe Text)	Returns: A string owned by `proxy`. Do not free.

Gets the name that proxy was constructed for.

When connected to a message bus, this will usually be non-Nothing. However, it may be Nothing for a proxy that communicates using a peer-to-peer pattern.

Since: 2.26

getNameOwner

data DBusProxyGetNameOwnerMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxyGetNameOwnerMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyGetNameOwnerMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyGetNameOwner Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`.
-> m (Maybe Text)	Returns: The name owner or `Nothing` if no name owner exists. Free with `free`.

The unique name that owns the name that proxy is for or Nothing if no-one currently owns that name. You may connect to the Object::notify signal to track changes to the DBusProxy:gNameOwner property.

Since: 2.26

getObjectPath

data DBusProxyGetObjectPathMethodInfo Source #

Instances

Instances details

(signature ~ m Text, MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxyGetObjectPathMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxyGetObjectPathMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxyGetObjectPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`.
-> m Text	Returns: A string owned by `proxy`. Do not free.

Gets the object path proxy is for.

Since: 2.26

new

dBusProxyNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b)
=> a	`connection`: A `DBusConnection`.
-> [DBusProxyFlags]	`flags`: Flags used when constructing the proxy.
-> Maybe DBusInterfaceInfo	`info`: A `DBusInterfaceInfo` specifying the minimal interface that `proxy` conforms to or `Nothing`.
-> Maybe Text	`name`: A bus name (well-known or unique) or `Nothing` if `connection` is not a message bus connection.
-> Text	`objectPath`: An object path.
-> Text	`interfaceName`: A D-Bus interface name.
-> Maybe b	`cancellable`: A `Cancellable` or `Nothing`.
-> Maybe AsyncReadyCallback	`callback`: Callback function to invoke when the proxy is ready.
-> m ()

Creates a proxy for accessing interfaceName on the remote object at objectPath owned by name at connection and asynchronously loads D-Bus properties unless the DBusProxyFlagsDoNotLoadProperties flag is used. Connect to the DBusProxy::gPropertiesChanged signal to get notified about property changes.

If the DBusProxyFlagsDoNotConnectSignals flag is not set, also sets up match rules for signals. Connect to the DBusProxy::gSignal signal to handle signals from the remote object.

If both DBusProxyFlagsDoNotLoadProperties and DBusProxyFlagsDoNotConnectSignals are set, this constructor is guaranteed to complete immediately without blocking.

If name is a well-known name and the DBusProxyFlagsDoNotAutoStart and DBusProxyFlagsDoNotAutoStartAtConstruction 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 dBusProxyNewFinish to get the result.

See dBusProxyNewSync and for a synchronous version of this constructor.

DBusProxy is used in this [example][classgio.DBusProxya-watch-proxy-example].

Since: 2.26

newFinish

dBusProxyNewFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsAsyncResult a)
=> a	`res`: A `AsyncResult` obtained from the `AsyncReadyCallback` function passed to `dBusProxyNew`.
-> m DBusProxy	Returns: A `DBusProxy` or `Nothing` if `error` is set. Free with `objectUnref`. (Can throw `GError`)

Finishes creating a DBusProxy.

Since: 2.26

newForBus

dBusProxyNewForBus Source #

Arguments

:: (HasCallStack, MonadIO m, IsCancellable a)
=> BusType	`busType`: A `BusType`.
-> [DBusProxyFlags]	`flags`: Flags used when constructing the proxy.
-> Maybe DBusInterfaceInfo	`info`: A `DBusInterfaceInfo` specifying the minimal interface that `proxy` conforms to or `Nothing`.
-> Text	`name`: A bus name (well-known or unique).
-> Text	`objectPath`: An object path.
-> Text	`interfaceName`: A D-Bus interface name.
-> Maybe a	`cancellable`: A `Cancellable` or `Nothing`.
-> Maybe AsyncReadyCallback	`callback`: Callback function to invoke when the proxy is ready.
-> m ()

Like dBusProxyNew but takes a BusType instead of a DBusConnection.

DBusProxy is used in this [example][classgio.DBusProxya-watch-proxy-example].

Since: 2.26

newForBusFinish

dBusProxyNewForBusFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsAsyncResult a)
=> a	`res`: A `AsyncResult` obtained from the `AsyncReadyCallback` function passed to `dBusProxyNewForBus`.
-> m DBusProxy	Returns: A `DBusProxy` or `Nothing` if `error` is set. Free with `objectUnref`. (Can throw `GError`)

Finishes creating a DBusProxy.

Since: 2.26

newForBusSync

dBusProxyNewForBusSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsCancellable a)
=> BusType	`busType`: A `BusType`.
-> [DBusProxyFlags]	`flags`: Flags used when constructing the proxy.
-> Maybe DBusInterfaceInfo	`info`: A `DBusInterfaceInfo` specifying the minimal interface that `proxy` conforms to or `Nothing`.
-> Text	`name`: A bus name (well-known or unique).
-> Text	`objectPath`: An object path.
-> Text	`interfaceName`: A D-Bus interface name.
-> Maybe a	`cancellable`: A `Cancellable` or `Nothing`.
-> m DBusProxy	Returns: A `DBusProxy` or `Nothing` if error is set. Free with `objectUnref`. (Can throw `GError`)

Like dBusProxyNewSync but takes a BusType instead of a DBusConnection.

DBusProxy is used in this [example][classgio.DBusProxya-watch-proxy-example].

Since: 2.26

newSync

dBusProxyNewSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b)
=> a	`connection`: A `DBusConnection`.
-> [DBusProxyFlags]	`flags`: Flags used when constructing the proxy.
-> Maybe DBusInterfaceInfo	`info`: A `DBusInterfaceInfo` specifying the minimal interface that `proxy` conforms to or `Nothing`.
-> Maybe Text	`name`: A bus name (well-known or unique) or `Nothing` if `connection` is not a message bus connection.
-> Text	`objectPath`: An object path.
-> Text	`interfaceName`: A D-Bus interface name.
-> Maybe b	`cancellable`: A `Cancellable` or `Nothing`.
-> m DBusProxy	Returns: A `DBusProxy` or `Nothing` if error is set. Free with `objectUnref`. (Can throw `GError`)

Creates a proxy for accessing interfaceName on the remote object at objectPath owned by name at connection and synchronously loads D-Bus properties unless the DBusProxyFlagsDoNotLoadProperties flag is used.

If the DBusProxyFlagsDoNotConnectSignals flag is not set, also sets up match rules for signals. Connect to the DBusProxy::gSignal signal to handle signals from the remote object.

If both DBusProxyFlagsDoNotLoadProperties and DBusProxyFlagsDoNotConnectSignals are set, this constructor is guaranteed to return immediately without blocking.

If name is a well-known name and the DBusProxyFlagsDoNotAutoStart and DBusProxyFlagsDoNotAutoStartAtConstruction 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 dBusProxyNew and dBusProxyNewFinish for the asynchronous version.

DBusProxy is used in this [example][classgio.DBusProxya-watch-proxy-example].

Since: 2.26

setCachedProperty

data DBusProxySetCachedPropertyMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> Maybe GVariant -> m ()), MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxySetCachedPropertyMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxySetCachedPropertyMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxySetCachedProperty Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`
-> Text	`propertyName`: Property name.
-> Maybe GVariant	`value`: Value for the property or `Nothing` to remove it from the cache.
-> m ()

If value is not Nothing, sets the cached value for the property with name propertyName to the value in value.

If value is Nothing, then the cached value is removed from the property cache.

If proxy has an expected interface (see DBusProxy:gInterfaceInfo) and propertyName 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.

C code

g_dbus_proxy_set_cached_property (proxy,
                                  "SomeProperty",
                                  g_variant_new ("(si)",
                                                "A String",
                                                42));

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 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

setDefaultTimeout

data DBusProxySetDefaultTimeoutMethodInfo Source #

Instances

Instances details

(signature ~ (Int32 -> m ()), MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxySetDefaultTimeoutMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxySetDefaultTimeoutMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxySetDefaultTimeout Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`.
-> Int32	`timeoutMsec`: Timeout in milliseconds.
-> m ()

Sets the timeout to use if -1 (specifying default timeout) is passed as timeoutMsec in the dBusProxyCall and dBusProxyCallSync functions.

See the DBusProxy:gDefaultTimeout property for more details.

Since: 2.26

setInterfaceInfo

data DBusProxySetInterfaceInfoMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe DBusInterfaceInfo -> m ()), MonadIO m, IsDBusProxy a) => OverloadedMethod DBusProxySetInterfaceInfoMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusProxySetInterfaceInfoMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusProxy Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusProxySetInterfaceInfo Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusProxy a)
=> a	`proxy`: A `DBusProxy`
-> Maybe DBusInterfaceInfo	`info`: Minimum interface this proxy conforms to or `Nothing` to unset.
-> m ()

Ensure that interactions with proxy conform to the given interface. See the DBusProxy:gInterfaceInfo property for more details.

Since: 2.26

Properties

gBusType

If this property is not BusTypeNone, then DBusProxy:gConnection must be Nothing and will be set to the DBusConnection obtained by calling busGet with the value of this property.

Since: 2.26

data DBusProxyGBusTypePropertyInfo Source #

Instances

Instances details

AttrInfo DBusProxyGBusTypePropertyInfo Source #

Instance details

= GVariant	`changedProperties`: A `GVariant` containing the properties that changed (type: `a{sv}`)
-> [Text]	`invalidatedProperties`: A `Nothing` terminated array of properties that was invalidated
-> IO ()

= Maybe Text	`senderName`: The sender of the signal or `Nothing` if the connection is not a bus connection.
-> Text	`signalName`: The name of the signal.
-> GVariant	`parameters`: A `GVariant` tuple with parameters for the signal.
-> IO ()

A watch proxy example

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

call

Instances

C code

callFinish

Instances

callSync

Instances

C code

callWithUnixFdList

Instances

callWithUnixFdListFinish

Instances

callWithUnixFdListSync

Instances

getCachedProperty

Instances

getCachedPropertyNames

Instances

getConnection

Instances

getDefaultTimeout

Instances

getFlags

Instances

getInterfaceInfo

Instances

getInterfaceName

Instances

getName

Instances

getNameOwner

Instances

getObjectPath

Instances

new

newFinish

newForBus

newForBusFinish

newForBusSync

newSync

setCachedProperty

Instances

C code

setDefaultTimeout

Instances

setInterfaceInfo

Instances

Properties

gBusType

Instances

gConnection

Instances

gDefaultTimeout

Instances

gFlags

Instances

gInterfaceInfo

Instances

gInterfaceName

Instances

gName

Instances

gNameOwner

Instances

gObjectPath

Instances

Signals

gPropertiesChanged

Instances

gSignal

Instances