Class ThreadScheduler (2.6.1)

Version 2.6.1

• 2.26.1 (latest)
• 2.26.0
• 2.25.2
• 2.23.1
• 2.22.0
• 2.21.5
• 2.20.3
• 2.19.8
• 2.18.4
• 2.17.1
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.12
• 2.12.1
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.1
• 2.6.1
• 2.5.0
• 2.4.2
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.7.2
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.2
• 0.45.0
• 0.44.0
• 0.43.0

ThreadScheduler(executor=None)

A thread pool-based scheduler. It must not be shared across SubscriberClients.

This scheduler is useful in typical I/O-bound message processing.

Parameter

Name	Description
executor	concurrent.futures.ThreadPoolExecutor An optional executor to use. If not specified, a default one will be created.

Inheritance

builtins.object > Scheduler > ThreadScheduler

Properties

queue

Queue: A thread-safe queue used for communication between callbacks and the scheduling thread.

Methods

schedule

schedule(callback, *args, **kwargs)

Schedule the callback to be called asynchronously in a thread pool.

Parameter

Name	Description
callback	Callable The function to call.

shutdown

shutdown(await_msg_callbacks=False)

Shut down the scheduler and immediately end all pending callbacks.

Parameter

Name	Description
await_msg_callbacks	bool If True, the method will block until all currently executing executor threads are done processing. If False (default), the method will not wait for the currently running threads to complete.

Returns

Type	Description
List[pubsub_v1.subscriber.message.Message]	The messages submitted to the scheduler that were not yet dispatched to their callbacks. It is assumed that each message was submitted to the scheduler as the first positional argument to the provided callback.