HinawaFwNode

HinawaFwNode — An event listener for FireWire node

Functions

Properties

guint bus-manager-node-id Read
guint generation Read
guint ir-manager-node-id Read
guint local-node-id Read
guint node-id Read
guint root-node-id Read

Signals

void bus-update Run Last
void disconnected Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── HinawaFwNode

Includes

#include <fw_node.h>

Description

A HinawaFwNode is an event listener for a specified node on IEEE 1394 bus. This class is an application of Linux FireWire subsystem. All of operations utilize ioctl(2) with subsystem specific request commands.

Functions

hinawa_fw_node_error_quark ()

GQuark
hinawa_fw_node_error_quark ();

Return the GQuark for error domain of GError which has code in HinawaFwNodeError.

Returns

A GQuark.

Since: 2.1


hinawa_fw_node_new ()

HinawaFwNode *
hinawa_fw_node_new (void);

Instantiate HinawaFwNode object and return the instance.

Returns

an instance of HinawaFwNode.

Since: 1.4.


hinawa_fw_node_open ()

void
hinawa_fw_node_open (HinawaFwNode *self,
                     const gchar *path,
                     GError **exception);

Open Linux FireWire character device to operate node on IEEE 1394 bus.

Parameters

self

A HinawaFwNode

 

path

A path to Linux FireWire character device

 

exception

A GError. Error can be generated with two domains; g_file_error_quark(), and hinawa_fw_node_error_quark().

 

Since: 1.4.


hinawa_fw_node_get_config_rom ()

void
hinawa_fw_node_get_config_rom (HinawaFwNode *self,
                               const guint8 **image,
                               gsize *length,
                               GError **exception);

Get cached content of configuration ROM aligned to big-endian.

Parameters

self

A HinawaFwNode

 

image

The content of configuration ROM.

[array length=length][out][transfer none]

length

The number of bytes consists of the configuration rom.

[out]

exception

A GError.

 

Since: 1.4.


hinawa_fw_node_create_source ()

void
hinawa_fw_node_create_source (HinawaFwNode *self,
                              GSource **gsrc,
                              GError **exception);

Create Gsource for GMainContext to dispatch events for the node on IEEE 1394 bus.

Parameters

self

A HinawaFwNode.

 

gsrc

A GSource.

[out]

exception

A GError. Error can be generated with domain of hinawa_fw_node_error_quark() and code of HinawaFwNodeError.

 

Since: 1.4.

Types and Values

HINAWA_FW_NODE_ERROR

#define HINAWA_FW_NODE_ERROR hinawa_fw_node_error_quark()

Property Details

The “bus-manager-node-id” property

  “bus-manager-node-id”      guint

Node ID of node which plays role of bus manager at current generation of bus topology.

Owner: HinawaFwNode

Flags: Read

Default value: 0

Since: 1.4


The “generation” property

  “generation”               guint

Current generation of bus topology.

Owner: HinawaFwNode

Flags: Read

Default value: 0

Since: 1.4


The “ir-manager-node-id” property

  “ir-manager-node-id”       guint

Node ID of node which plays role of isochronous resource manager at current generation of bus topology.

Owner: HinawaFwNode

Flags: Read

Default value: 0

Since: 1.4


The “local-node-id” property

  “local-node-id”            guint

Node ID of node which application uses to communicate to node associated to instance of object at current generation of bus topology. In general, it is for OHCI 1394 host controller.

Owner: HinawaFwNode

Flags: Read

Default value: 0

Since: 1.4


The “node-id” property

  “node-id”                  guint

Node ID of node associated to instance of object at current generation of bus topology. This parameter is effective after the association.

Owner: HinawaFwNode

Flags: Read

Default value: 0

Since: 1.4


The “root-node-id” property

  “root-node-id”             guint

Node ID of root node in bus topology at current generation of the bus topology.

Owner: HinawaFwNode

Flags: Read

Default value: 0

Since: 1.4

Signal Details

The “bus-update” signal

void
user_function (HinawaFwNode *self,
               gpointer      user_data)

When IEEE 1394 bus is updated, the “bus-update” signal is generated. Handlers can read current generation in the bus via 'generation' property.

Parameters

self

A HinawaFwNode.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 1.4


The “disconnected” signal

void
user_function (HinawaFwNode *self,
               gpointer      user_data)

When phicical FireWire devices are disconnected from IEEE 1394 bus, the “disconnected” signal is generated.

Parameters

self

A HinawaFwNode.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 1.4