Ags.ReturnableThread¶

Subclasses:: None

Methods¶

Inherited:: Ags.Thread (49), GObject.Object (37), Ags.Connectable (13)
Structs:: GObject.ObjectClass (5)

class	`new` (thread_pool)
	`connect_safe_run` (callback)
	`disconnect_safe_run` ()
	`safe_run` ()
	`set_flags` (flags)
	`test_flags` (flags)
	`unset_flags` (flags)

Virtual Methods¶

Inherited:: Ags.Thread (5), GObject.Object (7), Ags.Connectable (13)

do_safe_run ()

Properties¶

Inherited:: Ags.Thread (3)

Name	Type	Flags	Short Description
`thread-pool`	`GObject.Object`	r/w	The thread pool it is assigned with

Signals¶

Inherited:: Ags.Thread (5), GObject.Object (1)

Name	Short Description
`safe-run`	The `::safe-run` is invoked durin `Ags.Thread` `::run` as a context safe wrapper.

Fields¶

Inherited:: Ags.Thread (5), GObject.Object (1)

Name	Type	Access
flags	`int`	r
handler	`int`	r
reset_mutex	`GLib.RecMutex`	r
safe_data	`object`	r
thread	`Ags.Thread`	r
thread_pool	`GObject.Object`	r

Class Details¶

class Ags.ReturnableThread(**kwargs)¶

Bases:: Ags.Thread
Abstract:: No
Structure:: Ags.ReturnableThreadClass

classmethod new(thread_pool)¶

Parameters:: thread_pool (GObject.Object) – the Ags.ThreadPool
Returns:: the new Ags.ReturnableThread
Return type:: Ags.ReturnableThread

Create a new instance of Ags.ReturnableThread.

New in version 3.0.0.

connect_safe_run(callback)¶

Parameters:: callback (Ags.ReturnableThreadCallback) – the callback

Connects callback to thread.

New in version 3.0.0.

disconnect_safe_run()¶: Disconnects callback of thread.

New in version 3.0.0.

safe_run()¶

set_flags(flags)¶

Parameters:: flags (Ags.ReturnableThreadFlags) – the flags

Set flags.

New in version 3.0.0.

test_flags(flags)¶

Parameters:: flags (Ags.ReturnableThreadFlags) – the flags
Returns:: True if flags are set, else False
Return type:: bool

Test flags to be set on self.

New in version 3.0.0.

unset_flags(flags)¶

Parameters:: flags (Ags.ReturnableThreadFlags) – the flags

Unset flags.

New in version 3.0.0.

do_safe_run() virtual¶

Signal Details¶

Ags.ReturnableThread.signals.safe_run(returnable_thread)¶

Signal Name:: safe-run
Flags:: RUN_LAST
Parameters:: returnable_thread (Ags.ReturnableThread) – The object which received the signal

The ::safe-run is invoked durin Ags.Thread ::run as a context safe wrapper.

New in version 3.0.0.

Property Details¶

Ags.ReturnableThread.props.thread_pool¶

Name:: thread-pool
Type:: GObject.Object
Default Value:: None
Flags:: READABLE, WRITABLE

The assigned Ags.ThreadPool providing default settings.

New in version 3.0.0.