TweetFollow Us on Twitter

MacApp Low Priority
Volume Number:11
Issue Number:2
Column Tag:Improving The Framework

Using Low Priority Events in MacApp

Fixing a minor bug gets your priorities straight

By Harry Haddon, Franklin & Marshall College

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

Just like most standard Macintosh programs, MacApp has a main event loop, but as with many things, MacApp handles the gory details of the event loop for you while still giving you the flexibility to expand or improve upon it as needed. The focus of MacApp’s event loop is MacApp’s event list which usually contains commands but can also contain more generalized events. Commands and events posted to this list can have different priorities to change the order in which they are processed. The only problem is that MacApp 3.0 and 3.1 never actually process your low priority events.

This article gives a quick overview of the MacApp event list, explains why you might want to use an event with a low priority, and tells you how to fix MacApp-without modifying the MacApp source-so low priority events are properly processed.

Inside the Event List

The MacApp event list is of type TEventList and is a data member, named fEventList, of TApplication. TEventList contains objects of type TEvent and objects descended from TEvent including objects of type TCommand. Since TCommand is a descendent of TEvent, I will use the word “events” in this article to refer to both events and commands.

When you call PostAnEvent() or PostCommand(), the TEventHandler implementations of these two methods pass the event to the next event handler in the event handler chain until TApplication::PostAnEvent() gets the event and inserts it in fEventList sorted by priority. TApplication’s main event loop method retrieves events from fEventList and handles the events by calling their Process() method. The highest priority events, those with their fPriority field set to kPriorityHighest, are retrieved before the lower priority ones. The priorities defined by MacApp are:

// Low priority commands are considered last
const short kPriorityLowest = 127;
const short kPriorityLow = kPriorityLowest - 32;
// Normal priority: command default priority
const short kPriorityNormal = 64;
const short kPriorityHigh = kPriorityNormal - 32;
//High priority commands take precedence
const short kPriorityHighest = 0;

If you wish you can use priority values which are between these constants. The default priority for events is kPriorityNormal.

Events of equal priority in fEventList are not necessarily processed on a First-In, First-Out basis. MacApp uses a binary search when inserting events in fEventList and inserts the event at the first event it finds of equal priority. If you post an event and there are already two or more events of equal priority in the list, their order in the list is indeterminate and hence their order of processing is indeterminate. This is not normally a problem since the typical MacApp application does not have that many equal priority events in the list at one time, but it is something to consider if you’re posting multiple commands to the list at the same time and the order of processing is important.

One command you’ll always find in fEventList is the TEventRetrieverCommand that MacApp uses to fetch toolbox events from the toolbox’s Event Manager. The initialization method IApplication() creates this command with a priority of kPriorityLow and posts it to fEventList. The command stays in the list as long as the application is running, and its sole job is to check for toolbox events. Since TEventRetrieverCommand has a lower priority than normal, MacApp does not process it until after it processes the events in the list that have a normal priority. Thus MacApp won’t fetch any more events from the toolbox queue until after it has processed all of the normal priority events and commands in fEventList.

TEventRetrieverCommand::DoIt() checks for toolbox events by calling gApplication->PollToolboxEvent() which calls the toolbox trap WaitNextEvent(). If a toolbox event is available, it is encapsulated in a TToolboxEvent and processed by MacApp. If no toolbox event is available and TApplication.fAllowApplicationToSleep is true, MacApp figures out the various sleep parameters such as the sleep time and calls WaitNextEvent() to wait for the next toolbox event.

This all works great unless you try to post an event with a priority of kPriorityLow or lower. Then you will find that the TEventRetrieverCommand in fEventList acts as a road block for low priority events. Because it was posted first, it is processed before all events of the same priority (kPriorityLow). If no toolbox events are available from the Macintosh event queue, the TEventRetrieverCommand puts the application to sleep, preventing the processing of any low priority events remaining in fEventList. If a toolbox event is available, MacApp processes it, as it should, leaving no opportunity for the processing of low priority events.

Why Use Low Priority Events?

I ran into the bug with low priority events when I was developing a client application that fetches data from a server application. I used a descendent of TClientCommand, MacApp’s class for sending an Apple event and processing its reply, to fetch the data from the server. The server collects new data at the rate of 10 samples per second and the client needs to be updated at least several times a second so as soon as a reply is received, the client posts another TClientCommand to fetch the next chunk of data.

My TClientCommand needed to be a lower priority than toolbox events so that the view that was changed by the TClientCommand would be updated via an update event before the next TClientCommand was processed. I also wanted the application to process toolbox events before it did the TClientCommand so that the application would be responsive to user actions such as mouse clicks. Experimentation with the TClientCommand’s priority set to kPriorityNormal on a slower Macintosh confirmed that being able to set its priority lower was a worthy goal.

You may have a similar situation where a low priority command would fit the bill. Remember that low priority commands really aren’t background or idle commands: they do not execute until after higher priority events have executed, but once they begin execution they can hog CPU cycles as much as any other event. If they take too much time to execute they can slow down the processing of user actions and create a less than enjoyable experience for your user. Design your commands accordingly.

