dunedaq::snbmodules::TransferInterfaceDummy Class Reference

Example of a transfer interface class. This class is used to test the session class. More...

#include <transfer_interface_abstract.hpp>

Inheritance diagram for dunedaq::snbmodules::TransferInterfaceDummy:

Collaboration diagram for dunedaq::snbmodules::TransferInterfaceDummy:

Public Member Functions
	TransferInterfaceDummy (GroupMetadata &config)
bool	upload_file (TransferMetadata &f_meta) override
bool	download_file (TransferMetadata &f_meta, std::filesystem::path dest) override
bool	pause_file (TransferMetadata &f_meta) override
bool	resume_file (TransferMetadata &f_meta) override
bool	cancel_file (TransferMetadata &f_meta) override
bool	hash_file (TransferMetadata &f_meta) override
Public Member Functions inherited from dunedaq::snbmodules::TransferInterfaceAbstract
	TransferInterfaceAbstract (GroupMetadata &config)
virtual	~TransferInterfaceAbstract ()=default
GroupMetadata &	get_transfer_options ()

Additional Inherited Members
Protected Attributes inherited from dunedaq::snbmodules::TransferInterfaceAbstract
GroupMetadata &	m_config
	MetadataAbstract of the transfer, contain settings and status of the transfer.

Detailed Description

Example of a transfer interface class. This class is used to test the session class.

Definition at line 51 of file transfer_interface_abstract.hpp.

Constructor & Destructor Documentation

TransferInterfaceDummy()

dunedaq::snbmodules::TransferInterfaceDummy::TransferInterfaceDummy ( GroupMetadata & config )

inlineexplicit

Definition at line 55 of file transfer_interface_abstract.hpp.

    : TransferInterfaceAbstract(config)
  {
  }

Member Function Documentation

cancel_file()

bool dunedaq::snbmodules::TransferInterfaceDummy::cancel_file ( TransferMetadata & f_meta )

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 81 of file transfer_interface_abstract.hpp.

  {
    TLOG() << "Cancel file " << f_meta.get_file_name();
    return true;
  }

download_file()

bool dunedaq::snbmodules::TransferInterfaceDummy::download_file ( TransferMetadata & f_meta, std::filesystem::path dest )

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 65 of file transfer_interface_abstract.hpp.

  {
    (void)dest;
    TLOG() << "Download file " << f_meta.get_file_name();
    return true;
  }

hash_file()

bool dunedaq::snbmodules::TransferInterfaceDummy::hash_file ( TransferMetadata & f_meta )

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 86 of file transfer_interface_abstract.hpp.

  {
    TLOG() << "Hash file " << f_meta.get_file_name();
    return true;
  }

pause_file()

bool dunedaq::snbmodules::TransferInterfaceDummy::pause_file ( TransferMetadata & f_meta )

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 71 of file transfer_interface_abstract.hpp.

  {
    TLOG() << "Pause file " << f_meta.get_file_name();
    return true;
  }

resume_file()

bool dunedaq::snbmodules::TransferInterfaceDummy::resume_file ( TransferMetadata & f_meta )

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 76 of file transfer_interface_abstract.hpp.

  {
    TLOG() << "Resume file " << f_meta.get_file_name();
    return true;
  }

upload_file()

bool dunedaq::snbmodules::TransferInterfaceDummy::upload_file ( TransferMetadata & f_meta )

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 60 of file transfer_interface_abstract.hpp.

  {
    TLOG() << "Upload file " << f_meta.get_file_name();
    return true;
  }

---

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

• /github/workspace/dunedaq/sourcecode/snbmodules/include/snbmodules/interfaces/transfer_interface_abstract.hpp