#include <transfer_metadata.hpp>

Inheritance diagram for dunedaq::snbmodules::TransferMetadata:

Collaboration diagram for dunedaq::snbmodules::TransferMetadata:

Public Member Functions
virtual std::string	export_to_string_partial (bool force_all)
	Export only the modified fields to a string.

std::string	export_to_string () override
	Export metadata to string (json format)

void	from_string (const std::string &) override
	Import metadata from string (json format)

void	generate_metadata_file (std::filesystem::path dest) override
	Generaete metadata file to dest.

void	load_metadata_from_meta_file (std::filesystem::path src) override
	Load metadata file from src.

bool	operator== (MetadataAbstract const &other) const override
	Operator ==.

bool	operator< (MetadataAbstract const &other) const override
	Operator < overload.

	TransferMetadata (const std::filesystem::path &file_path, uint64_t bytes_size, const IPFormat &src, const std::string &hash="", const IPFormat &dest=IPFormat(), const std::string &group_id="", uint64_t bytes_transferred=0, status_type::e_status status=status_type::e_status::WAITING)
	Constructor.

	TransferMetadata (const std::filesystem::path &src, bool is_path=true)
	Load from file constructor.

virtual	~TransferMetadata ()

void	set_file_path (const std::filesystem::path &file_path)

void	set_group_id (std::string group_id)

void	set_src (const IPFormat &source)

void	set_dest (const IPFormat &dest)

void	set_hash (std::string hash)

void	set_size (uint64_t size)

void	set_bytes_transferred (uint64_t bytes_transferred)

void	set_progress (int purcent)

void	set_status (status_type::e_status status)

void	set_magnet_link (std::string magnet_link)

void	set_error_code (std::string error_code)

void	set_transmission_speed (int32_t transmission_speed)

void	set_duration (int64_t duration)

void	set_start_time (int64_t start_time)

void	set_end_time (int64_t end_time)

std::filesystem::path	get_file_path () const

std::string	get_file_name () const

std::string	get_hash () const

IPFormat	get_src () const

IPFormat	get_dest () const

uint64_t	get_size () const

uint64_t	get_bytes_transferred () const

status_type::e_status	get_status () const

std::string	get_magnet_link () const

std::string	get_group_id () const

int	get_progress () const

std::string	get_error_code () const

int32_t	get_transmission_speed () const

int64_t	get_total_duration_ms () const

int64_t	get_start_time () const

int64_t	get_end_time () const

std::string	get_start_time_str () const

std::string	get_end_time_str () const

Public Member Functions inherited from dunedaq::snbmodules::MetadataAbstract
virtual	~MetadataAbstract ()=default

Static Public Attributes
static const std::string	m_file_extension = ".tmetadata"

Private Attributes
std::filesystem::path	m_file_path = ""
	Path of the file on the src filesystem.

std::string	m_hash = ""
	TODO : Hash of the file sha1.

uint64_t	m_bytes_size = 0
	Total size of the file in bytes.

uint64_t	m_bytes_transferred = 0
	Number of bytes transferred or received.

int32_t	m_transmission_speed = 0
	Transmission speed in bytes/s.

status_type::e_status	m_status = status_type::e_status::WAITING
	Status of the file transfer.

IPFormat	m_src = IPFormat()
	Source of the file transfer.

IPFormat	m_dest = IPFormat()
	Destination of the file transfer, not always initialized.

std::string	m_magnet_link = ""
	Magnet link of the file only for bit torrent.

std::string	m_group_id = ""
	Group id of the file, used to group files together.

std::string	m_error_code = ""
	show the error exception in case of error

int64_t	m_start_time = 0
	Start time of the transfer, 0 if not started, reset if resumed.

int64_t	m_end_time = 0
	End time of the transfer, 0 if not finished.

int64_t	m_duration = 0
	Duration of the transfer.

std::map< std::string, bool >	m_modified_fields
	Vector of modified fields in order : to send only the modified fields.

Detailed Description

Definition at line 28 of file transfer_metadata.hpp.

Constructor & Destructor Documentation

◆ TransferMetadata() [1/2]

