Network.Haskoin.Node.Manager.Logic

Logic and data for peer manager.

Documentation

versionPeerDB :: Word32

Database version.

type Score = Word8

Peer score. Lower is better.

data PeerAddress

Peer address key in database.

Constructors

PeerAddress

Fields

• getPeerAddress :: !SockAddr

  peer network address and port

PeerAddressBase

Instances

Eq PeerAddress

Defined in Network.Haskoin.Node.Manager.Logic

Methods

(==) :: PeerAddress -> PeerAddress -> Bool

(/=) :: PeerAddress -> PeerAddress -> Bool

Ord PeerAddress

Defined in Network.Haskoin.Node.Manager.Logic

Methods

compare :: PeerAddress -> PeerAddress -> Ordering

(<) :: PeerAddress -> PeerAddress -> Bool

(<=) :: PeerAddress -> PeerAddress -> Bool

(>) :: PeerAddress -> PeerAddress -> Bool

(>=) :: PeerAddress -> PeerAddress -> Bool

max :: PeerAddress -> PeerAddress -> PeerAddress

min :: PeerAddress -> PeerAddress -> PeerAddress

Show PeerAddress

Defined in Network.Haskoin.Node.Manager.Logic

Methods

showsPrec :: Int -> PeerAddress -> ShowS

show :: PeerAddress -> String

showList :: [PeerAddress] -> ShowS

Serialize PeerAddress

Defined in Network.Haskoin.Node.Manager.Logic

Methods

put :: Putter PeerAddress

get :: Get PeerAddress

Key PeerAddress

Defined in Network.Haskoin.Node.Manager.Logic

KeyValue PeerAddress PeerData

Defined in Network.Haskoin.Node.Manager.Logic

data PeerScore

Peer score key in database.

Constructors

PeerScore !Score !SockAddr

PeerScoreBase

Instances

Eq PeerScore

Defined in Network.Haskoin.Node.Manager.Logic

Methods

(==) :: PeerScore -> PeerScore -> Bool

(/=) :: PeerScore -> PeerScore -> Bool

Ord PeerScore

Defined in Network.Haskoin.Node.Manager.Logic

Methods

compare :: PeerScore -> PeerScore -> Ordering

(<) :: PeerScore -> PeerScore -> Bool

(<=) :: PeerScore -> PeerScore -> Bool

(>) :: PeerScore -> PeerScore -> Bool

(>=) :: PeerScore -> PeerScore -> Bool

max :: PeerScore -> PeerScore -> PeerScore

min :: PeerScore -> PeerScore -> PeerScore

Show PeerScore

Defined in Network.Haskoin.Node.Manager.Logic

Methods

showsPrec :: Int -> PeerScore -> ShowS

show :: PeerScore -> String

showList :: [PeerScore] -> ShowS

Serialize PeerScore

Defined in Network.Haskoin.Node.Manager.Logic

Methods

put :: Putter PeerScore

get :: Get PeerScore

Key PeerScore

Defined in Network.Haskoin.Node.Manager.Logic

KeyValue PeerScore ()

Defined in Network.Haskoin.Node.Manager.Logic

data PeerDataVersionKey

Database version key.

Constructors

PeerDataVersionKey

Instances

Eq PeerDataVersionKey

Defined in Network.Haskoin.Node.Manager.Logic

Methods

(==) :: PeerDataVersionKey -> PeerDataVersionKey -> Bool

(/=) :: PeerDataVersionKey -> PeerDataVersionKey -> Bool

Ord PeerDataVersionKey

Defined in Network.Haskoin.Node.Manager.Logic

Methods

compare :: PeerDataVersionKey -> PeerDataVersionKey -> Ordering

(<) :: PeerDataVersionKey -> PeerDataVersionKey -> Bool

(<=) :: PeerDataVersionKey -> PeerDataVersionKey -> Bool

(>) :: PeerDataVersionKey -> PeerDataVersionKey -> Bool

(>=) :: PeerDataVersionKey -> PeerDataVersionKey -> Bool

max :: PeerDataVersionKey -> PeerDataVersionKey -> PeerDataVersionKey

min :: PeerDataVersionKey -> PeerDataVersionKey -> PeerDataVersionKey

Show PeerDataVersionKey

Defined in Network.Haskoin.Node.Manager.Logic

Methods

showsPrec :: Int -> PeerDataVersionKey -> ShowS

show :: PeerDataVersionKey -> String

showList :: [PeerDataVersionKey] -> ShowS

Serialize PeerDataVersionKey

Defined in Network.Haskoin.Node.Manager.Logic

Methods

put :: Putter PeerDataVersionKey

get :: Get PeerDataVersionKey

Key PeerDataVersionKey

Defined in Network.Haskoin.Node.Manager.Logic

KeyValue PeerDataVersionKey Word32

