View Source FDB.Network (fdb v6.3.23-0)
FoundationDB C API uses event loop architecture. All the network io operations are handled by a singleton network thread. This module provides functions to configure, start and stop the network thread. The functions should be called in the order given below
:ok = FDB.select_api_version()
# zero or more calls to set network options
:ok = FDB.Network.set_option(FDB.Option.network_option_trace_enable())
:ok = FDB.Network.setup()
:ok = FDB.Network.run()
Link to this section Summary
Functions
Should be called after FDB.Network.setup/0
. This function should
be called only once.
Refer FDB.Option
for the list of options. Any option that starts with network_option_
is allowed.
Refer FDB.Option
for the list of options. Any option that starts with network_option_
is allowed.
Should be called after FDB.select_api_version/1
and zero or more
calls to FDB.Network.set_option/1
or
FDB.Network.set_option/2
. This function should be called only
once.
Stops the network thread. Once stopped the network thread cannot be restarted again.
Link to this section Functions
Specs
run() :: :ok
Should be called after FDB.Network.setup/0
. This function should
be called only once.
Specs
set_option(FDB.Option.key()) :: :ok
Refer FDB.Option
for the list of options. Any option that starts with network_option_
is allowed.
Specs
set_option(FDB.Option.key(), FDB.Option.value()) :: :ok
Refer FDB.Option
for the list of options. Any option that starts with network_option_
is allowed.
Specs
setup() :: :ok
Should be called after FDB.select_api_version/1
and zero or more
calls to FDB.Network.set_option/1
or
FDB.Network.set_option/2
. This function should be called only
once.
Specs
stop() :: :ok
Stops the network thread. Once stopped the network thread cannot be restarted again.