dunedaq::snbmodules::TransferMetadata::TransferMetadata	(	const std::filesystem::path &	file_path,
		uint64_t	bytes_size,
		const IPFormat &	src,
		const std::string &	hash = "",
		const IPFormat &	dest = IPFormat(),
		const std::string &	group_id = "",
		uint64_t	bytes_transferred = 0,
		status_type::e_status	status = status_type::e_status::WAITING )

inline

Constructor.

Parameters

file_path
bytes_size
hash
src
dest
bytes_transferred
status

Definition at line 70 of file transfer_metadata.hpp.

    : m_hash(hash)
    , m_bytes_size(bytes_size)
    , m_bytes_transferred(bytes_transferred)
    , m_status(status)
    , m_src(src)
    , m_dest(dest)
    , m_group_id(group_id)
    , m_modified_fields({ { "hash", true },
                          { "size", true },
                          { "bytes_transferred", true },
                          { "transmission_speed", true },
                          { "status", true },
                          { "magnet_link", true },
                          { "error_code", true },
                          { "start_time", true },
                          { "end_time", true },
                          { "duration", true } })
  {
    // remove all occurences of ./ in the file path
    std::string file_path_str = file_path.string();
    std::string x = "./";
 
    size_t pos = 0;
    while (true) {
      pos = file_path_str.find(x, pos);
      if (pos == std::string::npos) {
        break;
      }
 
      file_path_str.replace(pos, x.length(), "");
    }
 
    m_file_path = std::filesystem::absolute(file_path_str);
  }

◆ TransferMetadata() [2/2]

dunedaq::snbmodules::TransferMetadata::TransferMetadata	(	const std::filesystem::path &	src,
		bool	is_path = true )

inlineexplicit

Load from file constructor.

Definition at line 114 of file transfer_metadata.hpp.

  {
    if (is_path) {
      load_metadata_from_meta_file(src);
    } else {
      from_string(src.string());
    }
  }

◆ ~TransferMetadata()

virtual dunedaq::snbmodules::TransferMetadata::~TransferMetadata ( )

inlinevirtual

Definition at line 123 of file transfer_metadata.hpp.

123{}

Member Function Documentation

◆ export_to_string()

std::string dunedaq::snbmodules::TransferMetadata::export_to_string ( )

inlineoverridevirtual

Export metadata to string (json format)

Returns: Metadata in string format

Implements dunedaq::snbmodules::MetadataAbstract.

Definition at line 40 of file transfer_metadata.hpp.

40{ return export_to_string_partial(true); }

dunedaq::snbmodules::TransferMetadata::export_to_string_partial

virtual std::string export_to_string_partial(bool force_all)

Export only the modified fields to a string.

Definition transfer_metadata.cpp:18

◆ export_to_string_partial()

std::string dunedaq::snbmodules::TransferMetadata::export_to_string_partial ( bool force_all )

virtual

Export only the modified fields to a string.

Parameters

force_all Export everything if true

Returns: String containing the metadata

Definition at line 18 of file transfer_metadata.cpp.

{
  nlohmann::json j;
  j["file_path"] = get_file_path().string();
  j["source"] = get_src().get_ip_port();
  j["destination"] = get_dest().get_ip_port();
  j["group_id"] = get_group_id();
 
  // not mandatory : to be refreshed when needed
  if (force_all || m_modified_fields["hash"] == true) {
    j["hash"] = get_hash();
  }
  if (force_all || m_modified_fields["size"] == true) {
    j["size"] = get_size();
  }
  if (force_all || m_modified_fields["bytes_transferred"] == true) {
    j["transfered"] = get_bytes_transferred();
  }
  if (force_all || m_modified_fields["transmission_speed"] == true) {
    j["speed"] = get_transmission_speed();
  }
  if (force_all || m_modified_fields["status"] == true) {
    j["status"] = status_type::status_to_string(get_status());
  }
  if (force_all || m_modified_fields["magnet_link"] == true) {
    j["magnet_link"] = get_magnet_link();
  }
  if (force_all || m_modified_fields["error_code"] == true) {
    j["error_code"] = get_error_code();
  }
  if (force_all || m_modified_fields["start_time"] == true) {
    j["start_t"] = get_start_time();
  }
  if (force_all || m_modified_fields["end_time"] == true) {
    j["end_t"] = get_end_time();
  }
  if (force_all || m_modified_fields["duration"] == true) {
    j["duration"] = m_duration;
  }
 
  m_modified_fields.clear();
 
  return j.dump();
}

