File-like buffered reader backed by a peer DataPlane and mount token. More...
#include <StormByte/network/remote_file.hxx>


Public Member Functions | |
| BufferedRemoteFileReader (const BufferedRemoteFileReader &)=delete | |
| Copy construction is disabled. | |
| BufferedRemoteFileReader (BufferedRemoteFileReader &&)=delete | |
| Move construction is disabled while a mount token is registered. | |
| BufferedRemoteFileReader & | operator= (const BufferedRemoteFileReader &)=delete |
| Copy assignment is disabled. | |
| BufferedRemoteFileReader & | operator= (BufferedRemoteFileReader &&)=delete |
| Move assignment is disabled while a mount token is registered. | |
| ~BufferedRemoteFileReader () noexcept override | |
| Release this leaf's token before base destruction. | |
| Public Member Functions inherited from StormByte::Buffer::IO::BufferedLocationReader | |
| BufferedLocationReader (const BufferedLocationReader &)=delete | |
| BufferedLocationReader (BufferedLocationReader &&other) noexcept | |
| virtual | ~BufferedLocationReader () noexcept override |
| BufferedLocationReader & | operator= (const BufferedLocationReader &)=delete |
| BufferedLocationReader & | operator= (BufferedLocationReader &&other) noexcept |
| StormByte::Safe::Shared< StormByte::System::Device > | Device () const |
| Public Member Functions inherited from StormByte::Buffer::IO::BufferedReader | |
| 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 |
| BufferedReader (const BufferedReader &)=delete | |
| BufferedReader (BufferedReader &&other) noexcept | |
| virtual | ~BufferedReader () noexcept |
| BufferedReader & | operator= (const BufferedReader &)=delete |
| BufferedReader & | operator= (BufferedReader &&other) noexcept |
| virtual bool | Open () final |
| virtual Result | Close () final |
| virtual bool | Rewind () final |
| virtual bool | IsOpen () const noexcept final |
| virtual bool | IsReadable () const noexcept final |
| virtual bool | EoF () const noexcept final |
| virtual StormByte::ByteSize | Available () const noexcept final |
| virtual Result | Read (StormByte::ByteSize n, FIFO &dest) const final |
| virtual Result | Read (std::span< std::byte > dest) const final |
| virtual Result | Peek (StormByte::ByteSize n, FIFO &dest) const final |
| virtual Result | Peek (std::span< std::byte > dest) const final |
| virtual Result | Seek (std::ptrdiff_t offset, Position mode) const final |
| virtual StormByte::ByteSize | Tell () const noexcept final |
| virtual bool | IsSeekable () const noexcept final |
| virtual bool | IsSized () const noexcept final |
| virtual StormByte::Safe::Optional< StormByte::ByteSize > | Size () const noexcept final |
| const StormByte::Safe::Shared< StormByte::Buffer::ReadTelemetry > | Telemetry () const noexcept |
| StormByte::ByteSize | ReadAhead () const noexcept |
| StormByte::ByteSize | ReadChunk () const noexcept |
| void | ReadChunk (StormByte::ByteSize bytes) |
| ReaderConfiguration | Configuration () const noexcept |
| Result | Configure (ReaderConfiguration configuration) |
| TransferSnapshot | Transfers () const noexcept |
| void | ReadAhead (StormByte::ByteSize bytes) |
| StormByte::ByteSize | MaxMemory () const noexcept |
| void | MaxMemory (StormByte::ByteSize bytes) |
| std::chrono::milliseconds | MaxWait () const noexcept |
| void | MaxWait (std::chrono::milliseconds wait) |
| BufferedReader (const BufferedReader &)=delete | |
| BufferedReader (BufferedReader &&other) noexcept | |
| virtual | ~BufferedReader () noexcept |
| BufferedReader & | operator= (const BufferedReader &)=delete |
| BufferedReader & | operator= (BufferedReader &&other) noexcept |
| virtual bool | Open () final |
| virtual Result | Close () final |
| virtual bool | Rewind () final |
| virtual bool | IsOpen () const noexcept final |
| virtual bool | IsReadable () const noexcept final |
| virtual bool | EoF () const noexcept final |
| virtual StormByte::ByteSize | Available () const noexcept final |
| virtual Result | Read (StormByte::ByteSize n, FIFO &dest) const final |
| virtual Result | Read (std::span< std::byte > dest) const final |
| virtual Result | Peek (StormByte::ByteSize n, FIFO &dest) const final |
| virtual Result | Peek (std::span< std::byte > dest) const final |
| virtual Result | Seek (std::ptrdiff_t offset, Position mode) const final |
| virtual StormByte::ByteSize | Tell () const noexcept final |
| virtual bool | IsSeekable () const noexcept final |
| virtual bool | IsSized () const noexcept final |
| virtual StormByte::Safe::Optional< StormByte::ByteSize > | Size () const noexcept final |
| const StormByte::Safe::Shared< StormByte::Buffer::ReadTelemetry > | Telemetry () const noexcept |
| StormByte::ByteSize | ReadAhead () const noexcept |
| StormByte::ByteSize | ReadChunk () const noexcept |
| void | ReadChunk (StormByte::ByteSize bytes) |
| ReaderConfiguration | Configuration () const noexcept |
| Result | Configure (ReaderConfiguration configuration) |
| TransferSnapshot | Transfers () const noexcept |
| void | ReadAhead (StormByte::ByteSize bytes) |
| 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 the token's server-side reader handle. | |
| Buffer::IO::Result | OriginClose () override |
| Release this reader token without closing the peer plane. | |
| Buffer::IO::Result | OriginPull (StormByte::ByteSize count, Buffer::FIFO &destination) override |
| Pull one protocol-bounded segment at this leaf's absolute logical offset. | |
| Buffer::IO::Result | OriginSeek (std::ptrdiff_t offset, Buffer::Position mode) override |
| Move only this Buffer leaf's logical cursor. | |
| StormByte::Safe::Optional< StormByte::ByteSize > | OriginSize () const noexcept override |
| Query the server-side file length. | |
| Protected Member Functions inherited from StormByte::Buffer::IO::BufferedLocationReader | |
| BufferedLocationReader (StormByte::Safe::String path, enum Location location, Unpacked knobs) | |
| bool | OriginCanSeek () const noexcept final |
| bool | OriginHasSize () const noexcept final |
| void | Setup () final |
| Protected Member Functions inherited from StormByte::Buffer::IO::BufferedReader | |
| STORMBYTE_FORCE_INLINE | BufferedReader (StormByte::Safe::String path, enum Location location, Parameters parameters={}) |
| BufferedReader (StormByte::Safe::String path, enum Location location, ReaderConfiguration configuration) | |
| void | SetState (enum State state) noexcept |
| virtual StormByte::Safe::Shared< StormByte::Buffer::ReadTelemetry > | CreateTelemetry () const |
Friends | |
| class | Client |
| Client may construct mounted reader 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 reader backed by a peer DataPlane and mount token.
The peer-scoped data plane owns the socket and heartbeat; each leaf has one capability and an independent logical file offset.
|
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 reader token without closing the peer plane.
Implements StormByte::Buffer::IO::BufferedReader.
|
overrideprotectedvirtual |
Network-interface snapshot for this connected origin.
Implements StormByte::Buffer::IO::BufferedLocationReader.
|
overrideprotectedvirtualnoexcept |
Accept the network device without probing its accessor as a filesystem path.
| device | Origin device to check. |
Reimplemented from StormByte::Buffer::IO::BufferedLocationReader.
|
overrideprotectedvirtual |
Open the token's server-side reader handle.
Implements StormByte::Buffer::IO::BufferedReader.
|
overrideprotectedvirtual |
Pull one protocol-bounded segment at this leaf's absolute logical offset.
| count | Maximum number of bytes to read. |
| destination | FIFO receiving the bytes. |
Implements StormByte::Buffer::IO::BufferedReader.
|
overrideprotectedvirtual |
Move only this Buffer leaf's logical cursor.
| offset | Signed displacement relative to the selected position. |
| mode | Reference position for the displacement. |
Implements StormByte::Buffer::IO::BufferedReader.
|
overrideprotectedvirtualnoexcept |
Query the server-side file length.
Implements StormByte::Buffer::IO::BufferedReader.
|
friend |