source: branches/3.3-HiveMigration/sources/HeuristicLab.Hive/HeuristicLab.Hive.Client.ExecutionEngine/3.3/Executor.cs @ 4141

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2008 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 HeuristicLab.Hive.Client.Common;
using HeuristicLab.Hive.Contracts;
using HeuristicLab.Hive.JobBase;
using HeuristicLab.Persistence.Core;
using HeuristicLab.Common;
using System.Xml.Serialization;
using HeuristicLab.Persistence.Default.Xml;
using System.IO;
using HeuristicLab.Core;

namespace HeuristicLab.Hive.Client.ExecutionEngine {
  public class Executor : MarshalByRefObject, IDisposable {
    public Guid JobId { get; set; }
    public IJob Job { get; set; }
    public MessageContainer.MessageType CurrentMessage { get; set; }
    public Exception CurrentException { get; set; }
    public MessageQueue Queue { get; set; }

    public bool JobIsFinished { get; set; }

    public ExecutionState ExecutionState {
      get {
        return Job.ExecutionState;
      }
    }

    public double Progress {
      get {
        return Job.Progress;
      }
    }

    public DateTime CreationTime { get; set; }

    public void Start(byte[] serializedJob) {
      CreationTime = DateTime.Now;
      Job = XmlParser.Deserialize<IJob>(new MemoryStream(serializedJob));

      Job.JobStopped += new EventHandler(Job_JobStopped);
      Job.JobFailed += new EventHandler(Job_JobFailed);
      Job.Start();
    }

    void Job_JobFailed(object sender, EventArgs e) {
      HeuristicLab.Common.EventArgs<Exception> ex = (HeuristicLab.Common.EventArgs<Exception>)e;
      CurrentException = ex.Value;
      Queue.AddMessage(new MessageContainer(MessageContainer.MessageType.FinishedJob, JobId));
    }

    public void StartOnlyJob() {
      Job.Start();
    }

    public void Abort() {
      CurrentMessage = MessageContainer.MessageType.AbortJob;
      Job.Stop();
    }

    void Job_JobStopped(object sender, EventArgs e) {
      if (CurrentMessage == MessageContainer.MessageType.NoMessage) {
        Queue.AddMessage(new MessageContainer(MessageContainer.MessageType.FinishedJob, JobId));
        JobIsFinished = true;
      } else if (CurrentMessage == MessageContainer.MessageType.RequestSnapshot) {
        Queue.AddMessage(new MessageContainer(MessageContainer.MessageType.SnapshotReady, JobId));
      } else if (CurrentMessage == MessageContainer.MessageType.AbortJob) {
        Queue.AddMessage(new MessageContainer(MessageContainer.MessageType.JobAborted, JobId));
      }
    }

    public byte[] GetSnapshot() {
      //if the job is still running, something went VERY bad.
      if (Job.ExecutionState == Core.ExecutionState.Started) {
        return null;
      } else {
        // Clear the Status message
        CurrentMessage = MessageContainer.MessageType.NoMessage;
        // Pack the whole job inside an xml document
        byte[] job = SerializeJobObject();
        // Restart the job
        // Return the Snapshot
        return job;
      }
    }

    public byte[] GetFinishedJob() {
      //Job isn't finished!
      if (Job.ExecutionState == Core.ExecutionState.Started) {
        throw new InvalidStateException("Job is still running");
      } else {
        byte[] jobArr = SerializeJobObject();
        return jobArr;
      }
    }

    public void RequestSnapshot() {
      CurrentMessage = MessageContainer.MessageType.RequestSnapshot;
      Job.Stop();
    }

    private byte[] SerializeJobObject() {
      MemoryStream stream = new MemoryStream();
      XmlGenerator.Serialize(Job, stream);
      return stream.ToArray();
    }

    private void RestoreJobObject(byte[] sjob) {
      Job = XmlParser.Deserialize<IJob>(new MemoryStream(sjob));
    }

    public Executor() {
      CurrentMessage = MessageContainer.MessageType.NoMessage;
      JobIsFinished = false;
      //Job = new TestJob();
    }

    #region IDisposable Members

    public void Dispose() {
      Job.JobFailed -= new EventHandler(Job_JobFailed);
      Job.JobFailed -= new EventHandler(Job_JobStopped);
      Queue = null;
      Job = null;
    }

    #endregion
  }
}