◆ from_string()

void dunedaq::snbmodules::TransferMetadata::from_string ( const std::string & s )

overridevirtual

Import metadata from string (json format)

Implements dunedaq::snbmodules::MetadataAbstract.

Definition at line 64 of file transfer_metadata.cpp.

{
  nlohmann::json j = nlohmann::json::parse(str);
 
  TLOG() << "debug : Loading metadata from string " << str;
 
  if (j.contains("file_path")) {
    set_file_path(j["file_path"].get<std::filesystem::path>());
  }
  if (j.contains("hash")) {
    set_hash(j["hash"].get<std::string>());
  }
  if (j.contains("size")) {
    set_size(j["size"].get<uint64_t>()); // NOLINT
  }
  if (j.contains("transfered")) {
    set_bytes_transferred(j["transfered"].get<uint64_t>()); // NOLINT
  }
  if (j.contains("speed")) {
    set_transmission_speed(j["speed"].get<int32_t>());
  }
  if (j.contains("source")) {
    set_src(IPFormat(j["source"].get<std::string>()));
  }
  if (j.contains("destination")) {
    set_dest(IPFormat(j["destination"].get<std::string>()));
  }
  if (j.contains("status")) {
    auto status = status_type::string_to_status(j["status"].get<std::string>());
    if (status.has_value()) {
      set_status(status.value());
    } else {
      ers::error(InvalidProtocolError(ERS_HERE, "reading metadata string process", j["status"].get<std::string>()));
    }
  }
  if (j.contains("magnet_link")) {
    set_magnet_link(j["magnet_link"].get<std::string>());
  }
  if (j.contains("group_id")) {
    set_group_id(j["group_id"].get<std::string>());
  }
  if (j.contains("error_code")) {
    set_error_code(j["error_code"].get<std::string>());
  }
  if (j.contains("start_t")) {
    set_start_time(j["start_t"].get<int64_t>());
  }
  if (j.contains("end_t")) {
    set_end_time(j["end_t"].get<int64_t>());
  }
  if (j.contains("duration")) {
    set_duration(j["duration"].get<int64_t>());
  }
}

◆ generate_metadata_file()

void dunedaq::snbmodules::TransferMetadata::generate_metadata_file ( std::filesystem::path dest )

overridevirtual

Generaete metadata file to dest.

Parameters

dest

Implements dunedaq::snbmodules::MetadataAbstract.

Definition at line 120 of file transfer_metadata.cpp.

{
  std::ofstream metadata_file;
  metadata_file.open(dest.append(get_file_name()).string() + TransferMetadata::m_file_extension);
 
  metadata_file << export_to_string();
 
  metadata_file.close();
}

◆ get_bytes_transferred()

uint64_t dunedaq::snbmodules::TransferMetadata::get_bytes_transferred ( ) const

inline

Definition at line 257 of file transfer_metadata.hpp.

257{ return m_bytes_transferred; }

◆ get_dest()

IPFormat dunedaq::snbmodules::TransferMetadata::get_dest ( ) const

inline

Definition at line 255 of file transfer_metadata.hpp.

255{ return m_dest; }

◆ get_end_time()

int64_t dunedaq::snbmodules::TransferMetadata::get_end_time ( ) const

inline

Definition at line 281 of file transfer_metadata.hpp.

281{ return m_end_time; }

dunedaq::snbmodules::TransferMetadata::m_end_time

int64_t m_end_time

End time of the transfer, 0 if not finished.

Definition transfer_metadata.hpp:343

◆ get_end_time_str()

std::string dunedaq::snbmodules::TransferMetadata::get_end_time_str ( ) const

inline

Definition at line 293 of file transfer_metadata.hpp.

  {
    if (m_end_time == 0) {
      return "N/A";
    }
    std::time_t t = m_end_time / 1000;
    std::tm tm = *std::localtime(&t);
    std::stringstream ss;
    ss << std::put_time(&tm, "%d-%m-%Y %H:%M:%S");
    return ss.str();
  }

◆ get_error_code()

std::string dunedaq::snbmodules::TransferMetadata::get_error_code ( ) const

inline

Definition at line 265 of file transfer_metadata.hpp.

265{ return m_error_code; }

