peerstatus

Documentation

Overview

Package peerstatus is a threadsafe global cache to store recent peer status messages for access across multiple services.

Index

• func Clear()
• func Count() int
• func Delete(pid peer.ID)
• func FailureCount(pid peer.ID) int
• func Get(pid peer.ID) *pb.Status
• func IncreaseFailureCount(pid peer.ID)
• func IsBadPeer(pid peer.ID) bool
• func Keys() []peer.ID
• func LastUpdated(pid peer.ID) time.Time
• func Set(pid peer.ID, status *pb.Status)

Functions

func Clear

func Clear()

Clear the cache. This method should only be used for tests.

func Count

func Count() int

Count of peer statuses in cache. Threadsafe.

func Delete

func Delete(pid peer.ID)

Delete peer status from cache. Threadsafe.

func FailureCount

func FailureCount(pid peer.ID) int

FailureCount returns the failure count for the particular peer.

func Get

func Get(pid peer.ID) *pb.Status

Get most recent status from peer in cache. Threadsafe.

func IncreaseFailureCount

func IncreaseFailureCount(pid peer.ID)

IncreaseFailureCount increases the failure count for the particular peer.

func IsBadPeer

func IsBadPeer(pid peer.ID) bool

IsBadPeer checks whether the given peer has exceeded the number of bad handshakes threshold.

func Keys

func Keys() []peer.ID

Keys is the list of peer IDs which status exists. Threadsafe.

func LastUpdated

func LastUpdated(pid peer.ID) time.Time

LastUpdated time which the status was set for the given peer. Threadsafe.

func Set

func Set(pid peer.ID, status *pb.Status)

Set most recent status from peer in cache. Threadsafe.