Struct Builder

pub struct Builder { /* private fields */ }

A builder struct for a Server.

The expected sequence of events to bootstrap a server is:

1. Initialize a freqfs::Cache
2. Load the data directory and transactional workspace into the cache
3. Initialize an implementation of RPCClient
4. Create a new Builder with the data directory, workspace, and RPC client
5. Register one or more crate::aes256::Keys to use for symmetric encryption
6. For a secure server, provide links to the user and group authorized to administer the server
7. Load the kernel
8. Start the public interface for the server (e.g. HTTP or HTTPS)
9. Discover peers via mDNS
10. Replicate from the first peer to respond using one of the provided encryption keys 10.1 For each dir, replicate the entries in the dir (not their state, i.e. not recursively) 10.2 Repeat step 10.1 until all directory entries are replicated 10.3 Replicate each chain in each service
11. Send requests to join the replica set authenticated using the hash of the present replica state, all in a single transaction
12. Repeat steps 10-11 until successful
13. Mark the server ready to receive requests from a load balancer
14. Broadcast the server’s availability via mDNS

See the examples dir for usage examples.

Implementations

impl Builder

pub fn load( data_dir: DirLock<CacheBlock>, workspace: DirLock<CacheBlock>, rpc_client: Arc<dyn RPCClient>, ) -> Self

pub async fn build(self) -> Server

pub fn detect_address(self) -> Self

pub fn host(&mut self) -> Host

pub fn set_port(self, port: u16) -> Self

pub fn set_group(self, group: Link) -> Self

pub fn set_owner(self, owner: Link) -> Self

pub fn set_secure(self, secure: bool) -> Self

pub fn with_keys<Keys: IntoIterator<Item = Aes256Key>>(self, keys: Keys) -> Self