dunedaq::snbmodules::TransferMetadata::m_error_code

std::string m_error_code

show the error exception in case of error

Definition transfer_metadata.hpp:337

◆ get_file_name()

std::string dunedaq::snbmodules::TransferMetadata::get_file_name ( ) const

inline

Definition at line 252 of file transfer_metadata.hpp.

252{ return m_file_path.filename().string(); }

◆ get_file_path()

std::filesystem::path dunedaq::snbmodules::TransferMetadata::get_file_path ( ) const

inline

Definition at line 251 of file transfer_metadata.hpp.

251{ return m_file_path; }

◆ get_group_id()

std::string dunedaq::snbmodules::TransferMetadata::get_group_id ( ) const

inline

Definition at line 260 of file transfer_metadata.hpp.

260{ return m_group_id; }

◆ get_hash()

std::string dunedaq::snbmodules::TransferMetadata::get_hash ( ) const

inline

Definition at line 253 of file transfer_metadata.hpp.

253{ return m_hash; }

◆ get_magnet_link()

std::string dunedaq::snbmodules::TransferMetadata::get_magnet_link ( ) const

inline

Definition at line 259 of file transfer_metadata.hpp.

259{ return m_magnet_link; }

dunedaq::snbmodules::TransferMetadata::m_magnet_link

std::string m_magnet_link

Magnet link of the file only for bit torrent.

Definition transfer_metadata.hpp:331

◆ get_progress()

int dunedaq::snbmodules::TransferMetadata::get_progress ( ) const

inline

Definition at line 261 of file transfer_metadata.hpp.

  {
    return m_bytes_size == 0 ? 0 : static_cast<int>(m_bytes_transferred * 100 / m_bytes_size);
  }

◆ get_size()

uint64_t dunedaq::snbmodules::TransferMetadata::get_size ( ) const

inline

Definition at line 256 of file transfer_metadata.hpp.

256{ return m_bytes_size; }

◆ get_src()

IPFormat dunedaq::snbmodules::TransferMetadata::get_src ( ) const

inline

Definition at line 254 of file transfer_metadata.hpp.

254{ return m_src; }

◆ get_start_time()

int64_t dunedaq::snbmodules::TransferMetadata::get_start_time ( ) const

inline

Definition at line 280 of file transfer_metadata.hpp.

280{ return m_start_time; }

dunedaq::snbmodules::TransferMetadata::m_start_time

int64_t m_start_time

Start time of the transfer, 0 if not started, reset if resumed.

Definition transfer_metadata.hpp:340

◆ get_start_time_str()

std::string dunedaq::snbmodules::TransferMetadata::get_start_time_str ( ) const

inline

Definition at line 282 of file transfer_metadata.hpp.

  {
    if (m_start_time == 0) {
      return "N/A";
    }
    std::time_t t = m_start_time / 1000;
    std::tm tm = *std::localtime(&t);
    std::stringstream ss;
    ss << std::put_time(&tm, "%d-%m-%Y %H:%M:%S");
    return ss.str();
  }

◆ get_status()

status_type::e_status dunedaq::snbmodules::TransferMetadata::get_status ( ) const

inline

Definition at line 258 of file transfer_metadata.hpp.

258{ return m_status; }

◆ get_total_duration_ms()

int64_t dunedaq::snbmodules::TransferMetadata::get_total_duration_ms ( ) const

inline

Definition at line 267 of file transfer_metadata.hpp.

  {
    if (m_start_time == 0) {
      return 0;
    } else if (m_end_time == 0) {
      return m_duration +
             (std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::system_clock::now().time_since_epoch())
                .count() -
              m_start_time);
    } else {
      return m_end_time - m_start_time;
    }
  }

◆ get_transmission_speed()

int32_t dunedaq::snbmodules::TransferMetadata::get_transmission_speed ( ) const

inline

Definition at line 266 of file transfer_metadata.hpp.

266{ return m_transmission_speed; }

dunedaq::snbmodules::TransferMetadata::m_transmission_speed

int32_t m_transmission_speed

Transmission speed in bytes/s.

Definition transfer_metadata.hpp:319

◆ load_metadata_from_meta_file()

void dunedaq::snbmodules::TransferMetadata::load_metadata_from_meta_file ( std::filesystem::path src )

