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 <chrono>
#include <condition_variable>
#include <deque>
#include <iostream>
#include <memory>
#include <stdint.h>
#include <string>
#include <thread>
#include <vector>
 
#include <boost/asio/io_context.hpp>
#include <boost/asio/executor_work_guard.hpp>
#include <boost/asio/ip/tcp.hpp>
#include <boost/asio/deadline_timer.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 ( std::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 std::chrono::steady_clock SteadyClock_t;
 
      size_t mMaxPayloadSize;
 
      boost::asio::io_context mIOservice;
 
      boost::asio::ip::tcp::socket mSocket;
 
      boost::asio::ip::tcp::resolver::results_type mEndpoint;
 
      boost::asio::deadline_timer mDeadlineTimer;
 
      boost::asio::executor_work_guard<boost::asio::io_context::executor_type> mIOserviceWork;
 
      std::thread mDispatchThread;
 
      std::mutex mTransportLayerMutex;
 
      std::deque < std::shared_ptr< Buffers > > mDispatchQueue;
      std::deque < std::pair<std::vector< std::shared_ptr< Buffers > >, SteadyClock_t::time_point> > mReplyQueue;
 
      uint32_t mPacketsInFlight;
 
      bool mFlushStarted;
 
      std::mutex mConditionalVariableMutex;
      std::condition_variable mConditionalVariable;
      bool mFlushDone;
 
      uint32_t mSendByteCounter;
 
      uint32_t mReplyByteCounter;
 
      std::vector< std::shared_ptr< Buffers > > mDispatchBuffers;
 
      std::pair< std::vector< std::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