dunedaq::snbmodules::TransferInterfaceSCP Class Reference

#include <transfer_interface_SCP.hpp>

Inheritance diagram for dunedaq::snbmodules::TransferInterfaceSCP:

Collaboration diagram for dunedaq::snbmodules::TransferInterfaceSCP:

Classes
struct	scp_parameters

Public Member Functions
	TransferInterfaceSCP (GroupMetadata &config, bool is_uploader)
virtual	~TransferInterfaceSCP ()=default
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	hash_file (TransferMetadata &f_meta) override
bool	cancel_file (TransferMetadata &f_meta) override
Public Member Functions inherited from dunedaq::snbmodules::TransferInterfaceAbstract
	TransferInterfaceAbstract (GroupMetadata &config)
virtual	~TransferInterfaceAbstract ()=default
GroupMetadata &	get_transfer_options ()

Private Attributes
struct dunedaq::snbmodules::TransferInterfaceSCP::scp_parameters	m_params
bool	m_is_uploader
std::map< std::string, std::filesystem::path >	m_files_being_transferred

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

Definition at line 25 of file transfer_interface_SCP.hpp.

Constructor & Destructor Documentation

TransferInterfaceSCP()

dunedaq::snbmodules::TransferInterfaceSCP::TransferInterfaceSCP ( GroupMetadata & config, bool is_uploader )

inline

Definition at line 29 of file transfer_interface_SCP.hpp.

    : TransferInterfaceAbstract(config)
  {
    if (config.get_protocol_options().contains("user")) {
      m_params.user = config.get_protocol_options()["user"].get<std::string>();
    } else {
      ers::fatal(ConfigError(ERS_HERE, "user is mandatory in SCP protocol options"));
      return;
    }
 
    if (config.get_protocol_options().contains("use_password")) {
      m_params.use_password = config.get_protocol_options()["use_password"].get<bool>();
    }
 
    m_is_uploader = is_uploader;
  }

~TransferInterfaceSCP()

virtual dunedaq::snbmodules::TransferInterfaceSCP::~TransferInterfaceSCP ( )

virtualdefault

Member Function Documentation

cancel_file()

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

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 118 of file transfer_interface_SCP.hpp.

  {
    TLOG() << "debug : SCP : Cancelling file " << f_meta.get_file_name();
    f_meta.set_status(status_type::e_status::CANCELLED);
    return true;
  }

download_file()

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

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 58 of file transfer_interface_SCP.hpp.

  {
    TLOG() << "debug : SCP : Downloading file " << f_meta.get_file_name();
    f_meta.set_status(status_type::e_status::DOWNLOADING);
 
    m_files_being_transferred[f_meta.get_file_name()] = dest;
 
    std::string exec = "";
    if (m_params.use_password) {
      exec = "scp " + m_params.user + "@" + f_meta.get_src().get_ip() + ":" + f_meta.get_file_path().string() + " " +
             dest.string();
    } else {
 
      exec = "scp -o PasswordAuthentication='no' " + m_params.user + "@" + f_meta.get_src().get_ip() + ":" +
             f_meta.get_file_path().string() + " " + dest.string();
    }
 
    TLOG() << "debug : executing " << exec;
    if (system(exec.c_str()) == 0) // NOLINT
    {
      TLOG() << "debug : SCP : Sucess Download";
      f_meta.set_status(status_type::e_status::FINISHED);
      f_meta.set_bytes_transferred(f_meta.get_size());
    } else {
      ers::error(ErrorSCPDownloadError(ERS_HERE, "Please check the logs for more information."));
      f_meta.set_status(status_type::e_status::ERROR);
      f_meta.set_error_code("Something went wrong during the download");
      f_meta.set_bytes_transferred(0);
      return false;
    }
 
    return true;
  }

hash_file()

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

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 111 of file transfer_interface_SCP.hpp.

  {
    TLOG() << "debug : SCP : Hashing file " << f_meta.get_file_name();
    f_meta.set_status(status_type::e_status::HASHING);
    return true;
  }

pause_file()

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

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 92 of file transfer_interface_SCP.hpp.

  {
    TLOG() << "debug : SCP : Pausing file " << f_meta.get_file_name();
    f_meta.set_status(status_type::e_status::PAUSED);
    f_meta.set_bytes_transferred(0);
    return true;
  }

resume_file()

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

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 100 of file transfer_interface_SCP.hpp.

  {
    TLOG() << "debug : SCP : Resuming file " << f_meta.get_file_name();
 
    if (m_is_uploader) {
      return upload_file(f_meta);
    } else {
      return download_file(f_meta, m_files_being_transferred[f_meta.get_file_name()]);
    }
  }

upload_file()

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

inlineoverridevirtual

Implements dunedaq::snbmodules::TransferInterfaceAbstract.

Definition at line 47 of file transfer_interface_SCP.hpp.

  {
    TLOG() << "debug : SCP : Uploading file " << f_meta.get_file_name();
    f_meta.set_status(status_type::e_status::UPLOADING);
 
    // nothing to do
    TLOG() << "debug : SCP : Sucess Upload";
    f_meta.set_status(status_type::e_status::FINISHED);
    f_meta.set_bytes_transferred(f_meta.get_size());
    return true;
  }

Member Data Documentation

m_files_being_transferred

std::map<std::string, std::filesystem::path> dunedaq::snbmodules::TransferInterfaceSCP::m_files_being_transferred

private

Definition at line 133 of file transfer_interface_SCP.hpp.

m_is_uploader

bool dunedaq::snbmodules::TransferInterfaceSCP::m_is_uploader

private

Definition at line 132 of file transfer_interface_SCP.hpp.

m_params

struct dunedaq::snbmodules::TransferInterfaceSCP::scp_parameters dunedaq::snbmodules::TransferInterfaceSCP::m_params

private

---

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

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