Class

HinawaFwFcp

Description [src]

class Hinawa.FwFcp : Hinawa.FwResp {
  parent_instance: HinawaFwResp
}

A FCP transaction executor to node in IEEE 1394 bus. A HinawaFwFcp supports Function Control Protocol (FCP) in IEC 61883-1, in which no way is defined to match response against command by the contents of frames. In ‘AV/C Digital Interface Command Set General Specification Version 4.2’ (Sep 1 2004, 1394TA), a pair of command and response is loosely matched by the contents of frames.

Any of transaction frames should be aligned to 8bit (byte). This class is an application of HinawaFwReq / HinawaFwResp.

Ancestors

Constructors

hinawa_fw_fcp_new

Instantiate HinawaFwFcp object and return the instance.

since: 1.3.

Instance methods

hinawa_fw_fcp_avc_transaction

Finish the pair of asynchronous transaction for AV/C command and response transactions. The timeout_ms parameter is used to wait for response transaction since the command transaction is initiated, ignoring HinawaFwFcp:timeout property of instance. The timeout is not expanded in the case that AV/C INTERIM status is arrived, thus the caller should expand the timeout in advance for the case.

deprecated: 2.6 since: 2.1.

hinawa_fw_fcp_avc_transaction_with_tstamp

Finish the pair of asynchronous transaction for AV/C command and response transactions. The timeout_ms parameter is used to wait for response transaction since the command transaction is initiated, ignoring HinawaFwFcp:timeout property of instance. The timeout is not expanded in the case that AV/C INTERIM status is arrived, thus the caller should expand the timeout in advance for the case.

since: 2.6.

hinawa_fw_fcp_bind

Start to listen to FCP responses.

since: 1.4

hinawa_fw_fcp_command

Transfer command frame for FCP. When receiving response frame for FCP, HinawaFwFcp::responded signal is emitted.

deprecated: 2.6 since: 2.1.

hinawa_fw_fcp_command_with_tstamp

Transfer command frame for FCP. When receiving response frame for FCP, HinawaFwFcp::responded signal is emitted.

since: 2.6.

hinawa_fw_fcp_transaction

Finish the pair of command and response transactions for FCP. The value of HinawaFwFcp:timeout property is used to wait for response transaction since the command transaction is initiated.

deprecated: 2.1 since: 1.4.

hinawa_fw_fcp_unbind

Stop to listen to FCP responses.

since: 1.4.

Methods inherited from HinawaFwResp (5)
hinawa_fw_resp_get_req_frame

Retrieve byte frame to be requested.

deprecated: 2.2 since: 2.0

hinawa_fw_resp_release

Stop to listen to a range of address in local node (e.g. OHCI 1394 controller).

since: 1.4.

hinawa_fw_resp_reserve

Start to listen to a range of address in host controller which connects to the node. The function is a variant of hinawa_fw_resp_reserve_within_region() so that the exact range of address should be reserved as given.

since: 1.4.

hinawa_fw_resp_reserve_within_region

Start to listen to range of address equals to #width in local node (e.g. 1394 OHCI host controller), which is used to communicate to the node given as parameter. The range of address is looked up in region between region_start and region_end.

since: 2.3.

hinawa_fw_resp_set_resp_frame

Register byte frame as response.

since: 2.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Hinawa.FwFcp:is-bound

Whether this protocol is bound to any instance of HinawaFwNode.

since: 2.0

Hinawa.FwFcp:timeout

Since 1.4

deprecated: 2.1 

Properties inherited from HinawaFwResp (3)
Hinawa.FwResp:is-reserved

Whether a range of address is reserved or not in host controller.

since: 2.0

Hinawa.FwResp:offset

The start offset of reserved address range.

since: 2.3

Hinawa.FwResp:width

The width of reserved address range.

since: 2.3

Signals

Hinawa.FwFcp::responded

Emitted when the node transfers asynchronous packet as response for FCP and the process successfully read the content of packet, except for the case that HinawaFwFcp::responded2 signal handler is already assigned.

deprecated: 2.6 since: 2.1

Hinawa.FwFcp::responded2

Emitted when the node transfers asynchronous packet as response for FCP and the process successfully read the content of packet.

since: 2.6.

Signals inherited from HinawaFwResp (3)
HinawaFwResp::requested

Emitted when any node transfers requests to the range of address in 1394 OHCI controller to which this object listening, except for the case that either HinawaFwResp::requested2 signal handler or HinawaFwResp::requested3 signal handler is already assigned.

deprecated: 2.2 since: 0.3

HinawaFwResp::requested2

Emitted when any node transfers request subaction to the range of address in 1394 OHCI controller to which this object listening, except for the case that HinawaFwResp::requested3 signal handler is already assigned.

deprecated: 2.6 since: 2.2

HinawaFwResp::requested3

Emitted when any node transfers request subaction to the range of address in 1394 OHCI controller to which this object listening.

since: 2.6

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct HinawaFwFcpClass {
  HinawaFwRespClass parent_class;
  void (* responded) (
    HinawaFwFcp* self,
    const guint8* frame,
    guint frame_size
  );
  void (* responded2) (
    HinawaFwFcp* self,
    guint tstamp,
    const guint8* frame,
    guint frame_size
  );
  
}
No description available.
Class members
parent_class: HinawaFwRespClass
No description available.
responded: void (* responded) ( HinawaFwFcp* self, const guint8* frame, guint frame_size )
No description available.
responded2: void (* responded2) ( HinawaFwFcp* self, guint tstamp, const guint8* frame, guint frame_size )
No description available.

Virtual methods

Hinawa.FwFcpClass.responded

Class closure for the HinawaFwFcp::responded signal.

since: 2.1

Hinawa.FwFcpClass.responded2

Class closure for the HinawaFwFcp::responded2 signal.

since: 2.6