dunedaq::snbmodules::TransferInterfaceAbstract Class Reference

#include <transfer_interface_abstract.hpp>

Inheritance diagram for dunedaq::snbmodules::TransferInterfaceAbstract:

Collaboration diagram for dunedaq::snbmodules::TransferInterfaceAbstract:

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

Protected Attributes
GroupMetadata &	m_config
	MetadataAbstract of the transfer, contain settings and status of the transfer.

Detailed Description

Definition at line 25 of file transfer_interface_abstract.hpp.

Constructor & Destructor Documentation

TransferInterfaceAbstract()

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

inlineexplicit

Definition at line 29 of file transfer_interface_abstract.hpp.

    : m_config(config)
  {
  }

~TransferInterfaceAbstract()

virtual dunedaq::snbmodules::TransferInterfaceAbstract::~TransferInterfaceAbstract ( )

virtualdefault

Member Function Documentation

cancel_file()

virtual bool dunedaq::snbmodules::TransferInterfaceAbstract::cancel_file ( TransferMetadata & f_meta )

pure virtual

Implemented in dunedaq::snbmodules::TransferInterfaceBittorrent, dunedaq::snbmodules::TransferInterfaceDummy, dunedaq::snbmodules::TransferInterfaceRClone, and dunedaq::snbmodules::TransferInterfaceSCP.

download_file()

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

pure virtual

Implemented in dunedaq::snbmodules::TransferInterfaceBittorrent, dunedaq::snbmodules::TransferInterfaceDummy, dunedaq::snbmodules::TransferInterfaceRClone, and dunedaq::snbmodules::TransferInterfaceSCP.

get_transfer_options()

GroupMetadata & dunedaq::snbmodules::TransferInterfaceAbstract::get_transfer_options ( )

inline

Definition at line 35 of file transfer_interface_abstract.hpp.

{ return m_config; }

hash_file()

virtual bool dunedaq::snbmodules::TransferInterfaceAbstract::hash_file ( TransferMetadata & f_meta )

pure virtual

Implemented in dunedaq::snbmodules::TransferInterfaceBittorrent, dunedaq::snbmodules::TransferInterfaceDummy, dunedaq::snbmodules::TransferInterfaceRClone, and dunedaq::snbmodules::TransferInterfaceSCP.

pause_file()

virtual bool dunedaq::snbmodules::TransferInterfaceAbstract::pause_file ( TransferMetadata & f_meta )

pure virtual

Implemented in dunedaq::snbmodules::TransferInterfaceBittorrent, dunedaq::snbmodules::TransferInterfaceDummy, dunedaq::snbmodules::TransferInterfaceRClone, and dunedaq::snbmodules::TransferInterfaceSCP.

resume_file()

virtual bool dunedaq::snbmodules::TransferInterfaceAbstract::resume_file ( TransferMetadata & f_meta )

pure virtual

Implemented in dunedaq::snbmodules::TransferInterfaceBittorrent, dunedaq::snbmodules::TransferInterfaceDummy, dunedaq::snbmodules::TransferInterfaceRClone, and dunedaq::snbmodules::TransferInterfaceSCP.

upload_file()

virtual bool dunedaq::snbmodules::TransferInterfaceAbstract::upload_file ( TransferMetadata & f_meta )

pure virtual

Implemented in dunedaq::snbmodules::TransferInterfaceBittorrent, dunedaq::snbmodules::TransferInterfaceDummy, dunedaq::snbmodules::TransferInterfaceRClone, and dunedaq::snbmodules::TransferInterfaceSCP.

Member Data Documentation

m_config

GroupMetadata& dunedaq::snbmodules::TransferInterfaceAbstract::m_config

protected

MetadataAbstract of the transfer, contain settings and status of the transfer.

Definition at line 46 of file transfer_interface_abstract.hpp.

---

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

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