using System;
using Chernobyl.DesignPatterns.Pool;

namespace Chernobyl.Threading.Workers
{
    /// <summary>
    /// An interface for implementing and working with
    /// worker classes.
    /// </summary>
    public interface IWorker
    {
        /// <summary>
        /// Should have the worker begin working on the jobs 
        /// assigned to it.
        /// </summary>
        void Start();

        /// <summary>
        /// Should stop the worker from working and
        /// allow his thread to end.
        /// </summary>
        void Stop();

        /// <summary>
        /// The pool that the worker will pull jobs off
        /// of to work on. The worker is responsible for
        /// pulling getting jobs from the pool, working on 
        /// those jobs, and then giving those jobs back.
        /// </summary>
        IPool<Job> JobPool { get; set; }

        /// <summary>
        /// True if this worker is working, i.e. <see cref="Start()"/> was called
        /// and <see cref="Stop()"/> hasn't been called yet.
        /// </summary>
        bool IsWorking { get; }

        /// <summary>
        /// Gets and sets the name of this worker.
        /// </summary>
        string Name { get; set; }

        /// <summary>
        /// When this worker starts his workday this event is invoked.
        /// </summary>
        event EventHandler OnWorkStart;

        /// <summary>
        /// When this worker ends his workday this event is invoked.
        /// </summary>
        event EventHandler OnWorkEnd;
    }
}