Class Scheduler (2.5.0)

Version 2.5.0

• 2.27.1 (latest)
• 2.27.0
• 2.26.1
• 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

Scheduler()

Abstract base class for schedulers.

Schedulers are used to schedule callbacks asynchronously.

Inheritance

builtins.object > Scheduler

Properties

queue

Queue: A concurrency-safe queue specific to the underlying concurrency implementation.

This queue is used to send messages back to the scheduling actor.

Methods

schedule

schedule(callback, *args, **kwargs)

Schedule the callback to be called asynchronously.

Parameter

Name	Description
callback	Callable The function to call.

shutdown

shutdown(await_msg_callbacks=False)

Shuts 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 callbacks are done processing. If False (default), the method will not wait for the currently running callbacks 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.