Struct HostContainer 

pub struct HostContainer {
    pub(super) hostlists: [RwLock<Vec<(Url, u64)>>; 5],
}

A Container for managing Grey, White, Gold and Black hostlists. Exposes a common interface for writing to and querying hostlists.

Fields

hostlists: [RwLock<Vec<(Url, u64)>>; 5]

Implementations

impl HostContainer

fn new() -> Self

fn store(&self, color: usize, addr: Url, last_seen: u64)

Append host to a hostlist. Called when initalizing the hostlist in load_hosts().

fn store_or_update(&self, color: HostColor, addr: Url, last_seen: u64)

Stores an address on a hostlist or updates its last_seen field if we already have the address.

pub fn update_last_seen(&self, color: usize, addr: Url, last_seen: u64)

Update the last_seen field of a peer on a hostlist.

pub fn fetch_all(&self, color: HostColor) -> Vec<(Url, u64)>

Return all known hosts on a hostlist.

pub fn fetch_last(&self, color: HostColor) -> Option<(Url, u64)>

Get the oldest entry from a hostlist.

pub(super) fn fetch_with_schemes( &self, color: usize, schemes: &[String], limit: Option<usize>, ) -> Vec<(Url, u64)>

Get up to limit peers that match the given transport schemes from a hostlist. If limit was not provided, return all matching peers.

fn fetch_excluding_schemes( &self, color: usize, schemes: &[String], limit: Option<usize>, ) -> Vec<(Url, u64)>

Get up to limit peers that don’t match the given transport schemes from a hostlist. If limit was not provided, return all matching peers.

pub(super) fn fetch_random_with_schemes( &self, color: HostColor, schemes: &[String], ) -> Option<((Url, u64), usize)>

Get a random peer from a hostlist that matches the given transport schemes.

pub(super) fn fetch_n_random(&self, color: HostColor, n: u32) -> Vec<(Url, u64)>

Get up to n random peers. Schemes are not taken into account.

pub(super) fn fetch_n_random_with_schemes( &self, color: HostColor, schemes: &[String], n: u32, ) -> Vec<(Url, u64)>

Get up to n random peers that match the given transport schemes.

pub(super) fn fetch_n_random_excluding_schemes( &self, color: HostColor, schemes: &[String], n: u32, ) -> Vec<(Url, u64)>

Get up to n random peers that don’t match the given transport schemes from a hostlist.

pub fn remove_if_exists(&self, color: HostColor, addr: &Url)

Remove an entry from a hostlist if it exists.

pub fn is_empty(&self, color: HostColor) -> bool

Check if a hostlist is empty.

pub fn contains(&self, color: usize, addr: &Url) -> bool

Check if host is in a hostlist

pub fn get_index_at_addr(&self, color: usize, addr: Url) -> Option<usize>

Get the index for a given addr on a hostlist.

pub fn get_last_seen(&self, color: usize, addr: &Url) -> Option<u64>

Get the last_seen field for a given entry on a hostlist.

fn sort_by_last_seen(&self, color: usize)

Sort a hostlist by last_seen.

fn resize(&self, color: HostColor)

Remove the last item on a hostlist if it reaches max size.

fn refresh(&self, color: HostColor, max_age: u64)

Delete items from a hostlist that are older than a specified maximum. Maximum should be specified in seconds.

pub(super) fn load_all(&self, path: &str) -> Result<()>

Load the hostlists from a file.

pub(super) fn save_all(&self, path: &str) -> Result<()>

Save the hostlist to a file.

pub(super) fn mix_host( addr: &Url, transports: &[String], mixed_transports: &[String], tor_socks5_proxy: &Option<Url>, nym_socks5_proxy: &Option<Url>, ) -> Vec<Url>

Performs transport mixing for an url returning a list of addresses with mixed transports. For example we’re allowed to use tor:// to connect to tcp:// and tor+tls:// to connect to tcp+tls:// or socks5:// to connect to tor://. However, do not mix tor:// and tcp+tls://, nor tor+tls:// and tcp://.