StreamReadReplyTask.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 __STREAMREADREPLYTASK_H
#define __STREAMREADREPLYTASK_H

#include <Task.hpp>

#include "StreamOperationHandlerMethod.hpp"

namespace mermaid
{
  namespace support
  {
    namespace io
    {
    
      using mermaid::support::activeobject::Task;
      using boost::shared_ptr;
      
      /**
       * @Class StreamReadReplyTask StreamReadReplyTask.hpp "StreamReadReplyTask.hpp"
       * @Description StreamReadReplyTask class
       *
       * This is the task which delivers the read operation reply
       * @Author Joao Carreira
       */
      class StreamReadReplyTask : public Task
      {
        public:
        
          /**
           * @Description Constructor.
           *
           * @Argument bytesRead The number of bytes read
           * @Argument requestedBytes The number of bytes requested to be read
           * @Argument data The read data
           * @Argument success TRUE if read operation was successful, FALSE otherwise
           * @Argument streamOperationHandler The handler which will receive the reply
           * @Author Joao Carreira
           */
          StreamReadReplyTask (size_t bytesRead, size_t requestedBytes, const char* data, bool success,
                               shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandler);
                               
          /**
           * @Description Task main method
           *
           * Deliver the reply to the handler
           * @Author Joao Carreira
           */
          virtual void run();
          
          /**
           * @Description Destructor
           *
           * @Author Joao Carreira
           */
          virtual ~StreamReadReplyTask();
          
        private:
          size_t bytesRead_;
          size_t requestedBytes_;
          const char *data_;
          bool success_;
          shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandler_;
          
      }; // class StreamReadReplyTask
      
    } // namespace io
  } // namespace support
} // namespace mermaid

#endif // __STREAMREADREPLYTASK_H