overridevirtual

Load metadata file from src.

Parameters

src

Implements dunedaq::snbmodules::MetadataAbstract.

Definition at line 131 of file transfer_metadata.cpp.

{
  std::ifstream metadata_file;
  try {
    metadata_file.open(src.string());
  } catch (const std::exception& e) {
    ers::error(MetadataFileNotFoundError(ERS_HERE, e.what()));
    return;
  }
 
  std::stringstream buffer;
  buffer << metadata_file.rdbuf();
 
  from_string(buffer.str());
 
  metadata_file.close();
}

◆ operator<()

bool dunedaq::snbmodules::TransferMetadata::operator< ( MetadataAbstract const & other ) const

inlineoverridevirtual

Operator < overload.

Parameters

other

Returns

Implements dunedaq::snbmodules::MetadataAbstract.

Definition at line 56 of file transfer_metadata.hpp.

  {
    auto o = dynamic_cast<const TransferMetadata&>(other);
    return m_file_path.string().compare(o.m_file_path.string());
  }

◆ operator==()

bool dunedaq::snbmodules::TransferMetadata::operator== ( MetadataAbstract const & other ) const

inlineoverridevirtual

Operator ==.

Implements dunedaq::snbmodules::MetadataAbstract.

Definition at line 47 of file transfer_metadata.hpp.

  {
    auto o = dynamic_cast<const TransferMetadata&>(other);
    return m_file_path == o.m_file_path && m_src == o.m_src && m_dest == o.m_dest && m_group_id == o.m_group_id;
  }

◆ set_bytes_transferred()

void dunedaq::snbmodules::TransferMetadata::set_bytes_transferred ( uint64_t bytes_transferred )

inline

Definition at line 176 of file transfer_metadata.hpp.

  {
    m_bytes_transferred = bytes_transferred;
    m_modified_fields["bytes_transferred"] = true;
  }

◆ set_dest()

void dunedaq::snbmodules::TransferMetadata::set_dest ( const IPFormat & dest )

inline

Definition at line 154 of file transfer_metadata.hpp.

  {
    // Check if the dest is not equal to the source
    if (!(dest == m_src)) {
      m_dest = dest;
    } else {
      throw std::invalid_argument("The destination cannot be equal to the source");
    }
  }

◆ set_duration()

void dunedaq::snbmodules::TransferMetadata::set_duration ( int64_t duration )

inline

Definition at line 232 of file transfer_metadata.hpp.

  {
    m_duration = duration;
    m_modified_fields["duration"] = true;
  }

◆ set_end_time()

void dunedaq::snbmodules::TransferMetadata::set_end_time ( int64_t end_time )

inline

Definition at line 244 of file transfer_metadata.hpp.

  {
    m_end_time = end_time;
    m_modified_fields["end_time"] = true;
  }

◆ set_error_code()

void dunedaq::snbmodules::TransferMetadata::set_error_code ( std::string error_code )

inline

Definition at line 220 of file transfer_metadata.hpp.

  {
    m_error_code = std::move(error_code);
    m_modified_fields["error_code"] = true;
  }

◆ set_file_path()

void dunedaq::snbmodules::TransferMetadata::set_file_path ( const std::filesystem::path & file_path )

inline

Definition at line 126 of file transfer_metadata.hpp.

  {
    // remove all occurences of ./ in the file path
    std::string file_path_str = file_path.string();
    std::string x = "./";
 
    size_t pos = 0;
    while (true) {
      pos = file_path_str.find(x, pos);
      if (pos == std::string::npos) {
        break;
      }
 
      file_path_str.replace(pos, x.length(), "");
    }
    m_file_path = std::filesystem::absolute(file_path_str);
  }

◆ set_group_id()

void dunedaq::snbmodules::TransferMetadata::set_group_id ( std::string group_id )

inline

Definition at line 143 of file transfer_metadata.hpp.

143{ m_group_id = std::move(group_id); }

◆ set_hash()

void dunedaq::snbmodules::TransferMetadata::set_hash ( std::string hash )

inline

Definition at line 164 of file transfer_metadata.hpp.

  {
    m_hash = std::move(hash);
    m_modified_fields["hash"] = true;
  }

◆ set_magnet_link()

void dunedaq::snbmodules::TransferMetadata::set_magnet_link ( std::string magnet_link )

