Hinoko.FwIsoResourceOnce

g GObject.GInterface GObject.GInterface Hinoko.FwIsoResource Hinoko.FwIsoResource GObject.GInterface->Hinoko.FwIsoResource GObject.Object GObject.Object Hinoko.FwIsoResourceOnce Hinoko.FwIsoResourceOnce GObject.Object->Hinoko.FwIsoResourceOnce Hinoko.FwIsoResource->Hinoko.FwIsoResourceOnce

Subclasses:

None

Methods

Inherited:

GObject.Object (37), Hinoko.FwIsoResource (5)

Structs:

GObject.ObjectClass (5)

class

new ()

deallocate (channel, bandwidth)

deallocate_wait (channel, bandwidth, timeout_ms)

Virtual Methods

Inherited:

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

Properties

Inherited:

Hinoko.FwIsoResource (1)

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.FwIsoResourceOnce(**kwargs)
Bases:

GObject.Object, Hinoko.FwIsoResource

Abstract:

No

Structure:

Hinoko.FwIsoResourceOnceClass

An object to initiate requests and listen events of isochronous resource allocation/deallocation by one shot. The [class`FwIsoResourceOnce`] is an object to initiate requests and listen events of isochronous resource allocation/deallocation by file descriptor owned internally. The allocated resource is left even if this object is destroyed, thus application is responsible for deallocation.

classmethod new()
Returns:

A [class`FwIsoResourceOnce`].

Return type:

Hinoko.FwIsoResourceOnce

Allocate and return an instance of [class`FwIsoResourceOnce`].

New in version 0.7.

deallocate(channel, bandwidth)
Parameters:
  • channel (int) – The channel number to be deallocated.

  • bandwidth (int) – The amount of bandwidth to be deallocated.

Raises:

GLib.Error

Returns:

True if the overall operation finishes successfully, otherwise False.

Return type:

bool

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

New in version 1.0.

deallocate_wait(channel, bandwidth, timeout_ms)
Parameters:
  • channel (int) – The channel number to be deallocated.

  • bandwidth (int) – The amount of bandwidth to be deallocated.

  • timeout_ms (int) – The timeout to wait for deallocated event.

Raises:

GLib.Error

Returns:

True if the overall operation finishes successfully, otherwise False.

Return type:

bool

Initiate deallocation of isochronous resource and wait for [signal`FwIsoResource`:py:func:::deallocated<Hinoko.FwIsoResourceOnce.signals.deallocated>] signal.

New in version 1.0.