Skip to main content

[Code refactoring] Releasing resources that you still need

Let’s look over the following code and see if we can find the bug. When the Callback method is called, the _callbackAction field is null all the time (except 2-3 exception).
public class FooReader: IDisposable
{
  private ExternalComResource _externalResource;

  private Action<Foo> _callbackAction;
  
  public void Start(Action<Foo> callbackAction)
  {            
    lock (this)
    {
      _callbackAction = callbackAction;                               

      _externalResource = new ExternalComResource();
      ...
      _externalResource.Callback += Callback;
      _externalResource.Start(1);      
    }
  }
  
  public void Stop()
  {
    StopAndReleaseResources();
  }

  private void Callback(object source, EventArgs e)
  {
    ...
    StopCapture();            
    ...
    if (_callbackAction != null)
    {
      _callbackAction.Invoke(someData);
    }
    ...
  }       

  public void Dispose()
  {
    StopAndReleaseResources();
  }

  private void StopAndReleaseResources()
  {
    if (_externalResource != null)
    {
      lock (this)
      {
        if (_externalResource != null)
        {
          _externalResource.Stop();
          _externalResource.Dispose();
          _externalResource = null;
          _callbackAction = null;
        }
      }
    }
  }
}
Did you spotted the problem?
Well, the root cause of the problem is ‘Stop’ method. If we look closely you will see that the callback field is set to NULL when the results comes.
This is the kind of bug where you can spend 2-3 hours, trying to understand why you cannot access local fields from other thread, looking over AppDomain, MarshalByRefObject and what the hell is panning.
What you should never do: You should never use the action that is executed in the Dispose in other method because you know that resources are disposed. You could dispose more than you want.
The code should look like this this (but we still use the 'Dispose' method for Stop):
public class FooReader: IDisposable
{
  private ExternalComResource _externalResource;

  private Action<Foo> _callbackAction;
  
  public void Start(Action<Foo> callbackAction)
  {            
    lock (this)
    {
      _callbackAction = callbackAction;                               

      _externalResource = new ExternalComResource();
      ...
      _externalResource.Callback += Callback;
      _externalResource.Start(1);      
    }
  }
  
  public void Stop()
  {
    StopAndReleaseResources();
  }

  private void Callback(object source, EventArgs e)
  {
    ...
    StopCapture();            
    ...
    if (_callbackAction != null)
    {
      _callbackAction.Invoke(someData);
    }
    ...
  }       

  public void Dispose()
  {
    StopAndReleaseResources();
  }

  private void StopAndReleaseResources()
  {
    if (_externalResource != null)
    {
      lock (this)
      {
        if (_externalResource != null)
        {
          _externalResource.Stop();
          _externalResource.Dispose();
          _externalResource = null;  
          //_callbackAction = null;        
        }
      }
    }
  }
}

Comments

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(...

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine: threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration: TeamCity .NET 4.51 EF 6.0.2 VS2013 It see...

Navigating Cloud Strategy after Azure Central US Region Outage

 Looking back, July 19, 2024, was challenging for customers using Microsoft Azure or Windows machines. Two major outages affected customers using CrowdStrike Falcon or Microsoft Azure computation resources in the Central US. These two outages affected many people and put many businesses on pause for a few hours or even days. The overlap of these two issues was a nightmare for travellers. In addition to blue screens in the airport terminals, they could not get additional information from the airport website, airline personnel, or the support line because they were affected by the outage in the Central US region or the CrowdStrike outage.   But what happened in reality? A faulty CrowdStrike update affected Windows computers globally, from airports and healthcare to small businesses, affecting over 8.5m computers. Even if the Falson Sensor software defect was identified and a fix deployed shortly after, the recovery took longer. In parallel with CrowdStrike, Microsoft provi...