inspect::
#include <tree_handler_settings.h>
TreeServerSendPreference describes how the Inspect VMO should be served.
Summary
TreeServerSendPreference describes how the VMO should be served.
The server has a primary behavior and a failure behavior. These describe the way that the Inspector's VMO handle will be duplicated. The options in general are:
- Frozen: this is copy-on-write.
- Live: updates to the server side VMO propagate to the client. The client is read-only.
- DeepCopy: completely copies the VMO data into a new VMO.
The primary behavior is always configurable. By default, the primary behavior is Frozen.
The failure behavior is configurable when the primary behavior is Frozen. In that case, the failure behavior can be set to either Live or DeepCopy. The default is Live.
The ultimate fallback behavior is always to send a Live VMO.
Constructors and Destructors |
|
|---|---|
TreeServerSendPreference()
Default behavior is to send a Frozen VMO; on failure, it will send a Live VMO.
|
|
TreeServerSendPreference()
Default behavior is to send a Frozen VMO; on failure, it will send a Live VMO.
|
Public types |
|
|---|---|
Type{
|
enum Defines the behavior of the VMO sent over this service. |
Type{
|
enum |
Public functions |
|
|---|---|
FailureBehavior()
|
constexpr cpp17::optional< Type >
|
FailureBehavior()
|
constexpr cpp17::optional< Type >
|
PrimaryBehavior()
|
constexpr Type
|
PrimaryBehavior()
|
constexpr Type
|
Public static functions |
|
|---|---|
DeepCopy()
|
constexpr TreeServerSendPreference
Send a true copy of the VMO.
|
DeepCopy()
|
constexpr TreeServerSendPreference
Send a true copy of the VMO.
|
Frozen(Type failure)
|
constexpr TreeServerSendPreference
Freeze the VMO if possible.
|
Frozen(Type failure)
|
constexpr TreeServerSendPreference
Freeze the VMO if possible.
|
Live()
|
constexpr TreeServerSendPreference
Send a live VMO.
|
Live()
|
constexpr TreeServerSendPreference
Send a live VMO.
|
Public types
Type
Type
Type
Type
Public functions
FailureBehavior
constexpr cpp17::optional< Type > FailureBehavior()
FailureBehavior
constexpr cpp17::optional< Type > FailureBehavior()
PrimaryBehavior
constexpr Type PrimaryBehavior()
PrimaryBehavior
constexpr Type PrimaryBehavior()
TreeServerSendPreference
TreeServerSendPreference()=default
Default behavior is to send a Frozen VMO; on failure, it will send a Live VMO.
TreeServerSendPreference
TreeServerSendPreference()=default
Default behavior is to send a Frozen VMO; on failure, it will send a Live VMO.
Public static functions
Frozen
constexpr TreeServerSendPreference Frozen( Type failure )
Freeze the VMO if possible.
On failure, do failure. failure should not be Type::Frozen.
Frozen
constexpr TreeServerSendPreference Frozen( Type failure )
Freeze the VMO if possible.
On failure, do failure. failure should not be Type::Frozen.