Class

HinokoFwIsoIt

since: 1.0

Description [src]

class Hinoko.FwIsoIt : GObject.Object
  implements Hinoko.FwIsoCtx {
  /* No available fields */
}

An object to transmit isochronous packet for single channel. HinokoFwIsoIt transmits isochronous packets for single channel by IT context in 1394 OHCI. The content of packet is split to two parts; context header and context payload in a manner of Linux FireWire subsystem.

Available since: 1.0

Ancestors

Implements

Constructors

hinoko_fw_iso_it_new

Instantiate HinokoFwIsoIt object and return the instance.

since: 1.0

Instance methods

hinoko_fw_iso_it_allocate

Allocate an IT context to 1394 OHCI hardware. A local node of the node corresponding to the given path is used as the hardware, thus any path is accepted as long as process has enough permission for the path.

since: 0.7

hinoko_fw_iso_it_map_buffer

Map intermediate buffer to share payload of IT context with 1394 OHCI hardware.

since: 0.7

hinoko_fw_iso_it_register_packet

Register packet data with header and payload for IT context. The content of given header and payload is appended into data field of isochronous packet to be sent. The caller can schedule hardware interrupt to generate interrupt event. In detail, please refer to documentation about HinokoFwIsoIt::interrupted.

since: 0.7

hinoko_fw_iso_it_start

Start IT context.

since: 0.7

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from HinokoFwIsoCtx (6)
hinoko_fw_iso_ctx_create_source

Create GSource for GMainContext to dispatch events for isochronous context.

since: 0.7

hinoko_fw_iso_ctx_flush_completions

Flush isochronous context until recent isochronous cycle. The call of function forces the context to queue any type of interrupt event for the recent isochronous cycle. Application can process the content of isochronous packet without waiting for actual hardware interrupt.

since: 0.7

hinoko_fw_iso_ctx_read_cycle_time

Retrieve the value of cycle time register. This method call is available once any isochronous context is created.

since: 1.0

hinoko_fw_iso_ctx_release

Release the context from 1394 OHCI hardware.

since: 0.7

hinoko_fw_iso_ctx_stop

Stop isochronous context.

since: 0.7

hinoko_fw_iso_ctx_unmap_buffer

Unmap intermediate buffer shared with 1394 OHCI hardware for the context.

since: 0.7

Properties

Properties inherited from HinokoFwIsoCtx (2)
HinokoFwIsoCtx:bytes-per-chunk

The number of bytes per chunk in buffer.

since: 0.7

HinokoFwIsoCtx:chunks-per-buffer

The number of chunks per buffer.

since: 0.7

Signals

Hinoko.FwIsoIt::interrupted

Emitted when Linux FireWire subsystem generates interrupt event. There are three cases for Linux FireWire subsystem to generate the event:

since: 1.0

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.

unstable since: 2.0

Signals inherited from HinokoFwIsoCtx (1)
HinokoFwIsoCtx::stopped

Emitted when isochronous context is stopped.

since: 0.7

Class structure

struct HinokoFwIsoItClass {
  GObjectClass parent_class;
  void (* interrupted) (
    HinokoFwIsoIt* self,
    guint sec,
    guint cycle,
    const guint8* tstamp,
    guint tstamp_length,
    guint count
  );
  
}
No description available.
Class members
parent_class: GObjectClass
No description available.
interrupted: void (* interrupted) ( HinokoFwIsoIt* self, guint sec, guint cycle, const guint8* tstamp, guint tstamp_length, guint count )
No description available.

Virtual methods

Hinoko.FwIsoItClass.interrupted

Class closure for the HinokoFwIsoIt::interrupted signal.

since: 1.0