StreamReader.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 _STREAM_READER_HPP_
#define _STREAM_READER_HPP_

#include "Device.hpp"
#include <ace/Asynch_IO.h>


namespace mermaid
{
  namespace support
  {
    namespace io
    {
    
      using boost::shared_ptr;
      
      /**
       * @Class StreamReader StreamReader.hpp "StreamReader.hpp"
       * @Description StreamReader class
       *
       * The class which ultimately executes the read operations
       * @Author Joao Carreira
       */
      class StreamReader
      {
        public:
        
          /**
          * @Description Constructor
          *
          * @Argument device The device on which the read operations will be executed
          * @Author Joao Carreira
          */
          StreamReader (Device* device);
          
          /**
           * @Description This method will be called by StreamHandler each time a read event occurs
           *
           * @Argument bytesRead The number of bytes read
           * @Argument requestedBytesRead The number of bytes requested to be read
           * @Argument data The data read from the device
           * @Argument success TRUE if the read operation was successful, FALSE otherwise
           * @Author Joao Carreira
           */
          virtual void onRead (size_t bytesRead, size_t requestedBytesRead, const char* data, bool success);
          
          /**
           * @Description Executes a read operation
           *
           * @Author Joao Carreira
           */
          virtual void doRead();
          
          /**
           * @Description Opens the device for reading
           *
           * @Argument streamHandler The StreamHandler which handles io results
           * @Argument proactor The proactor instance which will be "in charge" of this StreamReader
           * @Author Joao Carreira
           */
          virtual void open (ACE_Handler* streamHandler, ACE_Proactor* proactor);
          
          /**
           * @Description File descriptor getter
           *
           * @Returns The file descriptor
           * @Author Joao Carreira
           */
          virtual int getFileDescriptor() const {
            return device_->getFileDescriptor();
          }
          
          /**
           * @Description Destructor
           * @Author Joao Carreira
           */
          virtual ~StreamReader();
          
        private:
          ACE_Asynch_Read_Stream readStream_;
          Device* device_;
          
      }; // class StreamReader
      
    } // namespace io
  } // namespace support
} // namespace mermaid

#endif // _STREAM_READER_HPP_