Enum foundationdb::options::NetworkOption

pub enum NetworkOption {
    LocalAddress(String),
    ClusterFile(String),
    TraceEnable(String),
    TraceRollSize(u32),
    TraceMaxLogsSize(u32),
    TraceLogGroup(String),
    Knob(String),
    TlsPlugin(String),
    TlsCertByte(Vec<u8>),
    TlsCertPath(String),
    TlsKeyByte(Vec<u8>),
    TlsKeyPath(String),
    TlsVerifyPeer(Vec<u8>),
    BuggifyEnable,
    BuggifyDisable,
    BuggifySectionActivatedProbability(u32),
    BuggifySectionFiredProbability(u32),
    DisableMultiVersionClientApi,
    CallbacksOnExternalThread,
    ExternalClientLibrary(String),
    ExternalClientDirectory(String),
    DisableLocalClient,
    DisableClientStatisticsLogging,
    EnableSlowTaskProfiling,
}

Variants

LocalAddress(String)

IP:PORT

Deprecated

ClusterFile(String)

path to cluster file

Deprecated

TraceEnable(String)

path to output directory (or NULL for current working directory)

Enables trace output to a file in a directory of the clients choosing

TraceRollSize(u32)

max size of a single trace output file

Sets the maximum size in bytes of a single trace output file. This value should be in the range [0, INT64_MAX]. If the value is set to 0, there is no limit on individual file size. The default is a maximum size of 10,485,760 bytes.

TraceMaxLogsSize(u32)

max total size of trace files

Sets the maximum size of all the trace output files put together. This value should be in the range [0, INT64_MAX]. If the value is set to 0, there is no limit on the total size of the files. The default is a maximum size of 104,857,600 bytes. If the default roll size is used, this means that a maximum of 10 trace files will be written at a time.

TraceLogGroup(String)

value of the logGroup attribute

Sets the ‘logGroup’ attribute with the specified value for all events in the trace output files. The default log group is ‘default’.

Knob(String)

knob_name=knob_value

Set internal tuning or debugging knobs

TlsPlugin(String)

file path or linker-resolved name

Set the TLS plugin to load. This option, if used, must be set before any other TLS options

TlsCertByte(Vec<u8>)

certificates

Set the certificate chain

TlsCertPath(String)

file path

Set the file from which to load the certificate chain

TlsKeyByte(Vec<u8>)

key

Set the private key corresponding to your own certificate

TlsKeyPath(String)

file path

Set the file from which to load the private key corresponding to your own certificate

TlsVerifyPeer(Vec<u8>)

verification pattern

Set the peer certificate field verification criteria

BuggifyEnable

BuggifyDisable

BuggifySectionActivatedProbability(u32)

probability expressed as a percentage between 0 and 100

Set the probability of a BUGGIFY section being active for the current execution. Only applies to code paths first traversed AFTER this option is changed.

BuggifySectionFiredProbability(u32)

probability expressed as a percentage between 0 and 100

Set the probability of an active BUGGIFY section being fired

DisableMultiVersionClientApi

Disables the multi-version client API and instead uses the local client directly. Must be set before setting up the network.

CallbacksOnExternalThread

If set, callbacks from external client libraries can be called from threads created by the FoundationDB client library. Otherwise, callbacks will be called from either the thread used to add the callback or the network thread. Setting this option can improve performance when connected using an external client, but may not be safe to use in all environments. Must be set before setting up the network. WARNING: This feature is considered experimental at this time.

ExternalClientLibrary(String)

path to client library

Adds an external client library for use by the multi-version client API. Must be set before setting up the network.

ExternalClientDirectory(String)

path to directory containing client libraries

Searches the specified path for dynamic libraries and adds them to the list of client libraries for use by the multi-version client API. Must be set before setting up the network.

DisableLocalClient

Prevents connections through the local client, allowing only connections through externally loaded client libraries. Intended primarily for testing.

DisableClientStatisticsLogging

Disables logging of client statistics, such as sampled transaction activity.

EnableSlowTaskProfiling

Enables debugging feature to perform slow task profiling. Requires trace logging to be enabled. WARNING: this feature is not recommended for use in production.

Implementations

impl NetworkOption

pub fn code(&self) -> FDBNetworkOption

pub unsafe fn apply(&self) -> Result<(), Error>

Trait Implementations

impl Clone for NetworkOption

fn clone(&self) -> NetworkOption

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NetworkOption

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.