UrfKillswitch

UrfKillswitch — Client object for accessing information about killswitches

Functions

Properties

gint state Read / Write

Signals

void state-changed Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── UrfKillswitch

Includes

#include <urfkill.h>

Description

A helper GObject for accessing killswitches

Functions

urf_killswitch_get_switch_type ()

UrfEnumType
urf_killswitch_get_switch_type (UrfKillswitch *killswitch);

Get the type of the killswitch.

Parameters

killswitch

a UrfKillswitch instance

 

Returns

The type of the killswitch

Since 0.3.0


urf_killswitch_new ()

UrfKillswitch *
urf_killswitch_new (UrfEnumType type);

Creates a new UrfKillswitch object.

Parameters

type

The killswitch type

 

Returns

a new UrfKillswitch object.

Since 0.3.0

Types and Values

struct UrfKillswitch

struct UrfKillswitch;

The UrfKillswitch struct contains only private fields and should not be directly accessed.


struct UrfKillswitchClass

struct UrfKillswitchClass {
};

Class structure for UrfKillswitch

Property Details

The “state” property

  “state”                    gint

The state of the killswitch. See UrfEnumState.

Writing the states other than URF_ENUM_STATE_UNBLOCKED or URF_ENUM_STATE_SOFT_BLOCKED will be ignored. Also, the state writing may not take effect since it depends on the state of the hardware.

Flags: Read / Write

Allowed values: [-1,2]

Default value: -1

Since 0.3.0

Signal Details

The “state-changed” signal

void
user_function (UrfKillswitch *client,
               gint           state,
               gpointer       user_data)

The state-changed signal is emitted when the killswitch state is changed. See UrfEnumState.

Since 0.3.0

Parameters

client

the UrfKillswitch instance that emitted the signal

 

state

the new state

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

See Also

UrfClient, UrfDevice