Struct ciruela::cluster::Connection

pub struct Connection { /* fields omitted */ }

Connection to a server or cluster of servers

Ciruela automatically manages a number of connections according to configs and the operations over connection (i.e. images currently uploading).

Methods

impl Connection

pub fn new<R, I, B>(     initial_address: Vec<Name>,     resolver: R,     index_source: I,     block_source: B,     config: &Arc<Config> ) -> Connection where     I: GetIndex + Clone + Send + 'static,     B: GetBlock + Clone + Send + 'static,     R: Resolve + HostResolve + Clone + Send + 'static,

Create a connection pool object

Warning: constructor should run on loop provieded by tk_easyloop. In future, tokio will provide implicit loop reference on it's own.

The actual underlying connections are established when specific operation is requested. Also you don't need to specify all node name in the cluster, they will be discovered.

There are two common patterns:

1. [preferred] Use a DNS name that resolves to a full list of IP addresses. Common DNS servers randomize them and only spill few of the adressses because of DNS package size limit, but that's fine, as we only need 3 or so of them.
2. Specify 3-5 server names and leave the discover to ciruela itself.

While you can specify a name that refers to only one address, it's not a very good idea (unless you really have one server) because the server you're connecting to may fail.

pub fn append(&self, upload: SignedUpload) -> Upload

Initiate a new upload (appending a directory)

Panics

If connection set is already closed

pub fn append_weak(&self, upload: SignedUpload) -> Upload

Initiate a new upload (appending a directory, if not exists)

This is basically same as 'append()` but ignores errors when directory already exists (or currently downloading) but has different contents.

Panics

If connection set is already closed

pub fn replace(&self, upload: SignedUpload) -> Upload

Initiate a new upload (replacing a directory)

Panics

If connection set is already closed

pub fn replace_if_matches(     &self,     upload: SignedUpload,     old_image: ImageId ) -> Upload

Initiate a new upload (replacing if directory hash matches)

Panics

If connection set is already closed

pub fn fetch_index(&self, vpath: &VPath) -> IndexFuture

Fetch index of a directory that is currently on the server

pub fn fetch_file<I, P>(&self, idx: &I, path: P) -> FileFuture where     P: AsRef<Path>,     I: MaterializedIndex,

Fetch file relative to the index

Panics

Panics if there is no such file in the index

Trait Implementations

impl Debug for Connection

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

Formats the value using the given formatter.

impl Clone for Connection

fn clone(&self) -> Connection

Returns a copy of the value.

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

Performs copy-assignment from source.