Fixing the Low Priority Event Bug

I came up with a fairly simple fix that I have used with MacApp 3.0.1. This fix will probably also work with 3.1, since it appears that the relevant sections of code have not changed from 3.0 to 3.1. It is not a perfect fix in that events with the very lowest priority, kPriorityLowest, are still not processed, but this is not really a problem since you can use a priority of kPriorityLowest-1 for your lowest priority, and it will work fine.

The original TEventRetrieverCommand, which is installed by IApplication, is left in fEventList but its priority is changed to kPriorityLowest. This still allows the application to sleep-a Good Thing in the Macintosh world of cooperative multi-tasking-but it does not go to sleep until after all other commands are given a chance to execute. I changed the priority of TEventRetrieverCommand in IMyApplication() after calling IApplication():

TEventRetrieverCommand *originalEventRetriever;
originalEventRetriever = 
              (TEventRetrieverCommand *) fEventList->At(1);
originalEventRetriever->fPriority = kPriorityLowest;

if (qDebug && !originalEventRetriever->IsMemberClass(
             GetClassIDFromName("TEventRetrieverCommand")))
      ProgramBreak("First command in fEventList is not \
a TEventRetrieverCommand!");

This code doesn’t look for the TEventRetrieverCommand on the event list but just assumes that it's the first command on the list. The debug check will warn me if this isn’t true in future versions of MacApp. (Hopefully Apple will fix this in MacApp 3.5 and we won’t need this fix at all anymore.)

To keep processing toolbox events at kPriorityLow, I declared a new command that is a descendant of TEventRetrieverCommand. This command checks for toolbox events but never sleeps. It is posted at kPriorityLow to replace the original TEventRetrieverCommand that was demoted to kPriorityLowest.

class TNoSleepEventRetrieverCommand : 
 public TEventRetrieverCommand {
public:
  TNoSleepEventRetrieverCommand();
    // Empty constructor to satisfy compiler.  

  virtual pascal void INoSleepEventRetrieverCommand(
                      CommandNumber itsCommandNumber); 
    // Initialize the EventCommand procedurally.  
  virtual pascal Boolean IsReadyToExecute();                   
 // override 
    // Return true when event available

 virtual pascal void DoIt();
    // Retrieve and process an event without sleeping 
};

I put the declaration for TNoSleepEventRetrieverCommand in the header file that contains the declaration for TMyApplication.

I put the definitions for its methods in the .cp file that contains the methods of TMyApplication. The initialization method INoSleepEventRetrieverCommand() just calls IEventRetrieverCommand() and then sets the command's priority:

#pragma segment ASelCommand
pascal void TNoSleepEventRetrieverCommand::INoSleepEventRetrieverCommand(
 CommandNumber itsCommandNumber) 
{
  this->IEventRetrieverCommand(itsCommandNumber); 

    // Let more important stuff happen first
  fPriority = kPriorityLow;
}

Its IsReadyToExecute method returns true whenever a toolbox event is available:

#pragma segment ARes
pascal Boolean TNoSleepEventRetrieverCommand::IsReadyToExecute() 
{
 EventRecord theEvent;
 
 return EventAvail(gApplication->fMainEventMask, theEvent); 
}

When IsReadyToExecute() returns true, MacApp calls the command’s DoIt() method. The DoIt() for TNoSleepEventRetrieverCommand is just like DoIt() for TEventRetrieverCommand except it calls PollToolboxEvent() with the parameter allowApplicationToSleep set to false so the application doesn’t go to sleep on us:

#pragma segment ASelCommand
pascal void TNoSleepEventRetrieverCommand::DoIt() 
{
 gApplication->PollToolboxEvent(FALSE);
    // FALSE = never sleep
}

The TNoSleepEventRetrieverCommand is created and posted in TMyApplication after the priority of the original TEventRetrieverCommand is changed:

TNoSleepEventRetrieverCommand *aEventCommand = 
                         new TNoSleepEventRetrieverCommand;
aEventCommand->INoSleepEventRetrieverCommand(cNoCommand); 
this->PostAnEvent(aEventCommand);

That’s it. With these fixes in place you can post a command with a priority of kPriorityLow or lower, and MacApp will process it as it should.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Latest Forum Discussions

See All

