StreamHandler.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 _STREAMHANDLER_HPP_
#define _STREAMHANDLER_HPP_

#include "StreamReader.hpp"
#include "StreamWriter.hpp"
#include <ace/Asynch_IO.h>

#include <map>

namespace mermaid
{
  namespace support
  {
    namespace io
    {
    
      using boost::shared_ptr;
      using std::map;
      
      /**
       * @Class StreamHandler StreamHandler.hpp "StreamHandler.hpp"
       * @Description StreamHandler class
       *
       * The class which handles the events from ACE_Proactor
       * @Author Joao Carreira
       */
      class StreamHandler : public ACE_Handler
      {
        public:
        
          /**
           * @Description Associate a file descriptor with a StreamReader
           *
           * @Argument fileDescriptor File descriptor to be associated
           * @Argument streamReader StreamReader to be associated
           * @Author Joao Carreira
           */
          virtual void associateFileDescriptorWithStreamReader (int fileDescriptor, shared_ptr<StreamReader> streamReader);
          
          /**
           * @Description Associate a file descriptor with a StreamWriter
           *
           * @Argument fileDescriptor File descriptor to be associated
           * @Argument streamWriter StreamWriter to be associated
           * @Author Joao Carreira
           */
          virtual void associateFileDescriptorWithStreamWriter (int fileDescriptor, shared_ptr<StreamWriter> streamWriter);
          
          /**
           * @Description Get the StreamWriter associated with a given file descriptor
           *
           * @Argument fileDescriptor The file descriptor which is associated with a StreamWriter
           * @Returns The StreamWriter associated with the given file descriptor
           * @Author Joao Carreira
           */
          virtual shared_ptr<StreamWriter> getAssociatedStreamWriter (int fileDescriptor);
          
          /**
           * @Description Close the StreamWriter associated with this file descriptor
           *
           * @Argument fileDescriptor The file descriptor which is associated with the StreamWriter to be closed
           * @Author Joao Carreira
           */
          virtual void closeStreamWriter (int fileDescriptor);
          
          /**
           * @Description Close the StreamReader associated with this file descriptor
           *
           * @Argument fileDescriptor The file descriptor which is associated with the StreamReader to be closed
           * @Author Joao Carreira
           */
          virtual void closeStreamReader (int fileDescriptor);
          
          /**
           * @Description Handles read operations events
           *
           * @Argument result The result of an io operation
           * @Author Joao Carreira
           */
          virtual void handle_read_stream (const ACE_Asynch_Read_Stream::Result &result);
          
          /**
           * @Description Handles write operations events
           *
           * @Argument result The result of an io operation
           * @Author Joao Carreira
           */
          virtual void handle_write_stream (const ACE_Asynch_Write_Stream::Result &result);
          
          /**
           * @Description Destructor
           * @Author Joao Carreira
           */
          virtual ~StreamHandler();
          
        protected:
          map<int, shared_ptr<StreamReader> > streamReaderMap_;
          map<int, shared_ptr<StreamWriter> > streamWriterMap_;
          
      }; // class StreamHandler
      
    } // namespace io
  } // namespace support
} // namespace mermaid

#endif //_STREAMHANDLER_HPP_