Session

Struct Session 

Source
pub struct Session {
    pub id: NodeId,
    pub addr: Address,
    pub link: Link,
    pub persistent: bool,
    pub state: State,
    pub subscribe: Option<Subscribe>,
    pub last_active: LocalTime,
    pub queue: VecDeque<QueuedFetch>,
    /* private fields */
}
Expand description

A peer session. Each connected peer will have one session.

Fields§

§id: NodeId

Peer id.

§addr: Address

Peer address.

§link: Link

Connection direction.

§persistent: bool

Whether we should attempt to re-connect to this peer upon disconnection.

§state: State

Peer connection state.

§subscribe: Option<Subscribe>

Peer subscription.

§last_active: LocalTime

Last time a message was received from the peer.

§queue: VecDeque<QueuedFetch>

Fetch queue.

Implementations§

Source§

impl Session

Source

pub fn outbound( id: NodeId, addr: Address, persistent: bool, rng: Rng, limits: Limits, ) -> Self

Source

pub fn inbound( id: NodeId, addr: Address, persistent: bool, rng: Rng, time: LocalTime, limits: Limits, ) -> Self

Source

pub fn is_connecting(&self) -> bool

Source

pub fn is_stable(&self) -> bool

Source

pub fn is_connected(&self) -> bool

Source

pub fn is_disconnected(&self) -> bool

Source

pub fn is_initial(&self) -> bool

Source

pub fn is_at_capacity(&self) -> bool

Source

pub fn is_fetching(&self, rid: &RepoId) -> bool

Source

pub fn queue_fetch(&mut self, fetch: QueuedFetch) -> Result<(), QueueError>

Queue a fetch. Returns true if it was added to the queue, and false if it already was present in the queue.

Source

pub fn dequeue_fetch(&mut self) -> Option<QueuedFetch>

Source

pub fn attempts(&self) -> usize

Source

pub fn idle(&mut self, now: LocalTime)

Run ‘idle’ task for session.

Source

pub fn fetching(&mut self, rid: RepoId)

Mark this session as fetching the given RID.

§Panics

If it is already fetching that RID, or the session is disconnected.

Source

pub fn fetched(&mut self, rid: RepoId)

Source

pub fn to_attempted(&mut self)

Source

pub fn to_connected(&mut self, since: LocalTime)

Source

pub fn to_disconnected(&mut self, since: LocalTime, retry_at: LocalTime)

Move the session state to “disconnected”. Returns any pending RID that was requested.

Source

pub fn to_initial(&mut self)

Return to initial state from disconnected state. This state transition happens when we attempt to re-connect to a disconnected peer.

Source

pub fn ping( &mut self, since: LocalTime, reactor: &mut Outbox, ) -> Result<(), Error>

Trait Implementations§

Source§

impl Clone for Session

Source§

fn clone(&self) -> Session

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Session

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Session

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&Session> for Session

Source§

fn from(s: &Session) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ErasedDestructor for T
where T: 'static,