Skip to main content

Does the Rx subscriber get disposed when OnCompleted is called?

We use an implementation of an observable command - ObservableCommand<T> in our view models not only to wire the actions of controls defined in the XAML but to allow the other interested parties to be notified when the command has executed.

We were wondering what happens when the observable command is disposed, does the OnCompleted method for the subscribers get called and importantly are the subscribers disposed?

Our observable command has an implementation similar to this:

   1:   
   2:  public class ObservableCommand<T> : ICommand, IObservable<T>
   3:  {
   4:      private readonly Subject<T> _subj = new Subject<T>();
   5:   
   6:      public void Execute(object parameter)
   7:      {
   8:          _subj.OnNext((T)parameter);
   9:      }
  10:   
  11:      public bool CanExecute(object parameter)
  12:      {
  13:          return true;
  14:      }
  15:   
  16:      public event EventHandler CanExecuteChanged;
  17:   
  18:      public IDisposable Subscribe(IObserver<T> observer)
  19:      {
  20:          return _subj.Subscribe(observer);
  21:      }
  22:  }

To test question I used a simple class which generates numbers, this exposes 2 methods one to set up a subscription and the other to shut down the under lying stream, this wouldn't be any good for 'real' code but will do for a test:

   1:  public class NumberGenerator
   2:  {
   3:      private readonly TimeSpan _interval = TimeSpan.FromMilliseconds(500);
   4:      private IObserver<int> _stream;
   5:   
   6:      public IObservable<int> Generate()
   7:      {
   8:          var number = 42;
   9:   
  10:          return Observable.Create<int>(o =>
  11:          {
  12:              _stream = o;
  13:              return Observable.Timer(DateTime.Now.Add(_interval), _interval)
  14:              .Subscribe(l =>
  15:              {
  16:                  var currentNumber = number;
  17:                  number = number + 1;
  18:   
  19:                  _stream.OnNext(currentNumber);
  20:              });
  21:          });
  22:      }
  23:   
  24:      public void Complete()
  25:      {
  26:          _stream.OnCompleted();
  27:      }
  28:  }

This was then tested with following program, notice I pass in an Action<T> for the completed action to the Subscribe method:

   1:  internal class Program
   2:  {
   3:      private IObservable<long> _underlying;
   4:   
   5:      private static void Main(string[] args)
   6:      {
   7:          var generator = new NumberGenerator();
   8:   
   9:          var disposable = generator.Generate()
  10:              .Subscribe(n => Console.WriteLine("Number: " + n), () => Console.WriteLine("Completed..."));
  11:   
  12:          Console.ReadLine();
  13:   
  14:          generator.Complete();
  15:   
  16:          Console.ReadLine();
  17:      }
  18:  }

It sets up a subscription on a background thread, the generator then starts producing values every couple of seconds (on another background thread). These are recieved and outputted to the console. Whilst this is happening the main thread is blocked by the first call Console.ReadLine method. Once the enter key is pressed the the internal under lying stream in the generator is shut down and hopefully the OnCompleted method will be called for the subscriber and output "Completed..."

Did OnCompleted get called?

Yes...

So the title question is 'Does the Rx subscriber get disposed when OnComplete is called?'

Yes...

To check this lets look inside the returned IDisposable for the test program:
Debugging the app with a breakpoint on the second Console.ReadLine method, you can see the disposable local variable has been disposed:

So when the under lying stream in Rx is shutdown then all of the subscribers will have their OnCompleted methods called and will be disposed of automatically - perfect!

Comments

Popular posts from this blog

WPF tips & tricks: Dispatcher thread performance

Not blogged for an age, and I received an email last week which provoked me back to life. It was a job spec for a WPF contract where they want help sorting out the performance of their app especially around grids and tabular data. I thought I'd shared some tips & tricks I've picked up along the way, these aren't probably going to solve any issues you might be having directly, but they might point you in the right direction when trying to find and resolve performance issues with a WPF app. First off, performance is something you shouldn't try and improve without evidence, and this means having evidence proving you've improved the performance - before & after metrics for example. Without this you're basically pissing into the wind, which can be fun from a developer point of view but bad for a project :) So, what do I mean by ' Dispatcher thread performance '? The 'dispatcher thread' or the 'UI thread' is probably the most

Showing a message box from a ViewModel in MVVM

I was doing a code review with a client last week for a WPF app using MVVM and they asked ' How can I show a message from the ViewModel? '. What follows is how I would (and have) solved the problem in the past. When I hear the words ' show a message... ' I instantly think you mean show a transient modal message box that requires the user input before continuing ' with something else ' - once the user has interacted with the message box it will disappear. The following solution only applies to this scenario. The first solution is the easiest but is very wrong from a separation perspective. It violates the ideas behind the Model-View-Controller pattern because it places View concerns inside the ViewModel - the ViewModel now knows about the type of the View and specifically it knows how to show a message box window: The second approach addresses this concern by introducing the idea of messaging\events between the ViewModel and the View. In the example below

Implementing a busy indicator using a visual overlay in MVVM

This is a technique we use at work to lock the UI whilst some long running process is happening - preventing the user clicking on stuff whilst it's retrieving or rendering data. Now we could have done this by launching a child dialog window but that feels rather out of date and clumsy, we wanted a more modern pattern similar to the way <div> overlays are done on the web. Imagine we have the following simple WPF app and when 'Click' is pressed a busy waiting overlay is shown for the duration entered into the text box. What I'm interested in here is not the actual UI element of the busy indicator but how I go about getting this to show & hide from when using MVVM. The actual UI elements are the standard Busy Indicator coming from the WPF Toolkit : The XAML behind this window is very simple, the important part is the ViewHost. As you can see the ViewHost uses a ContentPresenter element which is bound to the view model, IMainViewModel, it contains 3 child v