Defined in Network.Haskoin.Node.Manager.Logic

data PeerData

Peer data.

Constructors

PeerData !Score !Bool

Instances

Eq PeerData

Defined in Network.Haskoin.Node.Manager.Logic

Methods

(==) :: PeerData -> PeerData -> Bool

(/=) :: PeerData -> PeerData -> Bool

Ord PeerData

Defined in Network.Haskoin.Node.Manager.Logic

Methods

compare :: PeerData -> PeerData -> Ordering

(<) :: PeerData -> PeerData -> Bool

(<=) :: PeerData -> PeerData -> Bool

(>) :: PeerData -> PeerData -> Bool

(>=) :: PeerData -> PeerData -> Bool

max :: PeerData -> PeerData -> PeerData

min :: PeerData -> PeerData -> PeerData

Show PeerData

Defined in Network.Haskoin.Node.Manager.Logic

Methods

showsPrec :: Int -> PeerData -> ShowS

show :: PeerData -> String

showList :: [PeerData] -> ShowS

Serialize PeerData

Defined in Network.Haskoin.Node.Manager.Logic

Methods

put :: Putter PeerData

get :: Get PeerData

KeyValue PeerAddress PeerData

Defined in Network.Haskoin.Node.Manager.Logic

updatePeerDB :: MonadIO m => DB -> SockAddr -> Score -> Bool -> m ()

Update peer score and pass in database.

newPeerDB :: MonadIO m => DB -> Score -> SockAddr -> m ()

Add a peer to database if it is not already there.

initPeerDB :: MonadUnliftIO m => DB -> Bool -> m ()

Initialize peer database, purging it of conflicting records if version doesn't match current one.

purgePeerDB :: MonadUnliftIO m => DB -> m ()

Purge conflicting records from database.

networkSeeds :: Network -> [HostPort]

Get static network seeds.

staticPeerScore :: Score

Get default score for statically-defined peers.

netSeedScore :: Score

Get default score for network seeds.

netPeerScore :: Score

Get default score for discovered peers.

encodeSockAddr :: SockAddr -> Put

Serialize a network address/port.

decodeSockAddr :: Get SockAddr

Deserialize a network address/port.

getPeerDB :: MonadIO m => DB -> SockAddr -> m (Maybe PeerData)

Get database entry for provided peer address.

promotePeerDB :: MonadIO m => DB -> SockAddr -> m ()

Promote a peer by improving its score (decreasing by one).

demotePeerDB :: MonadIO m => DB -> SockAddr -> m ()

Demote a peer increasing its score by one.

getNewPeerDB :: MonadUnliftIO m => DB -> [SockAddr] -> m (Maybe SockAddr)

Get a peer from database. Pass a list of addresses to exclude.

gotPong :: TVar [OnlinePeer] -> Word64 -> UTCTime -> Peer -> STM (Maybe NominalDiffTime)

Report receiving a pong from a connected peer. Will store ping roundtrip time in a window of latest eleven. Peers are returned by the manager in order of median roundtrip time.

lastPing :: TVar [OnlinePeer] -> Peer -> STM (Maybe UTCTime)

Return time of last ping sent to peer, if any.

setPeerPing :: TVar [OnlinePeer] -> Word64 -> UTCTime -> Peer -> STM ()

Set nonce and time of last ping sent to peer.

setPeerVersion :: TVar [OnlinePeer] -> Peer -> Version -> STM (Either PeerException OnlinePeer)

Set version for online peer. Will set the peer connected status to True if a verack message has already been registered for that peer.

setPeerVerAck :: TVar [OnlinePeer] -> Peer -> STM (Maybe OnlinePeer)

Register that a verack message was received from a peer.

newOnlinePeer

Arguments

:: TVar [OnlinePeer]

-> SockAddr

peer address

-> Word64

nonce sent to peer

-> Peer

peer mailbox

-> Async ()

peer asynchronous handle

-> STM OnlinePeer

Create OnlinePeer data structure.

peerString :: TVar [OnlinePeer] -> Peer -> STM Text

Get a human-readable string for the peer address.

findPeer :: TVar [OnlinePeer] -> Peer -> STM (Maybe OnlinePeer)

Find a connected peer.

insertPeer :: TVar [OnlinePeer] -> OnlinePeer -> STM ()

Insert or replace a connected peer.

modifyPeer :: TVar [OnlinePeer] -> Peer -> (OnlinePeer -> OnlinePeer) -> STM ()

Modify an online peer.

removePeer :: TVar [OnlinePeer] -> Peer -> STM ()

Remove an online peer.

findPeerAsync :: TVar [OnlinePeer] -> Async () -> STM (Maybe OnlinePeer)

Find online peer by asynchronous handle.

removePeerAsync :: TVar [OnlinePeer] -> Async () -> STM ()

Remove online peer by asynchronous handle.