source: branches/HeuristicLab.Hive-3.4/sources/HeuristicLab.Clients.Hive/3.4/ExperimentManager/JobResultPoller.cs @ 6111

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2010 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.Threading;
using HeuristicLab.Common;

namespace HeuristicLab.Clients.Hive {
  public class JobResultPoller {
    private bool stopRequested { get; set; }
    private AutoResetEvent waitHandle;
    private Thread thread;

    private Guid hiveExperimentId;
    public Guid HiveExperimentId {
      get { return hiveExperimentId; }
      set { hiveExperimentId = value; }
    }

    private TimeSpan interval;
    public TimeSpan Interval {
      get { return interval; }
      set { interval = value; }
    }

    private bool isPolling;
    public bool IsPolling {
      get { return isPolling; }
      set {
        if (isPolling != value) {
          isPolling = value;
          OnIsPollingChanged();
        }
      }
    }

    public JobResultPoller(Guid hiveExperimentId, TimeSpan interval) {
      this.isPolling = false;
      this.hiveExperimentId = hiveExperimentId;
      this.interval = interval;
    }

    public void Start() {
      stopRequested = false;
      thread = new Thread(RunPolling);
      thread.Start();
      IsPolling = true;
    }

    public void Stop() {
      // use AutoResetEvent.Set instead if Thread.Interrupt because its much cleaner
      stopRequested = true;
      waitHandle.Set();
      IsPolling = false;
      thread = null;
    }

    private void RunPolling() {
      try {
        waitHandle = new AutoResetEvent(false);
        while (!stopRequested) {
          OnPollingStarted();
          FetchJobResults();
          OnPollingFinished();
          waitHandle.WaitOne(Interval);
        }
        waitHandle.Close();
      }
      catch (Exception e) {
        OnExceptionOccured(e);
      }
      finally {
        IsPolling = false;
      }
    }

    public IEnumerable<LightweightJob> FetchJobResults() {
      return ServiceLocator.Instance.CallHiveService(service => {
        var responses = new List<LightweightJob>();
        responses.AddRange(service.GetLightweightExperimentJobs(hiveExperimentId));
        OnJobResultsReceived(responses);
        return responses;
      });
    }

    public event EventHandler<EventArgs<IEnumerable<LightweightJob>>> JobResultsReceived;
    private void OnJobResultsReceived(IEnumerable<LightweightJob> lightweightJobs) {
      var handler = JobResultsReceived;
      if (handler != null) handler(this, new EventArgs<IEnumerable<LightweightJob>>(lightweightJobs));
    }

    public event EventHandler<EventArgs<Exception>> ExceptionOccured;
    private void OnExceptionOccured(Exception e) {
      var handler = ExceptionOccured;
      if (handler != null) handler(this, new EventArgs<Exception>(e));
    }

    public event EventHandler IsPollingChanged;
    private void OnIsPollingChanged() {
      var handler = IsPollingChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }
    public event EventHandler PollingStarted;
    private void OnPollingStarted() {
      var handler = PollingStarted;
      if (handler != null) handler(this, EventArgs.Empty);
    }
    public event EventHandler PollingFinished;
    private void OnPollingFinished() {
      var handler = PollingFinished;
      if (handler != null) handler(this, EventArgs.Empty);
    }
  }
}