Lapsed-listeners – Memory leaks in subscriber-publisher scenarios

I’ve been promising something .NET related for a while… here’s something!

The lapsed-listener scenario

There exists a ‘gotcha’ in .NET (and other programming environment) whereby an object has subscribed to another objects published event will not be garbage collected when you expect because the environment itself holds a reference to the subscriber inside the event notification system.

Let’s illustrate with an example:

MyBusiness Class

Encapsulates some aspect of business functionality and publishes a Changed event.

MyTreeNode Business Adapter Class

Inherits from TreeNode and takes an instance of MyBusiness in the constructor. The object signs up to the Changed event of the MyBusiness object so that it can always accurately show the correct Icon (via ImageIndex), Text and update any associated child nodes etc.

Now you happily add instances of MyTreeNodeBusinessAdapter class to your TreeView, each with the associated MyBusiness instance it should be reflecting.

The problem now arises in that if the TreeNode is removed from the TreeView with either Nodes.Remove or Nodes.Clear then the garbage collector will not be able dispose of the MyTreeNodeBusinessAdapter objects because the MyBusiness objects hold a reference to them in their event notification queues. Even worse, an inactive TreeView hangs around because the not-yet-disposed TreeNode’s are still pointing to it.

Possible solutions…

.NET Framework 3.0 has a WeakEvent pattern to make things simple!

1. MyTreeNodeBusinessAdapter listens in to TreeView events and un-subscribes when it is removed (Rejected)

TreeNode’s maintain their own internal array of child nodes which they publish under the “Nodes” property which uses the TreeNodeCollection class to just point straight back at itself calling internal methods. None are over-ridable and while they do send the message TVM_DELETEITEM to their own TreeView control it does nothing with them nor does it have methods you could implement in a subclass. (.NET Reflector is great for finding out what’s going on inside the WinForms assembly)

This would also mean every UI control you adapt would need sub-classing to override even if you could hook into the remove events.

2. Weak Events

Xavier Musy’s web log has an interesting C# class called WeakMulticastDelegate that works in a similar way to normal delegates but uses the WeakReference class in .NET to allow referencing an object that can be garbage collected.

This solution also prevents subscribers from subscribing more than once and also from subscribers throwing an exception that stops other subscribers receiving this event (in .NET an exception will break the chain).

Alas it requires that you publish an event by writing Add and Remove methods for your event — not possible directly under VB.NET but possible with the following workaround:

1. Create a C# Class Library project inside your solution and add the WeakMulticastDelegate code to it (remember to put using System; and using System.Reflection; at the top of the file)
2. Create a new MyPublisherWorkaround class in the C# project with the private WeakMulticastDelegate and public event EventHandler code blocks described in Xavier’s article.
3. In MyPublisherWorkaround create a method to fire your event (because .NET does not let you raise events defined in a parent class) e.g:

   protected internal void Changed(EventArgs e) {
    if (this.weakEventHandler != null) weakEventHandler.Invoke(new object[] { this, e } );
   }```
   

4. Add the new C# project to your VB.NET project reference and appropriate Imports line at the top of your VB.NET project (obviously).
5. Change your MyPublisher class to inherit from MyPublisherWorkaround.
6. Change your MyPublisher class to call the Changed method (or whatever you named it) instead of executing RaiseEvent directly (because of aforementioned restrictions in the .NET framework).

3. Weak Delegates

Greg Schechter on the Microsoft Avalon team has written an article about this very problem and his solution of Weak Delegates.

Our scenario would become:

1. MyPublisher instance receives request to add instance of MySubscriber to event.
2. MyPublisher creates new instance of own internal class derived from WeakReference.
3. This WeakReference instance actually contains the reference to the target object.
4. The WeakReference instance’s event handler (with the same signature) is added to the event listener.

While this works in VB.NET it has a problem in that the class derived from WeakReference requires all subscribers to either be the same class, derived from a common parent or support a specific interface that defines this event handler.

This defeats much of the point of delegates although it might be possible to rework his code so that WeakReference stores a weak reference to the given event handler and not the object implementing it.

Stepping back

WinForms is focused around the Win32 API itself and not what modern applications require from a UI when developing along Model-View-Controller patterns.

Compound controls such as TreeView and ListView should deal with interfaces such as ITreeNode and IListViewItem and then provide a concrete implementation for backwards compatibility/general use (TreeNode and ListViewItem).

This would solve some issues — check out Skybound’s VisualStyles for a free and easy to use fix for the poor theme support.

Check out the WeakEventManager in .NET 3.5 for an event mechanism that is immune to this problem.

[)amien