ServiceRequestState.hpp

Go to the documentation of this file.

/*
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/>.
*/



/**
 * @Filename ServiceRequestState.hpp
 * @Description Support ServiceRequestState declaration
 * @Status Work in Progress
 * @Version $Id: ServiceRequestState.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer Marco Barbosa
 */


#ifndef __SUPPORT_SERVICEREQUESTSTATE_H
#define __SUPPORT_SERVICEREQUESTSTATE_H

#include <boost/shared_ptr.hpp>

namespace mermaid
{
  namespace support
  {
    namespace service
    {
      using boost::shared_ptr;
      
      /**
       * @Class ServiceRequestState ServiceRequestState.hpp "ServiceRequestState.hpp"
       * @Description ServiceRequestState class.
       *
       * This class represents the state of a given ServiceRequest
       * @Author Marco Barbosa
       */
      class ServiceRequestState
      {
        public:
          ServiceRequestState();
          void notifySent();
          void notifyReplyReceived();
          
        private:
          enum ServiceRequestConcreteState { READY_TO_SEND, FAILED_TO_SEND, WAITING_FOR_REPLY, REPLY_TIMED_OUT, GOT_REPLY };
          ServiceRequestConcreteState state_;
      }; // class ServiceRequestState
    } // namespace service
  } // namespace support
} // namespace mermaid


#endif // __SUPPORT_SERVICEREQUESTSTATE_H