Is GO Gear the Pokemon GO map app you...
Now that we've settled into something of a Pokemon GO status quo, the number one desire of most players can best be summed out by modifying a quote from Rod Tidwell of Jerry Maguire: "Show me the Pokemon!" [Read more] | Read more »
Rodeo Stampede update: Mountains, new an...
The Savannah and Jungle were just the beginning in Rodeo Stampede. Get ready to head for the Mountains. I think I heard that in a beer ad once. [Read more] | Read more »
COSMOS RINGS (Games)
COSMOS RINGS 1.0.0 Device: iOS iPhone Category: Games Price: $5.99, Version: 1.0.0 (iTunes) Description: This game cannot be played without the Apple Watch.Released anniversary sale until August 31,2016 PST! A tragic tale of time's... | Read more »
How to get started selling on Mercari
As far as ecommerce has come over the last decade or so, there's still a tremendous opportunity to make it easier for people to buy and sell goods. That's especially true when it comes to shopping apps, which should only continue to increase in... | Read more »
Human Anatomy Atlas 2017 Edition - Compl...
Human Anatomy Atlas 2017 Edition - Complete 3D Human Body 1.0.24 Device: iOS iPhone Category: Medical Price: $24.99, Version: 1.0.24 (iTunes) Description: | Read more »
Heroes of Normandie (Games)
Heroes of Normandie 1.5 Device: iOS Universal Category: Games Price: $14.99, Version: 1.5 (iTunes) Description: The game does not support iPhone 4s and below | Read more »
Why you should never power up Pokemon in...
There's no question that candy is dandy in Pokemon GO. You need big quantities of it to evolve your Pokemon, and when combined with stardust, it can be used to power up your favorite pocket monsters as well, making them more formidable for the gym... | Read more »
Webzen launches 3D MMORPG MU Origin on i...
Mu Origin is featured time and time again at the very top of App Stores in China, and within the top five worldwide top-grossing charts on Google Play.Its popularity in Korea and China, featuring more than 120 registered players in China and 6... | Read more »
Severed (Games)
Severed 1.0 Device: iOS Universal Category: Games Price: $5.99, Version: 1.0 (iTunes) Description: LAUNCH DISCOUNT ON NOW!! ENDS AUGUST 4! ==== Take control of a one-armed warrior named Sasha, wielding a living sword on her journey... | Read more »
CSR Racing 2: How to master Live Races
Getting better at racing the AI in CSR Racing 2 is a pretty straightforward process. You run enough races with a particular car to get its shift timing down, continually improve it by buying upgrades whenever you can, and add any fusion parts you... | Read more »

Price Scanner via MacPrices.net

Apple TVs on sale for $20-$40 off MSRP
Best Buy has 32GB and 64GB Apple TVs on sale for $20-$40 off MSRP on their online store. Choose free shipping or free local store pickup (if available). Sale prices for online orders only, in-store... Read more
Mac minis on sale for $50-$100 off MSRP
B&H Photo has Mac minis on sale for $50 off MSRP including free shipping plus NY sales tax only: - 1.4GHz Mac mini: $449 $50 off MSRP - 2.6GHz Mac mini: $649 $50 off MSRP - 2.8GHz Mac mini: $949... Read more
Clearance 2015 13-inch MacBook Airs available...
B&H Photo has clearance 2015 13″ MacBook Airs available for $300 off original MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/4GB/128GB MacBook Air (MJVE2LL/A): $799... Read more
Apple certified refurbished iPad mini 4s avai...
Apple has certified refurbished iPad mini 4s now available for up to $120 off the cost of new models. An Apple one-year warranty is included with each iPad, and shipping is free. The following models... Read more
Notebook Makers In No Rush To Adopt USB-C – R...
Digitimes’ Cage Chao and Joseph Tsai note that while the USB Type-C interface is enjoying growing popularity among smartphones and tablet makers, notebook and all-in-one (AIO) PC vendors (other than... Read more
iMacs on sale for up to $250 off MSRP
B&H Photo has 21″ and 27″ Apple iMacs on sale for up to $250 off MSRP including free shipping plus NY sales tax only: - 27″ 3.3GHz iMac 5K: $2049 $250 off MSRP - 27″ 3.2GHz/1TB Fusion iMac 5K: $... Read more
12-inch 1.1GHz Retina MacBooks on sale for up...
Amazon has 2016 12″ 1.1GHz/256GB Retina MacBooks on sale for up to $100 off MSRP including free shipping: - 12″ 1.1GHz Space Gray Retina MacBook: $1199 $100 off MSRP - 12″ 1.1GHz Silver Retina... Read more
Bare Bones Software Releases Free TextWrangle...
Bare Bones Software has announced the release and immediate availability of TextWrangler 5.5, a significant update to its powerful, free, general purpose text editor for Mac OS X. TextWrangler is a... Read more
Apple’s 2016 Back to School promotion: Free B...
Purchase a new Mac or iPad using Apple’s Education Store and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free, and... Read more
Apple refurbished iPad Air 2s available start...
Apple has Certified Refurbished iPad Air 2 available starting at $339. Apple’s one-year warranty is included with each model, and shipping is free: - 128GB Wi-Fi iPad Air 2: $499 - 64GB Wi-Fi iPad... Read more

Jobs Board

*Apple* Solutions Consultant - APPLE (United...
Job Summary As an Apple Solutions Consultant, you'll be the link between our future customers and our products. You'll showcase your entrepreneurial spirit as you Read more
Lead *Apple* Solutions Consultant - APPLE (...
Job Summary The Lead ASC is an Apple employee who serves as the Apple business manager and influencer across a number of Reseller locations. The Lead ASC's role Read more
*Apple* Retail - Multiple Positions, Charles...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions, Willow...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Evangelist - JAMF Software (United S...
The Apple Evangelist is responsible for building and cultivating strategic relationships with Apple 's small and mid-market business development field teams. This Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.