File-like buffered writer with an exclusive server-side mount. More...
#include <StormByte/network/remote_file.hxx>


Public Member Functions | |
| BufferedRemoteFileWriter (const BufferedRemoteFileWriter &)=delete | |
| Copy construction is disabled. | |
| BufferedRemoteFileWriter (BufferedRemoteFileWriter &&)=delete | |
| Move construction is disabled while a mount token is registered. | |
| BufferedRemoteFileWriter & | operator= (const BufferedRemoteFileWriter &)=delete |
| Copy assignment is disabled. | |
| BufferedRemoteFileWriter & | operator= (BufferedRemoteFileWriter &&)=delete |
| Move assignment is disabled while a mount token is registered. | |
| ~BufferedRemoteFileWriter () noexcept override | |
| Release this leaf's token before base destruction. | |
| Public Member Functions inherited from StormByte::Buffer::IO::BufferedLocationWriter | |
| BufferedLocationWriter (const BufferedLocationWriter &)=delete | |
| BufferedLocationWriter (BufferedLocationWriter &&other) noexcept | |
| virtual | ~BufferedLocationWriter () noexcept override |
| BufferedLocationWriter & | operator= (const BufferedLocationWriter &)=delete |
| BufferedLocationWriter & | operator= (BufferedLocationWriter &&other) noexcept |
| StormByte::Safe::Shared< StormByte::System::Device > | Device () const |
| bool | IsSeekable () const noexcept |
| bool | IsSized () const noexcept |
| StormByte::ByteSize | Size () const noexcept final |
| Public Member Functions inherited from StormByte::Buffer::IO::BufferedWriter | |
| const StormByte::Safe::String & | Path () const noexcept |
| enum Location | Location () const noexcept |
| virtual | operator bool () const noexcept final |
| virtual enum State | State () const noexcept final |
| BufferedWriter (const BufferedWriter &)=delete | |
| BufferedWriter (BufferedWriter &&other) noexcept | |
| virtual | ~BufferedWriter () noexcept |
| BufferedWriter & | operator= (const BufferedWriter &)=delete |
| BufferedWriter & | operator= (BufferedWriter &&other) noexcept |
| virtual bool | Open () final |
| virtual bool | Close () final |
| virtual bool | Rewind () final |
| virtual bool | IsOpen () const noexcept final |
| virtual Result | Flush () final |
| virtual Result | Truncate () final |
| virtual Result | Write (const FIFO &src) final |
| virtual Result | Write (FIFO &src) final |
| virtual Result | Write (std::span< const std::byte > src) final |
| virtual StormByte::ByteSize | Tell () const noexcept |
| virtual StormByte::ByteSize | Dirty () const noexcept |
| virtual Result | Seek (std::ptrdiff_t offset, Position mode) |
| const StormByte::Safe::Shared< StormByte::Buffer::WriteTelemetry > | Telemetry () const noexcept |
| StormByte::ByteSize | WriteChunk () const noexcept |
| StormByte::ByteSize | WriteTransfer () const noexcept |
| void | WriteTransfer (StormByte::ByteSize bytes) |
| StormByte::ByteSize | WriteThreshold () const noexcept |
| void | WriteThreshold (StormByte::ByteSize bytes) |
| WriterConfiguration | Configuration () const noexcept |
| Result | Configure (WriterConfiguration configuration) |
| TransferSnapshot | Transfers () const noexcept |
| void | WriteChunk (StormByte::ByteSize bytes) |
| std::size_t | BackPressure () const noexcept |
| void | BackPressure (std::size_t chunks) |
| StormByte::ByteSize | MaxMemory () const noexcept |
| void | MaxMemory (StormByte::ByteSize bytes) |
| std::chrono::milliseconds | MaxWait () const noexcept |
| void | MaxWait (std::chrono::milliseconds wait) |
| BufferedWriter (const BufferedWriter &)=delete | |
| BufferedWriter (BufferedWriter &&other) noexcept | |
| virtual | ~BufferedWriter () noexcept |
| BufferedWriter & | operator= (const BufferedWriter &)=delete |
| BufferedWriter & | operator= (BufferedWriter &&other) noexcept |
| virtual bool | Open () final |
| virtual bool | Close () final |
| virtual bool | Rewind () final |
| virtual bool | IsOpen () const noexcept final |
| virtual Result | Flush () final |
| virtual Result | Truncate () final |
| virtual Result | Write (const FIFO &src) final |
| virtual Result | Write (FIFO &src) final |
| virtual Result | Write (std::span< const std::byte > src) final |
| virtual StormByte::ByteSize | Tell () const noexcept |
| virtual StormByte::ByteSize | Dirty () const noexcept |
| virtual Result | Seek (std::ptrdiff_t offset, Position mode) |
| const StormByte::Safe::Shared< StormByte::Buffer::WriteTelemetry > | Telemetry () const noexcept |
| StormByte::ByteSize | WriteChunk () const noexcept |
| StormByte::ByteSize | WriteTransfer () const noexcept |
| void | WriteTransfer (StormByte::ByteSize bytes) |
| StormByte::ByteSize | WriteThreshold () const noexcept |
| void | WriteThreshold (StormByte::ByteSize bytes) |
| WriterConfiguration | Configuration () const noexcept |
| Result | Configure (WriterConfiguration configuration) |
| TransferSnapshot | Transfers () const noexcept |
| void | WriteChunk (StormByte::ByteSize bytes) |
| std::size_t | BackPressure () const noexcept |
| void | BackPressure (std::size_t chunks) |
| StormByte::ByteSize | MaxMemory () const noexcept |
| void | MaxMemory (StormByte::ByteSize bytes) |
| std::chrono::milliseconds | MaxWait () const noexcept |
| void | MaxWait (std::chrono::milliseconds wait) |
Protected Member Functions | |
| StormByte::Safe::Shared< StormByte::System::Device > | OriginDevice () const override |
| Network-interface snapshot for this connected origin. | |
| bool | OriginDeviceUsable (const StormByte::Safe::Shared< StormByte::System::Device > &device) const noexcept override |
| Accept the network device without probing its accessor as a filesystem path. | |
| Buffer::IO::Result | OriginOpen () override |
| Open this writer token on the peer plane. | |
| Buffer::IO::Result | OriginClose () override |
| Release this writer token without closing the peer plane. | |
| Buffer::IO::Result | OriginPush (std::span< const std::byte > data) override |
| Write one protocol-bounded segment at this leaf's absolute logical offset. | |
| Buffer::IO::Result | OriginFlush () override |
| Flush the server-side writer handle. | |
| Buffer::IO::Result | OriginTruncate () override |
| Truncate the server-side file to zero bytes. | |
| Buffer::IO::Result | OriginSeek (StormByte::ByteSize absolute) override |
| Set this Buffer leaf's local writer offset. | |
| StormByte::ByteSize | OriginSize () const noexcept override |
| Query the greater of the server file length and accepted logical write position. | |
| Protected Member Functions inherited from StormByte::Buffer::IO::BufferedLocationWriter | |
| BufferedLocationWriter (StormByte::Safe::String path, enum Location location, Unpacked knobs) | |
| void | Setup () final |
| Protected Member Functions inherited from StormByte::Buffer::IO::BufferedWriter | |
| STORMBYTE_FORCE_INLINE | BufferedWriter (StormByte::Safe::String path, enum Location location, Parameters parameters={}) |
| BufferedWriter (StormByte::Safe::String path, enum Location location, WriterConfiguration configuration) | |
| void | SetState (enum State state) noexcept |
| void | SetTell (StormByte::ByteSize offset) noexcept |
| virtual StormByte::Safe::Shared< StormByte::Buffer::WriteTelemetry > | CreateTelemetry () const |
| virtual bool | WillWrite (StormByte::ByteSize n) const |
Friends | |
| class | Client |
| Client may construct mounted writer leaves. | |
| template<class T, class... Args> | |
| StormByte::Safe::Unique< T > | StormByte::Safe::MakeUnique (Args &&...) |
| Allow the Base heap factory to construct this private Network leaf. | |
File-like buffered writer with an exclusive server-side mount.
|
delete |
Copy construction is disabled.
|
delete |
Move construction is disabled while a mount token is registered.
|
overridenoexcept |
Release this leaf's token before base destruction.
The DataPlane owns the heartbeat.
|
delete |
Move assignment is disabled while a mount token is registered.
|
delete |
Copy assignment is disabled.
|
overrideprotectedvirtual |
Release this writer token without closing the peer plane.
Implements StormByte::Buffer::IO::BufferedWriter.
|
overrideprotectedvirtual |
Network-interface snapshot for this connected origin.
Implements StormByte::Buffer::IO::BufferedLocationWriter.
|
overrideprotectedvirtualnoexcept |
Accept the network device without probing its accessor as a filesystem path.
| device | Origin device to check. |
Reimplemented from StormByte::Buffer::IO::BufferedLocationWriter.
|
overrideprotectedvirtual |
Flush the server-side writer handle.
Implements StormByte::Buffer::IO::BufferedWriter.
|
overrideprotectedvirtual |
Open this writer token on the peer plane.
Implements StormByte::Buffer::IO::BufferedWriter.
|
overrideprotectedvirtual |
Write one protocol-bounded segment at this leaf's absolute logical offset.
| data | Bytes to write. |
Implements StormByte::Buffer::IO::BufferedWriter.
|
overrideprotectedvirtual |
Set this Buffer leaf's local writer offset.
| absolute | Absolute byte offset from the start of the file. |
Implements StormByte::Buffer::IO::BufferedLocationWriter.
|
overrideprotectedvirtualnoexcept |
Query the greater of the server file length and accepted logical write position.
Implements StormByte::Buffer::IO::BufferedLocationWriter.
|
overrideprotectedvirtual |
Truncate the server-side file to zero bytes.
This API does not accept a target size.
Implements StormByte::Buffer::IO::BufferedWriter.
|
friend |