artdaq  v2_03_02
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
artdaq::TransferWrapper Class Reference

TransferWrapper wraps a TransferInterface so that it can be used in the ArtdaqInput class to make an art::Source. More...

#include <artdaq/TransferPlugins/TransferWrapper.hh>

Public Member Functions

 TransferWrapper (const fhicl::ParameterSet &pset)
 TransferWrapper Constructor. More...
 
virtual ~TransferWrapper ()
 TransferWrapper Destructor.
 
void receiveMessage (std::unique_ptr< TBufferFile > &msg)
 Receive a Fragment from the TransferInterface, and send it to art. More...
 

Detailed Description

TransferWrapper wraps a TransferInterface so that it can be used in the ArtdaqInput class to make an art::Source.

JCF, May-27-2016

This is the class through which code that wants to access a transfer plugin (e.g., input sources, AggregatorCore, etc.) can do so. Its functionality is such that it satisfies the requirements needed to be a template in the ArtdaqInput class

Definition at line 33 of file TransferWrapper.hh.

Constructor & Destructor Documentation

artdaq::TransferWrapper::TransferWrapper ( const fhicl::ParameterSet &  pset)
explicit

TransferWrapper Constructor.

Parameters
psetParameterSet used to configure the TransferWrapper
* TransferWrapper accepts the following Parameters:
* "timeoutInUsecs" (Default: 100000): The receive timeout
* "dispatcherHost" (REQUIRED): The hostname that the Dispatcher Aggregator is running on
* "dispatcherPort" (REQUIRED): The port that the Dispatcher Aggregator is running on
* "maxEventsBeforeInit" (Default: 5): How many non-Init events to receive before raising an error
* "allowedFragmentTypes" (Default: [226,227,229]): The Fragment type codes for expected Fragments
* "quitOnFragmentIntegrityProblem" (Default: true): If there is an inconsistency in the received Fragment, throw an exception and quit when true
* "debugLevel" (Default: 0): Enables some additional messages
* "transfer_plugin" (REQUIRED): Name of the TransferInterface plugin to load
* 
* This parameter set is also passed to TransferInterface, so any necessary Parameters for TransferInterface or the requested plugin
* should be included here.
* 

Definition at line 39 of file TransferWrapper.cc.

Member Function Documentation

void artdaq::TransferWrapper::receiveMessage ( std::unique_ptr< TBufferFile > &  msg)

Receive a Fragment from the TransferInterface, and send it to art.

Parameters
[out]msgThe message in art format

Definition at line 96 of file TransferWrapper.cc.


The documentation for this class was generated from the following files: