StreamWriter.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_WRITER_HPP_
#define _STREAM_WRITER_HPP_

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


namespace mermaid
{
  namespace support
  {
    namespace io
    {
    
      using boost::shared_ptr;
      
      /**
       * @Class StreamWriter StreamWriter.hpp "StreamWriter.hpp"
       * @Description StreamWriter class
       *
       * The class which ultimately executes the write operations
       * @Author Joao Carreira
       */
      class StreamWriter
      {
        public:
          /**
           * @Description Constructor.
           *
           * @Argument device The device on which the write operations will be executed
           * @Author Joao Carreira
           */
          StreamWriter (Device* device);
          
          /**
           * @Description This method will be called by StreamHandler each time a write event occurs
           *
           * @Argument bytesWritten The number of bytes written
           * @Argument requestedBytes The number of bytes requested to be written
           * @Argument data The data written to the device
           * @Argument success TRUE if the write operation was successful, FALSE otherwise
           * @Author Joao Carreira
           */
          virtual void onWrite (size_t bytesWritten, size_t requestedBytes, const char* data, bool success, shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandlerWrite);
          
          /**
           * @Description Executes a write operation
           *
           * @Argument bytesToWrite The number of bytes to write to the device
           * @Argument data The data to be written to the device
          * @Argument streamOperationHandlerWrite The handler which will receive the write reply
           * @Author Joao Carreira
           */
          virtual void doWrite (size_t bytesToWrite, const char* data, shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandlerWrite);
          
          /**
           * @Description Opens the device for writing
           *
           * @Argument streamHandler The StreamHandler which handles io results
           * @Argument proactor The proactor instance which will be "in charge" of this StreamWriter
           * @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;
          
          /**
           * @Description Destructor
           *
           * @Author Joao Carreira
           */
          virtual ~StreamWriter();
          
        private:
          ACE_Asynch_Write_Stream writeStream_;
          Device* device_;
          
      }; // class StreamWriter
      
    } // namespace io
  } // namespace support
} // namespace mermaid

#endif // _STREAM_WRITER_HPP_