Buffers.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_Buffers_hpp_
#define _uhal_Buffers_hpp_
 
 
#include <deque>
#include <stdint.h>         // for uint32_t, uint8_t
#include <utility>          // for pair
#include <vector>           // for vector
 
#include "uhal/ValMem.hpp"
 
 
namespace uhal
{
 
  class Buffers
  {
    public:
 
      Buffers ( const uint32_t& aMaxSendSize = 65536 );
 
      virtual ~Buffers();
 
      const uint32_t& sendCounter();
 
      const uint32_t& replyCounter();
 
      template< typename T >
      uint8_t* send ( const T* aPtr );
 
      template< typename T >
      uint8_t* send ( const T& aRef );
 
      uint8_t* send ( const uint8_t* aPtr , const uint32_t& aSize );
 
      template< typename T >
      void receive ( T* aPtr );
 
      template< typename T >
      void receive ( T& aRef );
 
      void receive ( uint8_t* aPtr , const uint32_t& aSize );
 
      void add ( const ValHeader& aValMem );
 
      void add ( const ValWord< uint32_t >& aValMem );
 
      void add ( const ValVector< uint32_t >& aValMem );
 
      uint8_t* getSendBuffer();
 
      std::deque< std::pair< uint8_t* , uint32_t > >& getReplyBuffer();
 
      void validate ();
 
      void clear();
 
    private:
      uint32_t mSendCounter;
      uint32_t mReplyCounter;
 
      std::vector<uint8_t> mSendBuffer;
      std::deque< std::pair< uint8_t* , uint32_t > > mReplyBuffer;
 
      std::deque< ValHeader > mValHeaders;
      std::deque< ValWord< uint32_t > > mUnsignedValWords;
      std::deque< ValVector< uint32_t > > mUnsignedValVectors;
  };
 
}
 
#include "uhal/TemplateDefinitions/Buffers.hxx"
 
#endif