Changeset 702 for trunk/LogicMail/src/org/logicprobe

Timestamp:

09/06/10 14:45:51 (17 months ago)

Author:

octorian

Message:

Moved screen update batch logic into AbstractScreenProvider

Location:

trunk/LogicMail/src/org/logicprobe/LogicMail

Files:

• mail/AbstractIncomingMailClient.java (modified) (1 diff)
• mail/IncomingMailClient.java (modified) (1 diff)
• mail/IncomingMailConnectionHandler.java (modified) (6 diffs)
• mail/imap/ImapClient.java (modified) (1 diff)
• mail/pop/PopClient.java (modified) (1 diff)
• model/MailboxNode.java (modified) (3 diffs)
• ui/AbstractScreenProvider.java (modified) (4 diffs)
• ui/CompositionScreen.java (modified) (2 diffs)
• ui/MailHomeScreen.java (modified) (2 diffs)
• ui/MailboxScreen.java (modified) (5 diffs)

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/AbstractIncomingMailClient.java

@@ -141 +141 @@
         return false;
     }
-    
-    public int getFolderMessageUpdateFrequency() {
-        return 10;
-    }
 }

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/IncomingMailClient.java

@@ -301 +301 @@
     
     /**
-     * Gets the frequency with which folder message updates should be passed
-     * to higher levels of the application.  This value should be a best guess
-     * based on how long it takes to receive and parse incoming folder message
-     * data.
-     * 
-     * @return Recommended folder message update frequency
-     */
-    int getFolderMessageUpdateFrequency();
-    
-    /**
      * Get a particular message from the selected folder.
      * <p>

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/IncomingMailConnectionHandler.java

@@ -303 +303 @@
 
     private static class GetFolderMessageCallback implements FolderMessageCallback {
-        private int maxCount;
         private int type;
         private FolderTreeItem folder;
@@ -309 +308 @@
         private Object tag;
         private Object param;
-        private FolderMessage[] folderMessages;
-        private int count;
-
-        public GetFolderMessageCallback(int maxCount, int type, FolderTreeItem folder, MailConnectionHandlerListener listener, Object tag) {
-            this(maxCount, type, folder, listener, null, tag);
-        }
-
-        public GetFolderMessageCallback(int maxCount, int type, FolderTreeItem folder, MailConnectionHandlerListener listener, Object param, Object tag) {
-            this.maxCount = maxCount;
+
+        public GetFolderMessageCallback(int type, FolderTreeItem folder, MailConnectionHandlerListener listener, Object tag) {
+            this(type, folder, listener, null, tag);
+        }
+
+        public GetFolderMessageCallback(int type, FolderTreeItem folder, MailConnectionHandlerListener listener, Object param, Object tag) {
             this.type = type;
             this.folder = folder;
@@ -323 +319 @@
             this.param = param;
             this.tag = tag;
-            this.count = 0;
         }
 
         public void folderMessageUpdate(FolderMessage folderMessage) {
-            FolderMessage[] resultMessages = null;
-            synchronized(this) {
+            if(listener != null) {
                 if(folderMessage != null) {
-                    if(count == 0) {
-                        folderMessages = new FolderMessage[maxCount];
-                    }
-                    folderMessages[count++] = folderMessage;
-                }
-
-                if(count == maxCount) {
-                    resultMessages = folderMessages;
-                    folderMessages = null;
-                    count = 0;
-                }
-                else if(folderMessage == null) {
-                    resultMessages = new FolderMessage[count];
-                    for(int i=0; i<count; i++) {
-                        resultMessages[i] = folderMessages[i];
-                    }
-                    folderMessages = null;
-                    count = 0;
-                }
-            }
-
-            if(listener != null) {
-                if(resultMessages != null) {
                     if(param == null) {
-                        listener.mailConnectionRequestComplete(type, new Object[] { folder, resultMessages }, tag);
+                        listener.mailConnectionRequestComplete(type, new Object[] { folder, new FolderMessage[] { folderMessage } }, tag);
                     }
                     else {
-                        listener.mailConnectionRequestComplete(type, new Object[] { folder, resultMessages, param }, tag);
-                    }
-                }
-
-                // If this is the last update of the sequence, make sure we notify
-                // the listener with a null array so it knows we are done.
-                if(folderMessage == null) {
+                        listener.mailConnectionRequestComplete(type, new Object[] { folder, new FolderMessage[] { folderMessage }, param }, tag);
+                    }
+                }
+                else {
+                    // If this is the last update of the sequence, make sure we
+                    // notify the listener with a null array so it knows we are done.
                     if(param == null) {
                         listener.mailConnectionRequestComplete(type, new Object[] { folder, null }, tag);
@@ -383 +353 @@
                 firstIndex, lastIndex,
                 new GetFolderMessageCallback(
-                        incomingClient.getFolderMessageUpdateFrequency(),
                         REQUEST_FOLDER_MESSAGES_RANGE,
                         folder,
@@ -398 +367 @@
                 messageTokens,
                 new GetFolderMessageCallback(
-                        incomingClient.getFolderMessageUpdateFrequency(),
                         REQUEST_FOLDER_MESSAGES_SET,
                         folder,
@@ -413 +381 @@
                 flagsOnly,
                 new GetFolderMessageCallback(
-                        incomingClient.getFolderMessageUpdateFrequency(),
                         REQUEST_FOLDER_MESSAGES_RECENT,
                         folder,

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/imap/ImapClient.java

@@ -853 +853 @@
 
     /* (non-Javadoc)
-     * @see org.logicprobe.LogicMail.mail.IncomingMailClient#getFolderMessageUpdateFrequency()
-     */
-    public int getFolderMessageUpdateFrequency() {
-        return 5;
-    }
-    
-    /* (non-Javadoc)
      * @see org.logicprobe.LogicMail.mail.IncomingMailClient#getMessage(org.logicprobe.LogicMail.mail.MessageToken, org.logicprobe.LogicMail.mail.MailProgressHandler)
      */

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/pop/PopClient.java

