ProtocolTCP.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_ProtocolTCP_hpp_
#define _uhal_ProtocolTCP_hpp_


#include <deque>
#include <iostream>
#include <stdint.h>
#include <string>
#include <vector>

#include <boost/shared_ptr.hpp>
#include <boost/asio/io_service.hpp>
#include <boost/asio/ip/tcp.hpp>
#include <boost/asio/deadline_timer.hpp>
#include <boost/chrono/system_clocks.hpp>

#include <boost/thread/thread.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/condition_variable.hpp>

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

namespace uhal
{
  // Forward declarations
  class Buffers;
  struct URI;


  namespace exception
  {
    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( TcpTimeout , ClientTimeout , "Exception class to handle the case where the TCP connection timed out." )
    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( ErrorAtTcpSocketCreation , TransportLayerError , "Exception class to handle a failure to create a TCP socket." )
    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( TcpConnectionFailure , TransportLayerError , "Exception class to handle the case where the TCP connection was refused or aborted." )
    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( ASIOTcpError , TransportLayerError , "Exception class to handle the case where ASIO returned an error." )

  }

  template < typename InnerProtocol , std::size_t nr_buffers_per_send >
  class TCP : public InnerProtocol
  {

    private:
      TCP ( const TCP& aTCP ); // non-copyable

      TCP& operator= ( const TCP& aTCP ); // non-assignable

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

      virtual ~TCP();

    private:
      void implementDispatch ( boost::shared_ptr< Buffers > aBuffers );

      virtual void Flush( );

      virtual void dispatchExceptionHandler();

      uint32_t getMaxSendSize();

      uint32_t getMaxReplySize();

      void connect();

      void write ( );

      void write_callback ( const boost::system::error_code& aErrorCode , std::size_t aBytesTransferred );

      void read ( );

      void read_callback ( const boost::system::error_code& aErrorCode , std::size_t aBytesTransferred );

      void CheckDeadline();

      void NotifyConditionalVariable ( const bool& aValue );
      void WaitOnConditionalVariable();


    private:
      typedef boost::chrono::steady_clock SteadyClock_t;

      boost::asio::io_service mIOservice;

      boost::asio::ip::tcp::socket mSocket;

      boost::asio::ip::tcp::resolver::iterator mEndpoint;

      boost::asio::deadline_timer mDeadlineTimer;

      boost::asio::io_service::work mIOserviceWork;

      boost::thread mDispatchThread;

      boost::mutex mTransportLayerMutex;

      std::deque < boost::shared_ptr< Buffers > > mDispatchQueue;
      std::deque < std::pair<std::vector< boost::shared_ptr< Buffers > >, SteadyClock_t::time_point> > mReplyQueue;

      uint32_t mPacketsInFlight;

      bool mFlushStarted;

      boost::mutex mConditionalVariableMutex;
      boost::condition_variable mConditionalVariable;
      bool mFlushDone;

      uint32_t mSendByteCounter;

      uint32_t mReplyByteCounter;

      std::vector< boost::shared_ptr< Buffers > > mDispatchBuffers;

      std::pair< std::vector< boost::shared_ptr< Buffers > >, SteadyClock_t::time_point > mReplyBuffers;

      uhal::exception::exception* mAsynchronousException;


      SteadyClock_t::time_point mLastSendQueued;
      SteadyClock_t::time_point mLastRecvQueued;

      TimeIntervalStats mRTTStats;
      TimeIntervalStats mLSTStats;
      TimeIntervalStats mInterSendTimeStats;
      TimeIntervalStats mInterRecvTimeStats;
  };

}


#endif