Hinoko.FwIsoResourceAuto¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Hinoko.FwIsoResource (5)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`deallocate` ()
	`deallocate_wait` (timeout_ms)

Virtual Methods¶

Inherited:: GObject.Object (7), Hinoko.FwIsoResource (5)

Properties¶

Inherited:: Hinoko.FwIsoResource (1)

Name	Type	Flags	Short Description
`bandwidth`	`int`	r	The allocated amount of bandwidth.
`channel`	`int`	r	The allocated channel number.
`is-allocated`	`bool`	r	Whether to allocate or not.

Signals¶

Inherited:: GObject.Object (1), Hinoko.FwIsoResource (2)

Fields¶

Inherited:: GObject.Object (1), Hinoko.FwIsoResource (2)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Hinoko.FwIsoResourceAuto(**kwargs)¶

Bases:: GObject.Object, Hinoko.FwIsoResource
Abstract:: No
Structure:: Hinoko.FwIsoResourceAutoClass

An object to maintain allocated isochronous resource. [class`FwIsoResourceAuto`]is an object to maintain isochronous resource during the lifetime of the object. The allocated isochronous resource is kept even if the generation of the bus updates. The maintenance of allocated isochronous resource is done by Linux FireWire subsystem.

classmethod new()¶

Returns:: A [class`FwIsoResourceAuto`]
Return type:: Hinoko.FwIsoResourceAuto

Allocate and return an instance of [class`FwIsoResourceAuto`]object.

deallocate()¶

Raises:: GLib.Error
Returns:: True if the overall operation finished successfully, otherwise False.
Return type:: bool

Initiate deallocation of isochronous resource. When the deallocation is done, [signal`FwIsoResource`:py:func:::deallocated<Hinoko.FwIsoResourceAuto.signals.deallocated>] signal is emit to notify the result, channel, and bandwidth.

New in version 1.0.

deallocate_wait(timeout_ms)¶

Parameters:: timeout_ms (int) – The timeout to wait for allocated event by milli second unit.
Raises:: GLib.Error
Returns:: True if the overall operation finished successfully, otherwise False.
Return type:: bool

Initiate deallocation of isochronous resource. When the deallocation is done, [signal`FwIsoResource`:py:func:::deallocated<Hinoko.FwIsoResourceAuto.signals.deallocated>] signal is emit to notify the result, channel, and bandwidth.

New in version 1.0.

Property Details¶

Hinoko.FwIsoResourceAuto.props.bandwidth¶

Name:: bandwidth
Type:: int
Default Value:: 0
Flags:: READABLE

The allocated amount of bandwidth.

New in version 0.7.

Hinoko.FwIsoResourceAuto.props.channel¶

Name:: channel
Type:: int
Default Value:: 0
Flags:: READABLE

The allocated channel number.

New in version 0.7.

Hinoko.FwIsoResourceAuto.props.is_allocated¶

Name:: is-allocated
Type:: bool
Default Value:: False
Flags:: READABLE

Whether to be allocate isochronous resource or not.

New in version 0.7.