A task scheduler suitable for low priority operations that can run in the background.
- macOS 10.10+
NSBackground object to schedule an arbitrary maintenance or background task. It’s similar to an
Timer object, in that it lets you schedule a repeating or non-repeating task. However,
NSBackground gives the system flexibility to determine the most efficient time to execute based on energy usage, thermal conditions, and CPU use.
For example, use an
NSBackground object to schedule:
Periodic content fetches
Installation of updates
Activities occurring in intervals of 10 minutes or more
Any other deferrable task
Create a Scheduler
To initialize a scheduler, call
NSBackground, and pass it a unique identifier string in reverse DNS notation (
nil and zero-length strings are not allowed) that remains constant across launches of your application. See Listing 1.
Configure Scheduler Properties
Configure the scheduler with any of the following scheduling properties:
repeats—If set to
true, the activity is rescheduled at the specified interval after finishing.
interval—For repeating schedulers, the average interval between invocations of the activity. For nonrepeating schedulers,
intervalis the suggested interval of time between scheduling the activity and the invocation of the activity.
tolerance—The amount of time before or after the nominal fire date when the activity should be invoked. The nominal fire date is calculated by using the interval combined with the previous fire date or the time when the activity is started. These two properties create a window in time, during which the activity may be scheduled. The system will more aggressively schedule the activity as it nears the end of the grace period after the nominal fire date. The default value is half the interval.
quality—The default value is
NSQuality. If you upgrade the quality of service above this level, the system schedules the activity more aggressively. The default value is the recommended value for most activities. For information on quality of service, see Prioritize Work at the Task Level in Energy Efficiency Guide for Mac Apps.
Of Service Background
Listing 2, Listing 3, and Listing 4 demonstrate different scheduling scenarios.
Schedule Activity with scheduleWithBlock:
When you’re ready to schedule the activity, call
schedule and provide a block of code to execute when the scheduler runs, as shown in Listing 5. The block will be called on a serial background queue appropriate for the level of quality of service specified. The system automatically uses the
begin method (of
Process) while invoking the block, choosing appropriate options based on the specified quality of service.
When your block is called, it’s passed a completion handler as an argument. Configure the block to invoke this handler, passing it a result of type
NSBackground to indicate whether the activity finished (
NSBackground) or should be deferred (
NSBackground) and rescheduled for a later time. Failure to invoke the completion handler results in the activity not being rescheduled. For work that will be deferred and rescheduled, the block may optionally adjust scheduler properties, such as
tolerance, before calling the completion handler.
Detect Whether to Defer Activity
It’s conceivable that while a lengthy activity is running, conditions may change, resulting in the activity now requiring deferral. For example, perhaps the user has unplugged the Mac and it’s now running on battery power. Your activity can call
should to determine whether this has occurred. A value of
true indicates that the block should finish what it’s currently doing and invoke its completion handler with a value of
NSBackground. See Listing 6.
invalidate() to stop scheduling an activity, as shown in Listing 7.