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.
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 |
|
inline |
| [in] | resource_id | An ID for the resource that's being transferred. |
| [in] | file_path | The target file to update. |
|
overridevirtual |
Handler function that is called by the transfer thread after a read transfer completes.
| [in] | status | A pw::Status object provided by the transfer thread indicating whether the transfer succeeded. |
Reimplemented from pw::transfer::Handler.
Handler function that is called by the transfer thread after a write transfer completes. Atomically updates the target file if the transfer succeeded.
| [in] | status | A pw::Status object provided by the transfer thread indicating whether the transfer succeeded. |
status if the transfer failed and the temporary file was removed. Reimplemented from pw::transfer::Handler.
|
overridevirtual |
Prepares AtomicFileTransferHandler for a read transfer.
AtomicFileTransferHandler is ready for the transfer.Implements pw::transfer::Handler.
|
overridevirtual |
Prepares AtomicFileTransferHandler for a write transfer.
AtomicFileTransferHandler is ready for the transfer. Implements pw::transfer::Handler.