@@ -396 +396 @@
 
     /* (non-Javadoc)
-     * @see org.logicprobe.LogicMail.mail.IncomingMailClient#getFolderMessageUpdateFrequency()
-     */
-    public int getFolderMessageUpdateFrequency() {
-        return 2;
-    }
-    
-    /* (non-Javadoc)
      * @see org.logicprobe.LogicMail.mail.IncomingMailClient#getMessage(org.logicprobe.LogicMail.mail.MessageToken, org.logicprobe.LogicMail.mail.MailProgressHandler)
      */

trunk/LogicMail/src/org/logicprobe/LogicMail/model/MailboxNode.java

@@ -1071 +1071 @@
     
     private class RefreshMessagesThread extends Thread implements MessageNodeCallback {
-        private Vector messagesToAdd = new Vector();
-        
         public RefreshMessagesThread() {
             
@@ -1081 +1079 @@
             try {
                 MailFileManager.getInstance().readMessageNodes(MailboxNode.this, this);
-                addLoadedMessages();
                 
                 // If the server fetch completed before the cache load, then
@@ -1129 +1126 @@
                     }
                 }
-                messagesToAdd.addElement(messageNode);
-                if(messagesToAdd.size() == 4) {
-                    addLoadedMessages();
-                }
-            }
-        }
-        
-        private void addLoadedMessages() {
-            int size = messagesToAdd.size();
-            if(size == 0) { return; }
-            
-            MessageNode[] messageArray = new MessageNode[size];
-            messagesToAdd.copyInto(messageArray);
-            messagesToAdd.removeAllElements();
-            MailboxNode.this.addMessages(messageArray);
+                MailboxNode.this.addMessage(messageNode);
+            }
         }
     }

trunk/LogicMail/src/org/logicprobe/LogicMail/ui/AbstractScreenProvider.java

@@ -31 +31 @@
 package org.logicprobe.LogicMail.ui;
 
+import java.util.Vector;
+
 import net.rim.device.api.i18n.ResourceBundle;
 
@@ -36 +38 @@
 
 import net.rim.device.api.ui.Screen;
+import net.rim.device.api.ui.UiApplication;
 import net.rim.device.api.ui.component.Menu;
 
@@ -47 +50 @@
     protected Screen screen;
         private StandardScreen standardScreen;
+    private final Object invokeLock = new Object();
+        private Vector invokeItems = new Vector();
+        private boolean invokeInProgress = false;
         
         /* (non-Javadoc)
@@ -153 +159 @@
         public void shortcutAction(ShortcutItem item) {
         }
+        
+        /**
+         * Puts the runnable object within this screen's UI event queue, so that it
+         * is run on the application's UI event queue.  This intermediate queue is
+         * necessary to prevent the event thread from filling up with items in
+         * cases where the screen experiences a lot of updates.
+         *
+         * @param runnable the runnable object
+         */
+        public void invokeLater(Runnable runnable) {
+            synchronized(invokeLock) {
+                invokeItems.addElement(runnable);
+                if(!invokeInProgress) {
+                    invokeInProgress = true;
+                    UiApplication.getUiApplication().invokeLater(invokeLaterRunnable);
+                }
+            }
+        }
+        
+        private final Runnable invokeLaterRunnable = new Runnable() {
+        public void run() {
+            Vector currentInvokeItems;
+            synchronized(invokeLock) {
+                currentInvokeItems = invokeItems;
+                invokeItems = new Vector();
+            }
+            int size = currentInvokeItems.size();
+            for(int i=0; i<size; i++) {
+                Runnable runnable = (Runnable)currentInvokeItems.elementAt(i);
+                runnable.run();
+            }
+            synchronized(invokeLock) {
+                invokeInProgress = false;
+            }
+        }
+        };
 }