inline

Definition at line 214 of file transfer_metadata.hpp.

  {
    m_magnet_link = std::move(magnet_link);
    m_modified_fields["magnet_link"] = true;
  }

◆ set_progress()

void dunedaq::snbmodules::TransferMetadata::set_progress ( int purcent )

inline

Definition at line 182 of file transfer_metadata.hpp.

  {
    if (purcent < 0 || purcent > 100) {
      throw std::invalid_argument("The progress must be between 0 and 100");
    }
    set_bytes_transferred((purcent * m_bytes_size) / 100);
  }

◆ set_size()

void dunedaq::snbmodules::TransferMetadata::set_size ( uint64_t size )

inline

Definition at line 170 of file transfer_metadata.hpp.

  {
    m_bytes_size = size;
    m_modified_fields["size"] = true;
  }

◆ set_src()

void dunedaq::snbmodules::TransferMetadata::set_src ( const IPFormat & source )

inline

Definition at line 144 of file transfer_metadata.hpp.

  {
    // Check if the source is not equal to the dest
    if (!(source == m_dest)) {
      m_src = source;
    } else {
      throw std::invalid_argument("The source cannot be equal to the destination");
    }
  }

◆ set_start_time()

void dunedaq::snbmodules::TransferMetadata::set_start_time ( int64_t start_time )

inline

Definition at line 238 of file transfer_metadata.hpp.

  {
    m_start_time = start_time;
    m_modified_fields["start_time"] = true;
  }

◆ set_status()

void dunedaq::snbmodules::TransferMetadata::set_status ( status_type::e_status status )

inline

Definition at line 190 of file transfer_metadata.hpp.

  {
    m_status = status;
    if (status == status_type::e_status::DOWNLOADING || status == status_type::e_status::UPLOADING) {
      m_start_time =
        std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::system_clock::now().time_since_epoch())
          .count();
    }
    if (status == status_type::e_status::FINISHED || status == status_type::e_status::ERROR) {
      m_end_time =
        std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::system_clock::now().time_since_epoch())
          .count();
      m_duration += m_end_time - m_start_time;
    }
    if (status == status_type::e_status::PAUSED) {
      m_duration +=
        std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::system_clock::now().time_since_epoch())
          .count() -
        m_start_time;
    }
 
    m_modified_fields["status"] = true;
  }

◆ set_transmission_speed()

void dunedaq::snbmodules::TransferMetadata::set_transmission_speed ( int32_t transmission_speed )

inline

Definition at line 226 of file transfer_metadata.hpp.

  {
    m_transmission_speed = transmission_speed;
    m_modified_fields["transmission_speed"] = true;
  }

Member Data Documentation

◆ m_bytes_size

uint64_t dunedaq::snbmodules::TransferMetadata::m_bytes_size = 0

private

Total size of the file in bytes.

Definition at line 313 of file transfer_metadata.hpp.

◆ m_bytes_transferred

uint64_t dunedaq::snbmodules::TransferMetadata::m_bytes_transferred = 0

private

Number of bytes transferred or received.

Definition at line 316 of file transfer_metadata.hpp.

◆ m_dest

IPFormat dunedaq::snbmodules::TransferMetadata::m_dest = IPFormat()

private

Destination of the file transfer, not always initialized.

Definition at line 328 of file transfer_metadata.hpp.

◆ m_duration

int64_t dunedaq::snbmodules::TransferMetadata::m_duration = 0

private

Duration of the transfer.

Definition at line 346 of file transfer_metadata.hpp.

◆ m_end_time

int64_t dunedaq::snbmodules::TransferMetadata::m_end_time = 0

private

End time of the transfer, 0 if not finished.

Definition at line 343 of file transfer_metadata.hpp.

◆ m_error_code

std::string dunedaq::snbmodules::TransferMetadata::m_error_code = ""

private

show the error exception in case of error

Definition at line 337 of file transfer_metadata.hpp.

◆ m_file_extension

const std::string dunedaq::snbmodules::TransferMetadata::m_file_extension = ".tmetadata"

static

Definition at line 32 of file transfer_metadata.hpp.

◆ m_file_path

std::filesystem::path dunedaq::snbmodules::TransferMetadata::m_file_path = ""

private

