gi-gio
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Interfaces.DebugController

Description

GDebugController is an interface to expose control of debugging features and debug output.

It is implemented on Linux using DebugControllerDBus, which exposes a D-Bus interface to allow authenticated peers to control debug features in this process.

Whether debug output is enabled is exposed as DebugController:debugEnabled. This controls logSetDebugEnabled by default. Application code may connect to the Object::notify signal for it to control other parts of its debug infrastructure as necessary.

If your application or service is using the default GLib log writer function, creating one of the built-in implementations of GDebugController should be all that’s needed to dynamically enable or disable debug output.

Since: 2.72

Synopsis

Exported types

newtype DebugController Source #

Memory-managed wrapper type.

Instances

Instances details
Eq DebugController Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

GObject DebugController Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

ManagedPtrNewtype DebugController Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

TypedObject DebugController Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

Methods

glibType :: IO GType #

HasParentTypes DebugController Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

HasAttributeList DebugController Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

(info ~ ResolveDebugControllerMethod t DebugController, OverloadedMethod info DebugController p, HasField t DebugController p) => HasField (t :: Symbol) DebugController (p :: Type) Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

Methods

getField :: DebugController -> p #

(info ~ ResolveDebugControllerMethod t DebugController, OverloadedMethodInfo info DebugController) => IsLabel t (MethodProxy info DebugController) Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

(info ~ ResolveDebugControllerMethod t DebugController, OverloadedMethod info DebugController p) => IsLabel t (DebugController -> p) Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

Methods

fromLabel :: DebugController -> p #

IsGValue (Maybe DebugController) Source #

Convert DebugController to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttributeList DebugController Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type ParentTypes DebugController Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type SignalList DebugController Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

class (GObject o, IsDescendantOf DebugController o) => IsDebugController o Source #

Type class for types which can be safely cast to DebugController, for instance with toDebugController.

Instances

Instances details
(GObject o, IsDescendantOf DebugController o) => IsDebugController o Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

toDebugController :: (MonadIO m, IsDebugController o) => o -> m DebugController Source #

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

Methods

type family ResolveDebugControllerMethod (t :: Symbol) o where ... Source #

Equations

ResolveDebugControllerMethod "bindProperty" o = ObjectBindPropertyMethodInfo 
ResolveDebugControllerMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo 
ResolveDebugControllerMethod "forceFloating" o = ObjectForceFloatingMethodInfo 
ResolveDebugControllerMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo 
ResolveDebugControllerMethod "getv" o = ObjectGetvMethodInfo 
ResolveDebugControllerMethod "init" o = InitableInitMethodInfo 
ResolveDebugControllerMethod "isFloating" o = ObjectIsFloatingMethodInfo 
ResolveDebugControllerMethod "notify" o = ObjectNotifyMethodInfo 
ResolveDebugControllerMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo 
ResolveDebugControllerMethod "ref" o = ObjectRefMethodInfo 
ResolveDebugControllerMethod "refSink" o = ObjectRefSinkMethodInfo 
ResolveDebugControllerMethod "runDispose" o = ObjectRunDisposeMethodInfo 
ResolveDebugControllerMethod "stealData" o = ObjectStealDataMethodInfo 
ResolveDebugControllerMethod "stealQdata" o = ObjectStealQdataMethodInfo 
ResolveDebugControllerMethod "thawNotify" o = ObjectThawNotifyMethodInfo 
ResolveDebugControllerMethod "unref" o = ObjectUnrefMethodInfo 
ResolveDebugControllerMethod "watchClosure" o = ObjectWatchClosureMethodInfo 
ResolveDebugControllerMethod "getData" o = ObjectGetDataMethodInfo 
ResolveDebugControllerMethod "getDebugEnabled" o = DebugControllerGetDebugEnabledMethodInfo 
ResolveDebugControllerMethod "getProperty" o = ObjectGetPropertyMethodInfo 
ResolveDebugControllerMethod "getQdata" o = ObjectGetQdataMethodInfo 
ResolveDebugControllerMethod "setData" o = ObjectSetDataMethodInfo 
ResolveDebugControllerMethod "setDataFull" o = ObjectSetDataFullMethodInfo 
ResolveDebugControllerMethod "setDebugEnabled" o = DebugControllerSetDebugEnabledMethodInfo 
ResolveDebugControllerMethod "setProperty" o = ObjectSetPropertyMethodInfo 
ResolveDebugControllerMethod l o = MethodResolutionFailed l o :: Type 

getDebugEnabled

debugControllerGetDebugEnabled Source #

Arguments

:: (HasCallStack, MonadIO m, IsDebugController a) 
=> a

self: a DebugController

-> m Bool

Returns: True if debug output should be exposed, False otherwise

Get the value of DebugController:debugEnabled.

Since: 2.72

setDebugEnabled

debugControllerSetDebugEnabled Source #

Arguments

:: (HasCallStack, MonadIO m, IsDebugController a) 
=> a

self: a DebugController

-> Bool

debugEnabled: True if debug output should be exposed, False otherwise

-> m () 

Set the value of DebugController:debugEnabled.

Since: 2.72

Properties

debugEnabled

True if debug output should be exposed (for example by forwarding it to the journal), False otherwise.

Since: 2.72

data DebugControllerDebugEnabledPropertyInfo Source #

Instances

Instances details
AttrInfo DebugControllerDebugEnabledPropertyInfo Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

Associated Types

type AttrAllowedOps DebugControllerDebugEnabledPropertyInfo 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrBaseTypeConstraint DebugControllerDebugEnabledPropertyInfo 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrGetType DebugControllerDebugEnabledPropertyInfo 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrSetTypeConstraint DebugControllerDebugEnabledPropertyInfo 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrTransferTypeConstraint DebugControllerDebugEnabledPropertyInfo 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrTransferType DebugControllerDebugEnabledPropertyInfo 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrLabel DebugControllerDebugEnabledPropertyInfo 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrOrigin DebugControllerDebugEnabledPropertyInfo 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrAllowedOps DebugControllerDebugEnabledPropertyInfo Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrBaseTypeConstraint DebugControllerDebugEnabledPropertyInfo Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrGetType DebugControllerDebugEnabledPropertyInfo Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrLabel DebugControllerDebugEnabledPropertyInfo Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrOrigin DebugControllerDebugEnabledPropertyInfo Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrSetTypeConstraint DebugControllerDebugEnabledPropertyInfo Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrTransferType DebugControllerDebugEnabledPropertyInfo Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

type AttrTransferTypeConstraint DebugControllerDebugEnabledPropertyInfo Source # 
Instance details

Defined in GI.Gio.Interfaces.DebugController

constructDebugControllerDebugEnabled :: (IsDebugController o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “debug-enabled” property. This is rarely needed directly, but it is used by new.

getDebugControllerDebugEnabled :: (MonadIO m, IsDebugController o) => o -> m Bool Source #

Get the value of the “debug-enabled” property. When overloading is enabled, this is equivalent to

get debugController #debugEnabled

setDebugControllerDebugEnabled :: (MonadIO m, IsDebugController o) => o -> Bool -> m () Source #

Set the value of the “debug-enabled” property. When overloading is enabled, this is equivalent to

set debugController [ #debugEnabled := value ]