Ags.MainLoop

Implementations:

Ags.GenericMainLoop

Methods

	change_frequency (frequency)
	dec_queued_critical_region ()
	get_tree_lock ()
	inc_queued_critical_region ()
	is_critical_region ()
	is_syncing ()
	set_critical_region (is_critical_region)
	set_syncing (is_syncing)
	test_queued_critical_region ()

Virtual Methods

	do_change_frequency (frequency)
	do_dec_queued_critical_region ()
	do_get_tree_lock ()
	do_inc_queued_critical_region ()
	do_is_critical_region ()
	do_is_syncing ()
	do_set_critical_region (is_critical_region)
	do_set_syncing (is_syncing)
	do_test_queued_critical_region ()

Properties

None

Signals

Name	Short Description
change-frequency	Change frequency.

Fields

None

Class Details

class Ags.MainLoop

Bases:

GObject.GInterface

Structure:

Ags.MainLoopInterface

change_frequency(frequency)

Parameters:

frequency (float) – the new frequency

Change frequency.

New in version 3.0.0.

dec_queued_critical_region()

Decrement thread needs access to main loop’s critical region field.

New in version 3.0.0.

get_tree_lock()

Returns:

the mutex

Return type:

GLib.RecMutex

Retrieve the tree mutex.

New in version 3.0.0.

inc_queued_critical_region()

Increment thread needs access to main loop’s critical region field.

New in version 3.0.0.

is_critical_region()

Returns:

True if sync in progress, otherwise False

Return type:

bool

Check if main loop is in critical region.

New in version 3.0.0.

is_syncing()

Returns:

True if sync in progress, otherwise False

Return type:

bool

Check if thread tree is syncing.

New in version 3.0.0.

set_critical_region(is_critical_region)

Parameters:

is_critical_region (bool) – set True if critical region

Set main loop is in critical region.

New in version 3.0.0.

set_syncing(is_syncing)

Parameters:

is_syncing (bool) – set True if syncing

Set thread tree is syncing.

New in version 3.0.0.

test_queued_critical_region()

Returns:

0 if main loop may enter critical region, otherwise not

Return type:

int

Test main loop may enter critical region.

New in version 3.0.0.

do_change_frequency(frequency) virtual

Parameters:

frequency (float) – the new frequency

Change frequency.

New in version 3.0.0.

do_dec_queued_critical_region() virtual

Decrement thread needs access to main loop’s critical region field.

New in version 3.0.0.

do_get_tree_lock() virtual

Returns:

the mutex

Return type:

GLib.RecMutex

Retrieve the tree mutex.

New in version 3.0.0.

do_inc_queued_critical_region() virtual

Increment thread needs access to main loop’s critical region field.

New in version 3.0.0.

do_is_critical_region() virtual

Returns:

True if sync in progress, otherwise False

Return type:

bool

Check if main loop is in critical region.

New in version 3.0.0.

do_is_syncing() virtual

Returns:

True if sync in progress, otherwise False

Return type:

bool

Check if thread tree is syncing.

New in version 3.0.0.

do_set_critical_region(is_critical_region) virtual

Parameters:

is_critical_region (bool) – set True if critical region

Set main loop is in critical region.

New in version 3.0.0.

do_set_syncing(is_syncing) virtual

Parameters:

is_syncing (bool) – set True if syncing

Set thread tree is syncing.

New in version 3.0.0.

do_test_queued_critical_region() virtual

Returns:

0 if main loop may enter critical region, otherwise not

Return type:

int

Test main loop may enter critical region.

New in version 3.0.0.

Signal Details

Ags.MainLoop.signals.change_frequency(main_loop, frequency)

Signal Name:

change-frequency

Flags:

RUN_LAST

Parameters:

• main_loop (Ags.MainLoop) – The object which received the signal

• frequency (float) – the new frequency

Change frequency.

New in version 3.0.0.