Path of the file on the src filesystem.

Definition at line 307 of file transfer_metadata.hpp.

◆ m_group_id

std::string dunedaq::snbmodules::TransferMetadata::m_group_id = ""

private

Group id of the file, used to group files together.

Definition at line 334 of file transfer_metadata.hpp.

◆ m_hash

std::string dunedaq::snbmodules::TransferMetadata::m_hash = ""

private

TODO : Hash of the file sha1.

Definition at line 310 of file transfer_metadata.hpp.

◆ m_magnet_link

std::string dunedaq::snbmodules::TransferMetadata::m_magnet_link = ""

private

Magnet link of the file only for bit torrent.

Definition at line 331 of file transfer_metadata.hpp.

◆ m_modified_fields

std::map<std::string, bool> dunedaq::snbmodules::TransferMetadata::m_modified_fields

private

Initial value:

= {
    { "file_path", false },         { "hash", false },       { "bytes_size", false },
    { "bytes_transferred", false }, { "status", false },     { "magnet_link", false },
    { "group_id", false },          { "error_code", false }, { "transmission_speed", false },
    { "start_time", false },        { "end_time", false },   { "duration", false }
  }

Vector of modified fields in order : to send only the modified fields.

Definition at line 349 of file transfer_metadata.hpp.

                                              {
    { "file_path", false },         { "hash", false },       { "bytes_size", false },
    { "bytes_transferred", false }, { "status", false },     { "magnet_link", false },
    { "group_id", false },          { "error_code", false }, { "transmission_speed", false },
    { "start_time", false },        { "end_time", false },   { "duration", false }
  };

◆ m_src

IPFormat dunedaq::snbmodules::TransferMetadata::m_src = IPFormat()

private

Source of the file transfer.

Definition at line 325 of file transfer_metadata.hpp.

◆ m_start_time

int64_t dunedaq::snbmodules::TransferMetadata::m_start_time = 0

private

Start time of the transfer, 0 if not started, reset if resumed.

Definition at line 340 of file transfer_metadata.hpp.

◆ m_status

status_type::e_status dunedaq::snbmodules::TransferMetadata::m_status = status_type::e_status::WAITING

private

Status of the file transfer.

Definition at line 322 of file transfer_metadata.hpp.

◆ m_transmission_speed

int32_t dunedaq::snbmodules::TransferMetadata::m_transmission_speed = 0

private

Transmission speed in bytes/s.

Definition at line 319 of file transfer_metadata.hpp.

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

/github/workspace/dunedaq/sourcecode/snbmodules/include/snbmodules/transfer_metadata.hpp
/github/workspace/dunedaq/sourcecode/snbmodules/src/common/transfer_metadata.cpp

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TransferMetadata() [1/2]

◆ TransferMetadata() [2/2]

◆ ~TransferMetadata()

Member Function Documentation

◆ export_to_string()

◆ export_to_string_partial()

◆ from_string()

◆ generate_metadata_file()

◆ get_bytes_transferred()

◆ get_dest()

◆ get_end_time()

◆ get_end_time_str()

◆ get_error_code()

◆ get_file_name()

◆ get_file_path()

◆ get_group_id()

◆ get_hash()

◆ get_magnet_link()

◆ get_progress()

◆ get_size()

◆ get_src()

◆ get_start_time()

◆ get_start_time_str()

◆ get_status()

◆ get_total_duration_ms()

◆ get_transmission_speed()

◆ load_metadata_from_meta_file()

◆ operator<()

◆ operator==()

◆ set_bytes_transferred()

◆ set_dest()

◆ set_duration()

◆ set_end_time()

◆ set_error_code()

◆ set_file_path()

◆ set_group_id()

◆ set_hash()

◆ set_magnet_link()

◆ set_progress()

◆ set_size()

◆ set_src()

◆ set_start_time()

◆ set_status()

◆ set_transmission_speed()

Member Data Documentation

◆ m_bytes_size

◆ m_bytes_transferred

◆ m_dest

◆ m_duration

◆ m_end_time

◆ m_error_code

◆ m_file_extension

◆ m_file_path

◆ m_group_id

◆ m_hash

◆ m_magnet_link

◆ m_modified_fields

◆ m_src

◆ m_start_time

◆ m_status

◆ m_transmission_speed