CloseTask.hpp

/*
Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico

This file is part of MeRMaID.

MeRMaID 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, either version 3 of the License, or
(at your option) any later version.

MeRMaID 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 MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
*/



#ifndef _CLOSE_TASK_HPP_
#define _CLOSE_TASK_HPP_

#include <Task.hpp>

#include "IOThread.hpp"

namespace mermaid
{
  namespace support
  {
    namespace io
    {
    
      using mermaid::support::activeobject::Task;
      using boost::shared_ptr;
      
      /**
       * @Class CloseTask CloseTask.hpp "CloseTask.hpp"
       * @Description CloseTask class
       *
       * This is the task which closes a file descriptor
       * @Author Joao Carreira
       */
      class CloseTask : public Task
      {
        public:
        
          /**
           * @Description Constructor.
           *
           * @Argument ioThread The IOThread instance which runs the tasks and holds the StreamHandler
           * @Argument fileDescriptor The file descriptor to be closed
           * @Argument writeEnabled Tells if there is a streamWriter to be erased
           * @Argument readEnabled Tells if there is a streamReader to be erased
           * @Author Joao Carreira
           */
          CloseTask (IOThread* ioThread, int fileDescriptor, bool writeEnabled, bool readEnabled);
          
          /**
           * @Description Run the task
           *
           * Close the file descriptor
           * @Author Joao Carreira
           */
          virtual void run();
          
          /**
           * @Description Destructor.
           * @Author Joao Carreira
           */
          virtual ~CloseTask();
          
        private:
          IOThread* const ioThread_;
          int fileDescriptor_;
          
          bool writeEnabled_;
          bool readEnabled_;
          
      }; // class CloseTask
      
    } // namespace io
  } // namespace support
} // namespace mermaid

#endif //_CLOSE_TASK_HPP_