upload::SpoolerResult Struct Reference

#include <upload_spooler_result.h>

Collaboration diagram for upload::SpoolerResult:

Public Member Functions
	SpoolerResult (const int return_code=-1, const std::string &local_path="", const shash::Any &digest=shash::Any(), const FileChunkList &file_chunks=FileChunkList(), const zlib::Algorithms compression_alg=zlib::kZlibDefault)
bool	IsChunked () const

Public Attributes
int	return_code
	the return value of the spooler operation More...
std::string	local_path
	the local_path previously given as input More...
shash::Any	content_hash
FileChunkList	file_chunks
	the file chunks generated during processing More...
zlib::Algorithms	compression_alg

Detailed Description

This data structure will be passed to every callback spoolers will invoke. It encapsulates the results of a spooler command along with the given local_path to identify the spooler action performed.

Note: When the return_code is different from 0 the content_hash is most likely undefined, Null or rubbish.

Definition at line 23 of file upload_spooler_result.h.

Constructor & Destructor Documentation

upload::SpoolerResult::SpoolerResult ( const int  return_code = -1, const std::string &  local_path = "", const shash::Any &  digest = shash::Any(), const FileChunkList &  file_chunks = FileChunkList(), const zlib::Algorithms  compression_alg = zlib::kZlibDefault  )

inlineexplicit

Definition at line 24 of file upload_spooler_result.h.

Member Function Documentation

bool upload::SpoolerResult::IsChunked ( ) const

inline

Definition at line 36 of file upload_spooler_result.h.

Referenced by publish::SyncMediator::PublishFilesCallback(), publish::SyncMediator::PublishHardlinksCallback(), swissknife::CommandTag::UploadClosure(), and swissknife::CommandMigrate::UploadHistoryClosure().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

zlib::Algorithms upload::SpoolerResult::compression_alg

Definition at line 45 of file upload_spooler_result.h.

Referenced by publish::SyncMediator::PublishFilesCallback(), and publish::SyncMediator::PublishHardlinksCallback().

shash::Any upload::SpoolerResult::content_hash

The content_hash of the bulk file derived during processing

Definition at line 43 of file upload_spooler_result.h.

Referenced by catalog::WritableCatalogManager::CatalogUploadCallback(), SigningTool::CertificateUploadCallback(), catalog::WritableCatalogManager::CopyCatalogToLocalCache(), SigningTool::MetainfoUploadCallback(), publish::OnProcessCertificate(), publish::OnProcessHistory(), publish::OnProcessMetainfo(), publish::SyncMediator::PublishFilesCallback(), publish::SyncMediator::PublishHardlinksCallback(), swissknife::anonymous_namespace{swissknife_pull.cc}::SpoolerOnUpload(), swissknife::CommandMigrate::UploadCallback(), swissknife::CommandTag::UploadClosure(), and swissknife::CommandMigrate::UploadHistoryClosure().

FileChunkList upload::SpoolerResult::file_chunks

the file chunks generated during processing

Definition at line 44 of file upload_spooler_result.h.

Referenced by IsChunked(), publish::SyncMediator::PublishFilesCallback(), publish::SyncMediator::PublishHardlinksCallback(), and swissknife::CommandMigrate::UploadCallback().

std::string upload::SpoolerResult::local_path

the local_path previously given as input

Definition at line 39 of file upload_spooler_result.h.

Referenced by catalog::WritableCatalogManager::CatalogUploadCallback(), catalog::WritableCatalogManager::CatalogUploadSerializedCallback(), catalog::WritableCatalogManager::CopyCatalogToLocalCache(), publish::SyncMediator::PublishFilesCallback(), publish::SyncMediator::PublishHardlinksCallback(), swissknife::anonymous_namespace{swissknife_pull.cc}::SpoolerOnUpload(), and swissknife::CommandMigrate::UploadCallback().

int upload::SpoolerResult::return_code

the return value of the spooler operation

Definition at line 38 of file upload_spooler_result.h.

Referenced by catalog::WritableCatalogManager::CatalogUploadCallback(), catalog::WritableCatalogManager::CatalogUploadSerializedCallback(), SigningTool::CertificateUploadCallback(), SigningTool::MetainfoUploadCallback(), publish::OnProcessCertificate(), publish::OnProcessHistory(), publish::OnProcessMetainfo(), publish::OnUploadManifest(), publish::OnUploadReflog(), publish::OnUploadWhitelist(), publish::SyncMediator::PublishFilesCallback(), publish::SyncMediator::PublishHardlinksCallback(), swissknife::anonymous_namespace{swissknife_pull.cc}::SpoolerOnUpload(), swissknife::CommandMigrate::UploadCallback(), swissknife::CommandTag::UploadClosure(), and swissknife::CommandMigrate::UploadHistoryClosure().

---

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

• /home/sftnight/jenkins/workspace/CvmfsDoxygen/label/docker-x86_64/cvmfs/cvmfs/upload_spooler_result.h