IOThread.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 _IOTHREAD_HPP_
#define _IOTHREAD_HPP_


#include <ActiveObject.hpp>
#include <Task.hpp>
#include <ace/Proactor.h>
#include <vector>
#include <map>

#include "StreamReader.hpp"
#include "StreamWriter.hpp"
#include "StreamHandler.hpp"

namespace mermaid
{
  namespace support
  {
    namespace io
    {
    
      using mermaid::support::io::shared_ptr;
      using mermaid::support::activeobject::ActiveObject;
      using mermaid::support::activeobject::Task;
      
      /**
      * @Class IOThread IOThread.hpp "IOThread.hpp"
      * @Description IOThread class
      *
      * A separate context of execution that 'waits' for device events (read/write operations completed) and handles them.
      * @Author Joao Carreira
      */
      class IOThread
      {
      
          friend class AddStreamReaderTask;
          friend class AddStreamWriterTask;
          friend class CloseTask;
          friend class WriteTask;
          friend class IOThreadUpdateTask;
          
        public:
        
          /**
          * @Description Constructor.
          * @Author Joao Carreira
          */
          IOThread();
          
          /**
          * @Description Add a StreamReader object
          *
          * This method adds a StreamReader object to the IOThread. This turns on reading for the StreamReader's device.
          * @Argument streamReader StreamReader object to add to the IOThread
          * @Author Joao Carreira
          */
          virtual void addStreamReader (shared_ptr<StreamReader> streamReader);
          
          /**
          * @Description Add a StreamWriter object
          *
          * This method adds a StreamWriter object to the IOThread. This makes the StreamWriter's device available to write.
          * @Argument streamWriter StreamWriter object to add to the IOThread
          * @Author Joao Carreira
          */
          virtual void addStreamWriter (shared_ptr<StreamWriter> streamWriter);
          
          /**
           * @Description Creates and adds a WriteTask to be run in the IOThread
           *
           * @Argument fileDescriptor The file descriptor to which the write will be done
           * @Argument bytesToWrite The number of bytes to be written
           * @Argument data The data to be written
          * @Argument streamOperationHandlerWrite The handler which will receive the write reply
           * @Author Joao Carreira
           */
          virtual void addWriteOperation (int fileDescriptor, size_t bytesToWrite, const char* data, shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandlerWrite);
          
          /**
           * @Description Creates and adds a CloseTask to be run in the IOThread
           *
           * @Argument fileDescriptor The file descriptor which will be closed
           * @Author Joao Carreira
           */
          virtual void addCloseOperation (int fileDescriptor, bool writeEnabled, bool readEnabled);
          
          /**
           * @Description Run the event loop
           *
           * This method runs the proactor event loop which handles the io events (read and write replies)
           * @Author Joao Carreira
           */
          virtual void run();
          
          /**
           * @Description ACE_Proactor getter
           *
           * @Returns ACE_Proactor instance
           * @Author Joao Carreira
           */
          virtual ACE_Proactor* getProactor();
          
          /**
           * @Description Active Object getter
           *
           * @Returns The IOThread's active object
           * @Author Joao Carreira
           */
          shared_ptr<ActiveObject> getActiveObject() {
            return activeObject_;
          }
          
          /**
           * @Description Destructor
           * @Author Joao Carreira
           */
          virtual ~IOThread();
        private:
        
          /**
           * @Description Add a taks to the IOThread's active object
           *
           * @Argument task The task to be added
           * @Author Joao Carreira
           */
          void addTask (shared_ptr<Task> task);
          
          const shared_ptr<ActiveObject> activeObject_;
          shared_ptr<StreamHandler> streamHandler_;
          
          ACE_Proactor proactor_;
          
      }; // class IOThread
      
    } // namespace io
  } // namespace support
} // namespace mermaid

#endif // _IOTHREAD_HPP_