ProtocolControlHub.hpp

Go to the documentation of this file.

/*
---------------------------------------------------------------------------

    This file is part of uHAL.

    uHAL is a hardware access library and programming framework
    originally developed for upgrades of the Level-1 trigger of the CMS
    experiment at CERN.

    uHAL is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    uHAL 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with uHAL.  If not, see <http://www.gnu.org/licenses/>.


      Andrew Rose, Imperial College, London
      email: awr01 <AT> imperial.ac.uk

      Marc Magrans de Abril, CERN
      email: marc.magrans.de.abril <AT> cern.ch

---------------------------------------------------------------------------
*/

#ifndef _uhal_ProtocolControlHub_hpp_
#define _uhal_ProtocolControlHub_hpp_

#include "uhal/ClientInterface.hpp"
#include "uhal/log/exception.hpp"
#include "uhal/log/log.hpp"

#include <iostream>
#include <iomanip>

#include <string>


namespace uhal
{

  namespace exception
  {
    UHAL_DEFINE_EXCEPTION_CLASS ( ParsingTargetURLfailed , "Exception class to handle the case where parsing the target URL failed." )

    
    UHAL_DEFINE_EXCEPTION_CLASS ( HostnameToIPlookupFailed , "Exception class to handle the case where hostname to IP lookup failed." )

    UHAL_DEFINE_EXCEPTION_CLASS ( XMLfileMissingRequiredParameters , "Exception class to handle the case where the received header does not match the expected header." )

    UHAL_DEFINE_EXCEPTION_CLASS ( ControlHubReturnedWrongAddress , "Exception class to handle the case where the ControlHub returned the wrong IP or Port" )

    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( ControlHubTargetTimeout , ClientTimeout , "Exception class to handle the case where the target does not respond to the ControlHub" )

    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( ControlHubErrorCodeSet, PacketLevelError , "Exception class to handle cases in which the ControlHub returns a non-zero error code (excluding target timeouts)" )
  }

  std::pair< uint32_t , uint16_t > ExtractTargetID ( const URI& aUri );


  template < typename InnerProtocol >
  class ControlHub : public InnerProtocol
  {

    public:
      ControlHub ( const std::string& aId, const URI& aUri );

      virtual ~ControlHub();

    protected:

      virtual void preamble ( boost::shared_ptr< Buffers > aBuffers );

      virtual uint32_t getPreambleSize();

      virtual void predispatch ( boost::shared_ptr< Buffers > aBuffers );


      virtual  exception::exception* validate ( uint8_t* aSendBufferStart ,
          uint8_t* aSendBufferEnd ,
          std::deque< std::pair< uint8_t* , uint32_t > >::iterator aReplyStartIt ,
          std::deque< std::pair< uint8_t* , uint32_t > >::iterator aReplyEndIt );

      virtual uint32_t getMaxNumberOfBuffers()
      {
        return 60;
      }

      virtual void dispatchExceptionHandler();


    private:
      static void translateErrorCode(std::ostream& aStream, const uint16_t& aErrorCode);

      uint32_t mDeviceIPaddress;

      uint16_t mDevicePort;

      struct tpreamble
      {
        // The total number of bytes that follow (outgoing) forming a logical packet (IDs + IPbus packet)
        //         uint32_t* mSendByteCountPtr;
        uint16_t* mSendWordCountPtr;

        // The total number of bytes that follow (incoming) forming a logical packet (IDs + IPbus packet)
        //         uint32_t mReplyTotalByteCounter;
        uint32_t mReplyChunkByteCounter;
        uint32_t mReplyDeviceIPaddress;
        uint16_t mReplyDevicePort;
        uint16_t mReplyErrorCode;
      };

      std::deque< tpreamble > mPreambles;
      boost::mutex mPreamblesMutex;

  };


}

#endif