Struct MultiPathManager 

pub struct MultiPathManager<F: PathFetcher = PathFetcherImpl>(/* private fields */);

Path manager managing multiple paths per src-dst pair.

Implementations

impl<F: PathFetcher> MultiPathManager<F>

pub fn new( config: MultiPathManagerConfig, fetcher: F, path_strategy: PathStrategy, ) -> Result<Self, MultiPathManagerConfigError>

Creates a new MultiPathManager.

Errors

Returns MultiPathManagerConfigError if config is invalid.

pub fn cached_path( &self, src: IsdAsn, dst: IsdAsn, now: SystemTime, ) -> Option<ScionPath>

Returns the cached active path for the given src-dst pair, if one is available.

If no active path is cached, returns None.

If the src-dst pair is not yet managed, starts managing it.

pub async fn path( &self, src: IsdAsn, dst: IsdAsn, now: SystemTime, ) -> Result<ScionPath, Arc<PathFetchError>>

Gets the active path for the given src-dst pair.

If the src-dst pair is not yet managed, starts managing it, possibly waiting for the first path fetch.

Returns an error if no path is available after waiting.

pub fn weak_ref(&self) -> MultiPathManagerRef<F>

Creates a weak reference to this MultiPathManager.

Upgrade it back to a strong handle with MultiPathManagerRef::upgrade.

pub fn stop_managing_paths(&self, src: IsdAsn, dst: IsdAsn)

Stops managing paths for the given src-dst pair.

Trait Implementations

impl<F> Clone for MultiPathManager<F>

where F: PathFetcher,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: PathFetcher> PathManager for MultiPathManager<F>

fn path_wait( &self, src: IsdAsn, dst: IsdAsn, now: SystemTime, ) -> impl Future<Output = Result<ScionPath, PathWaitError>> + Send + '_

Returns a path to the destination from the path cache or requests a new path from the SCION Control Plane.

fn path_timeout( &self, src: IsdAsn, dst: IsdAsn, now: SystemTime, timeout: Duration, ) -> impl Future<Output = Result<ScionPath, PathWaitTimeoutError>> + Send + '_

Returns a path to the destination from the path cache or requests a new path from the SCION Control Plane, with a maximum wait time.

impl<F: PathFetcher> PathPrefetcher for MultiPathManager<F>

fn prefetch_path(&self, src: IsdAsn, dst: IsdAsn)

Prefetch a path for the given source and destination.

impl<F: PathFetcher> ScmpErrorReceiver for MultiPathManager<F>

fn report_scmp_error( &self, scmp_error: ScmpErrorMessage, _path: ScionDpPathViewRef<'_>, )

Reports a SCMP error. This function must return immediately and not block.

impl<F: PathFetcher> SendErrorReceiver for MultiPathManager<F>

fn report_send_error(&self, error: &ScionSocketSendError)

Reports an error when sending a packet. This function must return immediately and not block.

impl<F: PathFetcher> SyncPathManager for MultiPathManager<F>

fn register_path( &self, _src: IsdAsn, _dst: IsdAsn, _now: SystemTime, _path: ScionPath, )

Add a path to the path cache. This can be used to register reverse paths.

fn try_cached_path( &self, src: IsdAsn, dst: IsdAsn, now: SystemTime, ) -> Result<Option<ScionPath>>

Returns a path to the destination from the path cache. If the path is not in the cache, it returns Ok(None), possibly causing the path to be fetched in the background. If the cache is locked an io error WouldBlock is returned.