/*********************************************************************/
/*                                                                   */
/*                     AgentService Framework                        */
/*                       www.agentservice.it                         */
/*                                                                   */
/* Copyright (C) 2007 l.i.d.o. - DIST, University of Genoa, Italy    */
/* GNU Lesser General Public License                                 */
/*                                                                   */
/* This library is free software; you can redistribute it and/or     */
/* modify it under the terms of the GNU Lesser General Public        */
/* License as published by the Free Software Foundation,             */
/* version 2.1 of the License.                                       */
/*                                                                   */
/* This library 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 */
/* Lesser General Public License for more details.                   */
/*                                                                   */
/* You should have received a copy of the GNU Lesser General Public  */
/* License along with this library; if not, write to the             */
/* Free Software Foundation, Inc., 59 Temple Place - Suite 330,      */
/* Boston, MA  02111-1307, USA.                                      */
/*                                                                   */
/*********************************************************************/
using System;

namespace AgentService.Agent.Behaviour
{
	/// <summary>
	/// The delegate that manages the abort event
	/// </summary>
	public delegate void BehaviourThreadDelegate(); 
	
	/// <summary>
	/// BehaviourThreadUnit class. Thread class internally used by the behaviour object to manage threads created whithin behaviour objects
	/// </summary>
	[Serializable]
	public class BehaviourThreadUnit
	{
		/// <summary>
		/// The thread managed object 
		/// </summary>
		System.Threading.Thread thread;

		/// <summary>
		/// The event thrown by the Thread.Abort() operation
		/// </summary>
		public event BehaviourThreadDelegate AbortEvent;

		/// <summary>
		/// Constructs a BehaviourThreadUnit object with the ThreadStart delegate and a finalize delegate invoked with the abort event
		/// </summary>
		/// <param name="target">the method that will execute on the Thread</param>
		/// <param name="finalize">the method that will be called when the thread terminates</param>
		public BehaviourThreadUnit(System.Threading.ThreadStart target, BehaviourThreadDelegate finalize)
		{
			this.thread = new System.Threading.Thread(target);
			this.thread.Start();
			if (finalize != null)
			{
				this.AbortEvent += finalize;
			}
		}

		/// <summary>
		/// Terminates the thread's activity and calls all the handlers registered for the finalization
		/// </summary>
		public void Finalize() 
		{
			if (this.AbortEvent != null)
			{
				this.AbortEvent();
			}
			this.thread.Abort();
		}

		/// <summary>
		/// Blocks the calling thread until the hosted thread
		/// finishes.
		/// </summary>
		public void Join() 
		{
			this.thread.Join();
		}
	}
}