Struct pallet_im_online::HeartbeatStatus

pub(crate) struct HeartbeatStatus<BlockNumber> {
    pub session_index: SessionIndex,
    pub sent_at: BlockNumber,
}

Status of the offchain worker code.

This stores the block number at which heartbeat was requested and when the worker has actually managed to produce it. Note we store such status for every authority_index separately.

Fields

session_index: SessionIndex

An index of the session that we are supposed to send heartbeat for.

sent_at: BlockNumber

A block number at which the heartbeat for that session has been actually sent.

It may be 0 in case the sending failed. In such case we should just retry as soon as possible (i.e. in a worker running for the next block).

Implementations

impl<BlockNumber: PartialEq + AtLeast32BitUnsigned + Copy> HeartbeatStatus<BlockNumber>

pub(crate) fn is_recent( &self, session_index: SessionIndex, now: BlockNumber, ) -> bool

Returns true if heartbeat has been recently sent.

Parameters: session_index - index of current session. now - block at which the offchain worker is running.

This function will return true iff:

1. the session index is the same (we don’t care if it went up or down)
2. the heartbeat has been sent recently (within the threshold)

The reasoning for 1. is that it’s better to send an extra heartbeat than to stall or not send one in case of a bug.

Trait Implementations

impl<BlockNumber: Clone> Clone for HeartbeatStatus<BlockNumber>

fn clone(&self) -> HeartbeatStatus<BlockNumber>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<BlockNumber> Debug for HeartbeatStatus<BlockNumber>

where BlockNumber: Debug,

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

Formats the value using the given formatter.

impl<BlockNumber> Decode for HeartbeatStatus<BlockNumber>

where BlockNumber: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<BlockNumber> Encode for HeartbeatStatus<BlockNumber>

where BlockNumber: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<BlockNumber: PartialEq> PartialEq for HeartbeatStatus<BlockNumber>

fn eq(&self, other: &HeartbeatStatus<BlockNumber>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<BlockNumber> TypeInfo for HeartbeatStatus<BlockNumber>

where BlockNumber: TypeInfo + 'static,

type Identity = HeartbeatStatus<BlockNumber>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<BlockNumber> EncodeLike for HeartbeatStatus<BlockNumber>

where BlockNumber: Encode,

impl<BlockNumber: Eq> Eq for HeartbeatStatus<BlockNumber>

impl<BlockNumber> StructuralPartialEq for HeartbeatStatus<BlockNumber>