Public, validated descriptor for attaching to one remote file channel.
More...
#include <StormByte/network/remote_file_mount.hxx>
Public, validated descriptor for attaching to one remote file channel.
Decode this value from the application response with StormByte::Serializable. It contains no server filesystem path.
◆ ChannelToken
Fixed-width opaque channel capability.
◆ Access
Permitted direction for this mounted channel.
| Enumerator |
|---|
| None | No channel capability is present.
|
| Read | Client may read from the mounted file.
|
| Write | Client may write to the mounted file.
|
◆ Status
Outcome of the application-authorized mount request.
| Enumerator |
|---|
| Authorized | Channel was authorized and mounted.
|
| NotAuthorized | Application policy denied the request.
|
| Unavailable | Requested read file does not exist.
|
| FileBeingRead | Writer rejected because one or more readers are mounted.
|
| FileBeingWritten | Reader/writer rejected because an exclusive writer is mounted.
|
| Failed | Mount failed for a reason other than authorization or path conflict.
|
◆ RemoteFileMount() [1/2]
| StormByte::Network::RemoteFileMount::RemoteFileMount |
( |
const RemoteFileMount & | other | ) |
|
Copy a validated mount descriptor.
- Parameters
-
◆ RemoteFileMount() [2/2]
| StormByte::Network::RemoteFileMount::RemoteFileMount |
( |
RemoteFileMount && | other | ) |
|
|
noexcept |
Move a validated mount descriptor.
- Parameters
-
| other | Descriptor to move; fixed-width fields remain valid. |
◆ ~RemoteFileMount()
| StormByte::Network::RemoteFileMount::~RemoteFileMount |
( |
| ) |
|
|
noexcept |
Out-of-line destructor anchors the non-trivial codec type.
◆ Failed()
Construct a non-authorization mount failure.
- Returns
- Failed mount descriptor without channel credentials.
◆ FileBeingRead()
Construct a result for a write blocked by mounted readers.
- Returns
- Descriptor reporting a reader conflict.
◆ FileBeingWritten()
Construct a result for a mount blocked by an exclusive writer.
- Returns
- Descriptor reporting a writer conflict.
◆ MaximumTimeoutSeconds()
| std::uint16_t StormByte::Network::RemoteFileMount::MaximumTimeoutSeconds |
( |
| ) |
const |
|
noexcept |
Maximum idle interval for the Client's peer data-plane heartbeat.
- Returns
- Maximum idle interval in seconds.
◆ Mode()
| Access StormByte::Network::RemoteFileMount::Mode |
( |
| ) |
const |
|
noexcept |
Authorized access mode.
- Returns
- Permitted channel direction.
◆ NotAuthorized()
Construct an application-level authorization denial.
- Returns
- Descriptor without channel credentials.
◆ operator=() [1/2]
Copy-assign a validated mount descriptor.
- Parameters
-
- Returns
- This descriptor.
◆ operator=() [2/2]
Move-assign a validated mount descriptor.
- Parameters
-
| other | Descriptor to move; fixed-width fields remain valid. |
- Returns
- This descriptor.
◆ Port()
| std::uint16_t StormByte::Network::RemoteFileMount::Port |
( |
| ) |
const |
|
noexcept |
Session data-plane port shared by every Authorized mount from one Client.
- Returns
- Shared port, or zero when rejected.
◆ Result()
| Status StormByte::Network::RemoteFileMount::Result |
( |
| ) |
const |
|
noexcept |
Mount request result.
- Returns
- Result of the mount request.
◆ Token()
| const ChannelToken & StormByte::Network::RemoteFileMount::Token |
( |
| ) |
const |
|
noexcept |
Opaque capability checked by the private channel protocol.
- Returns
- Reference to the channel token.
◆ Unavailable()
Construct a missing-file result without channel credentials.
- Returns
- Unavailable mount descriptor.
◆ Server
Server may construct authorized mount descriptors.
◆ StormByte::Detail::Codec< RemoteFileMount >
Wire codec may access validated descriptor fields.
The documentation for this class was generated from the following file: