GI.Gio.Interfaces.DBusObject

The DBusObject type is the base type for D-Bus objects on both the service side (see DBusObjectSkeleton) and the client side (see DBusObjectProxy). It is essentially just a container of interfaces.

Exported types

newtype DBusObject

Memory-managed wrapper type.

Constructors

DBusObject (ManagedPtr DBusObject)

Instances

Eq DBusObject

Defined in GI.Gio.Interfaces.DBusObject

Methods

(==) :: DBusObject -> DBusObject -> Bool

(/=) :: DBusObject -> DBusObject -> Bool

GObject DBusObject

Defined in GI.Gio.Interfaces.DBusObject

Methods

gobjectType :: IO GType

IsGValue DBusObject

Convert DBusObject to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Interfaces.DBusObject

Methods

toGValue :: DBusObject -> IO GValue

fromGValue :: GValue -> IO DBusObject

HasParentTypes DBusObject

Defined in GI.Gio.Interfaces.DBusObject

type ParentTypes DBusObject

Defined in GI.Gio.Interfaces.DBusObject

type ParentTypes DBusObject = '[Object]

noDBusObject :: Maybe DBusObject

A convenience alias for Nothing :: Maybe DBusObject.

class (GObject o, IsDescendantOf DBusObject o) => IsDBusObject o

Type class for types which can be safely cast to DBusObject, for instance with toDBusObject.

Instances

(GObject o, IsDescendantOf DBusObject o) => IsDBusObject o

Defined in GI.Gio.Interfaces.DBusObject

toDBusObject :: (MonadIO m, IsDBusObject o) => o -> m DBusObject

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

Methods

Overloaded methods

getInterface

dBusObjectGetInterface

Arguments

:: (HasCallStack, MonadIO m, IsDBusObject a)

=> a

object: A DBusObject.

-> Text

interfaceName: A D-Bus interface name.

-> m DBusInterface

Returns: Nothing if not found, otherwise a DBusInterface that must be freed with objectUnref.

Gets the D-Bus interface with name interfaceName associated with object, if any.

Since: 2.30

getInterfaces

dBusObjectGetInterfaces

Arguments

:: (HasCallStack, MonadIO m, IsDBusObject a)

=> a

object: A DBusObject.

-> m [DBusInterface]

Returns: A list of DBusInterface instances. The returned list must be freed by g_list_free() after each element has been freed with objectUnref.

Gets the D-Bus interfaces associated with object.

Since: 2.30

getObjectPath

dBusObjectGetObjectPath

Arguments

:: (HasCallStack, MonadIO m, IsDBusObject a)

=> a

object: A DBusObject.

-> m Text

Returns: A string owned by object. Do not free.

Gets the object path for object.

Since: 2.30

Signals

interfaceAdded

type C_DBusObjectInterfaceAddedCallback = Ptr () -> Ptr DBusInterface -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DBusObjectInterfaceAddedCallback

Arguments

 = DBusInterface

interface: The DBusInterface that was added.

-> IO ()

Emitted when interface is added to object.

Since: 2.30

afterDBusObjectInterfaceAdded :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceAddedCallback -> m SignalHandlerId

Connect a signal handler for the interfaceAdded signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dBusObject #interfaceAdded callback

genClosure_DBusObjectInterfaceAdded :: MonadIO m => DBusObjectInterfaceAddedCallback -> m (GClosure C_DBusObjectInterfaceAddedCallback)

Wrap the callback into a GClosure.

mk_DBusObjectInterfaceAddedCallback :: C_DBusObjectInterfaceAddedCallback -> IO (FunPtr C_DBusObjectInterfaceAddedCallback)

Generate a function pointer callable from C code, from a C_DBusObjectInterfaceAddedCallback.

noDBusObjectInterfaceAddedCallback :: Maybe DBusObjectInterfaceAddedCallback

A convenience synonym for Nothing :: Maybe DBusObjectInterfaceAddedCallback.

onDBusObjectInterfaceAdded :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceAddedCallback -> m SignalHandlerId

Connect a signal handler for the interfaceAdded signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dBusObject #interfaceAdded callback

wrap_DBusObjectInterfaceAddedCallback :: DBusObjectInterfaceAddedCallback -> C_DBusObjectInterfaceAddedCallback

Wrap a DBusObjectInterfaceAddedCallback into a C_DBusObjectInterfaceAddedCallback.

interfaceRemoved

type C_DBusObjectInterfaceRemovedCallback = Ptr () -> Ptr DBusInterface -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DBusObjectInterfaceRemovedCallback

Arguments

 = DBusInterface

interface: The DBusInterface that was removed.

-> IO ()

Emitted when interface is removed from object.

Since: 2.30

afterDBusObjectInterfaceRemoved :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceRemovedCallback -> m SignalHandlerId

Connect a signal handler for the interfaceRemoved signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dBusObject #interfaceRemoved callback

genClosure_DBusObjectInterfaceRemoved :: MonadIO m => DBusObjectInterfaceRemovedCallback -> m (GClosure C_DBusObjectInterfaceRemovedCallback)

Wrap the callback into a GClosure.

mk_DBusObjectInterfaceRemovedCallback :: C_DBusObjectInterfaceRemovedCallback -> IO (FunPtr C_DBusObjectInterfaceRemovedCallback)

Generate a function pointer callable from C code, from a C_DBusObjectInterfaceRemovedCallback.

noDBusObjectInterfaceRemovedCallback :: Maybe DBusObjectInterfaceRemovedCallback

A convenience synonym for Nothing :: Maybe DBusObjectInterfaceRemovedCallback.

onDBusObjectInterfaceRemoved :: (IsDBusObject a, MonadIO m) => a -> DBusObjectInterfaceRemovedCallback -> m SignalHandlerId

Connect a signal handler for the interfaceRemoved signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dBusObject #interfaceRemoved callback

wrap_DBusObjectInterfaceRemovedCallback :: DBusObjectInterfaceRemovedCallback -> C_DBusObjectInterfaceRemovedCallback

Wrap a DBusObjectInterfaceRemovedCallback into a C_DBusObjectInterfaceRemovedCallback.