Struct solana_gossip::ping_pong::PingCache

pub struct PingCache { /* private fields */ }

Maintains records of remote nodes which have returned a valid response to a ping message, and on-the-fly ping messages pending a pong response from the remote node.

Implementations

impl PingCache

pub fn new(ttl: Duration, rate_limit_delay: Duration, cap: usize) -> Self

pub fn add(&mut self, pong: &Pong, socket: SocketAddr, now: Instant) -> bool

Checks if the pong hash, pubkey and socket match a ping message sent out previously. If so records current timestamp for the remote node and returns true. Note: Does not verify the signature.

pub fn check<T, F>(
    &mut self,
    now: Instant,
    node: (Pubkey, SocketAddr),
    pingf: F
) -> (bool, Option<Ping<T>>)where
    T: Serialize,
    F: FnMut() -> Option<Ping<T>>,

Returns true if the remote node has responded to a ping message. Removes expired pong messages. In order to extend verifications before expiration, if the pong message is not too recent, and the node has not been pinged recently, calls the given function to generates a new ping message, records current timestamp and hash of ping token, and returns the ping message. Caller should verify if the socket address is valid. (e.g. by using ContactInfo::is_valid_address).

pub fn mock_pong(&mut self, node: Pubkey, socket: SocketAddr, now: Instant)

Only for tests and simulations.