trunk/LogicMail/src/org/logicprobe/LogicMail/ui/CompositionScreen.java

@@ -48 +48 @@
 import net.rim.device.api.ui.MenuItem;
 import net.rim.device.api.ui.Screen;
-import net.rim.device.api.ui.UiApplication;
 import net.rim.device.api.ui.component.AutoTextEditField;
 import net.rim.device.api.ui.component.Dialog;
@@ -223 +222 @@
 
             // Schedule the UI update
-            UiApplication.getUiApplication().invokeLater(new EventObjectRunnable(e) {
+            invokeLater(new EventObjectRunnable(e) {
                 public void run() {
                     MessageNode messageNode = (MessageNode)getEvent().getSource();

trunk/LogicMail/src/org/logicprobe/LogicMail/ui/MailHomeScreen.java

@@ -408 +408 @@
     }
 
-    public void populateMailTree(MailHomeTreeNode rootNode) {
-        synchronized(UiApplication.getEventLock()) {
-            // Clear any existing nodes
-            treeField.deleteAll();
-            nodeIdMap.clear();
-
-            // Freshly populate the tree
-            int firstNode = -1;
-            MailHomeTreeNode[] nodes = rootNode.children;
-            if(nodes != null) {
-                for(int i = nodes.length - 1; i >= 0; --i) {
-                    int id = treeField.addChildNode(0, nodes[i]);
-                    nodeIdMap.put(nodes[i], id);
-                    if(i == 0) { firstNode = id; }
-                    populateMailTreeChildren(id, nodes[i]);
-                }
-            }
-            if(firstNode != -1) {
-                treeField.setCurrentNode(firstNode);
-            }
-        }
+    public void populateMailTree(final MailHomeTreeNode rootNode) {
+        UiApplication.getUiApplication().invokeAndWait(new Runnable() {
+            public void run() {
+                // Clear any existing nodes
+                treeField.deleteAll();
+                nodeIdMap.clear();
+
+                // Freshly populate the tree
+                int firstNode = -1;
+                MailHomeTreeNode[] nodes = rootNode.children;
+                if(nodes != null) {
+                    for(int i = nodes.length - 1; i >= 0; --i) {
+                        int id = treeField.addChildNode(0, nodes[i]);
+                        nodeIdMap.put(nodes[i], id);
+                        if(i == 0) { firstNode = id; }
+                        populateMailTreeChildren(id, nodes[i]);
+                    }
+                }
+                if(firstNode != -1) {
+                    treeField.setCurrentNode(firstNode);
+                }
+            }
+        });
     }
 
@@ -444 +446 @@
         final int nodeId = nodeIdMap.get(node);
         if(nodeId != -1) {
-            UiApplication.getUiApplication().invokeLater(new Runnable() {
+            invokeLater(new Runnable() {
                 public void run() {
                     treeField.invalidateNode(nodeId);

trunk/LogicMail/src/org/logicprobe/LogicMail/ui/MailboxScreen.java

@@ -47 +47 @@
 import net.rim.device.api.ui.component.Menu;
 import net.rim.device.api.ui.container.VerticalFieldManager;
-import net.rim.device.api.ui.UiApplication;
 import net.rim.device.api.util.Comparator;
 import net.rim.device.api.util.DateTimeUtilities;
@@ -121 +120 @@
             if((e.getGlobalChange() & GlobalConfig.CHANGE_TYPE_OTHER) != 0) {
                 if(globalConfig.getDispOrder() != displayOrder) {
-                    UiApplication.getUiApplication().invokeLater(new EventObjectRunnable(e) {
+                    invokeLater(new EventObjectRunnable(e) {
                         public void run() {
                             displayOrder = !displayOrder;
@@ -129 +128 @@
                 }
                 if(globalConfig.getHideDeletedMsg() != hideDeleted) {
-                    UiApplication.getUiApplication().invokeLater(new EventObjectRunnable(e) {
+                    invokeLater(new EventObjectRunnable(e) {
                         public void run() {
                             hideDeleted = !hideDeleted;
@@ -143 +142 @@
     private MailboxNodeListener mailboxNodeListener = new MailboxNodeListener() {
                 public void mailboxStatusChanged(MailboxNodeEvent e) {
-                        UiApplication.getUiApplication().invokeLater(new EventObjectRunnable(e) {
+                        invokeLater(new EventObjectRunnable(e) {
                                 public void run() {
                                         mailboxNode_MailboxStatusChanged((MailboxNodeEvent)getEvent());
@@ -154 +153 @@
     private MessageNodeListener messageNodeListener = new MessageNodeListener() {
                 public void messageStatusChanged(MessageNodeEvent e) {
-                        UiApplication.getUiApplication().invokeLater(new EventObjectRunnable(e) {
+                        invokeLater(new EventObjectRunnable(e) {
                                 public void run() {
                                         messageNode_MessageStatusChanged((MessageNodeEvent)getEvent());