Skip to main content
Pigweed's logo Pigweed
code_xml
  1. Home
  2. Reference
  3. C/C++
  4. Comms
  5. pw_transfer
  6. pw::transfer::AtomicFileTransferHandler Class Reference
pw::transfer::AtomicFileTransferHandler Class Reference

Overview

AtomicFileTransferHandler is intended to be used as a transfer handler for files. It ensures that the target file of the transfer is always in a correct state. In particular, the transfer is first done to a temporary file and once complete, the original targeted file is updated.

Inheritance diagram for pw::transfer::AtomicFileTransferHandler:
pw::transfer::ReadWriteHandler pw::transfer::Handler pw::IntrusiveForwardList< T >::Item

Public Member Functions

 AtomicFileTransferHandler (uint32_t resource_id, std::string_view file_path)
 
 AtomicFileTransferHandler (const AtomicFileTransferHandler &rhs)=delete
 
AtomicFileTransferHandler & operator= (const AtomicFileTransferHandler &)=delete
 
Status PrepareRead () override
 
void FinalizeRead (Status status) override
 
Status PrepareWrite () override
 
Status FinalizeWrite (Status status) override
 
- Public Member Functions inherited from pw::transfer::ReadWriteHandler
constexpr ReadWriteHandler (uint32_t resource_id)
 
 ReadWriteHandler (uint32_t resource_id, stream::ReaderWriter &reader_writer)
 
Status PrepareRead () override
 
Status PrepareWrite () override
 
void set_reader_writer (stream::ReaderWriter &reader_writer)
 
- Public Member Functions inherited from pw::transfer::Handler
constexpr uint32_t id () const
 
virtual Status PrepareRead ()=0
 
virtual Status PrepareRead (uint32_t offset)
 
virtual void FinalizeRead (Status status)
 
virtual Status PrepareWrite ()=0
 
virtual Status PrepareWrite (uint32_t offset)
 
virtual Status FinalizeWrite (Status status)
 
virtual size_t ResourceSize () const
 
virtual Status GetStatus (uint64_t &readable_offset, uint64_t &writeable_offset, uint64_t &read_checksum, uint64_t &write_checksum)
 

Additional Inherited Members

- Protected Member Functions inherited from pw::transfer::Handler
constexpr Handler (uint32_t resource_id, stream::Reader *reader)
 
constexpr Handler (uint32_t resource_id, stream::Writer *writer)
 
void set_reader (stream::Reader &reader)
 
void set_writer (stream::Writer &writer)
 
- Protected Member Functions inherited from pw::IntrusiveForwardList< T >::Item
constexpr Item ()=default
 

Constructor & Destructor Documentation

◆ AtomicFileTransferHandler()

pw::transfer::AtomicFileTransferHandler::AtomicFileTransferHandler ( uint32_t  resource_id,
std::string_view  file_path 
)
inline
Parameters
[in]resource_idAn ID for the resource that's being transferred.
[in]file_pathThe target file to update.

Member Function Documentation

◆ FinalizeRead()

void pw::transfer::AtomicFileTransferHandler::FinalizeRead ( Status  status)
overridevirtual

Handler function that is called by the transfer thread after a read transfer completes.

Parameters
[in]statusA pw::Status object provided by the transfer thread indicating whether the transfer succeeded.
Precondition
The read transfer is done before the call to this method.

Reimplemented from pw::transfer::Handler.

◆ FinalizeWrite()

Status pw::transfer::AtomicFileTransferHandler::FinalizeWrite ( Status  status)
overridevirtual

Handler function that is called by the transfer thread after a write transfer completes. Atomically updates the target file if the transfer succeeded.

Parameters
[in]statusA pw::Status object provided by the transfer thread indicating whether the transfer succeeded.
Precondition
The write transfer is done.
Returns
  • OK: The transfer data was successfully written to the target file.
  • ABORTED: The transfer failed and the temporary file could not be removed.
  • INTERNAL: The target directory could not be created or the temporary file could not be renamed or copied to the target path.
  • Any error status if the transfer failed and the temporary file was removed.

Reimplemented from pw::transfer::Handler.

◆ PrepareRead()

Status pw::transfer::AtomicFileTransferHandler::PrepareRead ( )
overridevirtual

Prepares AtomicFileTransferHandler for a read transfer.

Precondition
The read transfer has not been initialized before the call to this method.
Returns

Implements pw::transfer::Handler.

◆ PrepareWrite()

Status pw::transfer::AtomicFileTransferHandler::PrepareWrite ( )
overridevirtual

Prepares AtomicFileTransferHandler for a write transfer.

Precondition
The write transfer has not been initialized before the call to this method.
Returns

Implements pw::transfer::Handler.


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