StreamOperationHandlerMethod.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 __STREAMOPERATIONHANDLERMETHOD_H
#define __STREAMOPERATIONHANDLERMETHOD_H





namespace mermaid
{
  namespace support
  {
    namespace io
    {
    
      using boost::shared_ptr;
      
      /**
       * @Class StreamOperationHandlerMethodBase StreamOperationHandlerMethod.hpp "StreamOperationHandlerMethod.hpp"
       * @Description Base class for all StreamOperationHandlerMethod objects.
       *
       * This class is needed in order to call StreamOperationHandlerMethod without having to know the specific class used by the template.
       * @Author Joao Carreira
       */
      class StreamOperationHandlerMethodBase
      {
        public:
          virtual void callHandler (size_t, size_t, const char*, bool) = 0;
          virtual ~StreamOperationHandlerMethodBase() {}
      };
      
      
      /**
       * @Class StreamOperationHandlerMethod StreamOperationHandlerMethod.hpp "StreamOperationHandlerMethod.hpp"
       * @Description Class that stores a pointer to a method of an object. It holds a pointer to a method suitable for handling io operations replies
       * @Author Joao Carreira
       */
      template <class o>
      class StreamOperationHandlerMethod : public StreamOperationHandlerMethodBase
      {
          typedef void (o::*STREAM_OPERATION_HANDLER_METHOD) (size_t, size_t, const char*, bool);
        public:
        
          /**
           * @Description Constructor.
           * @Argument object Object instance on which the method shall be called
           * @Argument method Method of the object's class
           */
          StreamOperationHandlerMethod (o * object, STREAM_OPERATION_HANDLER_METHOD method) {
            object_ = object;
            method_ = method;
          }
          
          /**
           * @Description IO Handlers call (read and write)
           * @Argument bytesRead The number of bytes read/written
           * @Argument requestedBytes The number of bytes requested to be read/written
           * @Argument data The data read/written
           * @Argument success TRUE if operation was successful, FALSE otherwise
           */
          virtual void callHandler (size_t bytesRead, size_t requestedBytes, const char* data, bool success) {
            (object_->*method_) (bytesRead, requestedBytes, data, success);
          }
          
          /**
           * @Description Destructor
           */
          virtual ~StreamOperationHandlerMethod() {}
          
        private:
          o * object_;
          STREAM_OPERATION_HANDLER_METHOD method_;
      }; // class StreamOperationHandlerMethod
    } // namespace io
  } // namespace support
} // namespace mermaid

#endif // __STREAMOPERATIONHANDLERMETHOD_H