toxcore-0.2.11: A Tox protocol implementation in Haskell
Safe HaskellSafe-Inferred
LanguageHaskell2010

Network.Tox.DHT.NodeList

Documentation

class NodeList l where Source #

Minimal complete definition

addNode, removeNode, viable, baseKey, traverseClientLists, closeNodes

Methods

addNode :: Timestamp -> NodeInfo -> l -> l Source #

removeNode :: PublicKey -> l -> l Source #

viable :: NodeInfo -> l -> Bool Source #

baseKey :: l -> PublicKey Source #

traverseClientLists :: Applicative f => (ClientList -> f ClientList) -> l -> f l Source #

closeNodes :: PublicKey -> l -> [(Distance, NodeInfo)] Source #

'closeNodes pub' returns the (pub',node) pairs of the Node List in increasing order of distance of pub' from pub.

foldMapClientLists :: Monoid m => (ClientList -> m) -> l -> m Source #

copied from Data.Traversable.foldMapDefault

foldlClientLists :: (a -> ClientList -> a) -> a -> l -> a Source #

copied from Data.Foldable.foldl

nodeListList :: l -> [NodeInfo] Source #

foldNodes :: (a -> NodeInfo -> a) -> a -> l -> a Source #

lookupPublicKey :: PublicKey -> l -> Maybe NodeInfo Source #

Instances

Instances details
NodeList ClientList Source # 
Instance details

Defined in Network.Tox.DHT.NodeList

Methods

addNode :: Timestamp -> NodeInfo -> ClientList -> ClientList Source #

removeNode :: PublicKey -> ClientList -> ClientList Source #

viable :: NodeInfo -> ClientList -> Bool Source #

baseKey :: ClientList -> PublicKey Source #

traverseClientLists :: Applicative f => (ClientList -> f ClientList) -> ClientList -> f ClientList Source #

closeNodes :: PublicKey -> ClientList -> [(Distance, NodeInfo)] Source #

foldMapClientLists :: Monoid m => (ClientList -> m) -> ClientList -> m Source #

foldlClientLists :: (a -> ClientList -> a) -> a -> ClientList -> a Source #

nodeListList :: ClientList -> [NodeInfo] Source #

foldNodes :: (a -> NodeInfo -> a) -> a -> ClientList -> a Source #

lookupPublicKey :: PublicKey -> ClientList -> Maybe NodeInfo Source #

NodeList KBuckets Source # 
Instance details

Defined in Network.Tox.DHT.NodeList

Methods

addNode :: Timestamp -> NodeInfo -> KBuckets -> KBuckets Source #

removeNode :: PublicKey -> KBuckets -> KBuckets Source #

viable :: NodeInfo -> KBuckets -> Bool Source #

baseKey :: KBuckets -> PublicKey Source #

traverseClientLists :: Applicative f => (ClientList -> f ClientList) -> KBuckets -> f KBuckets Source #

closeNodes :: PublicKey -> KBuckets -> [(Distance, NodeInfo)] Source #

foldMapClientLists :: Monoid m => (ClientList -> m) -> KBuckets -> m Source #

foldlClientLists :: (a -> ClientList -> a) -> a -> KBuckets -> a Source #

nodeListList :: KBuckets -> [NodeInfo] Source #

foldNodes :: (a -> NodeInfo -> a) -> a -> KBuckets -> a Source #

lookupPublicKey :: PublicKey -> KBuckets -> Maybe NodeInfo Source #

NodeList DhtState Source #

although it is not referred to as a Node List in the spec, we make DhtState an instance of NodeList so we can use the traversal and folding functions.

Instance details

Defined in Network.Tox.DHT.DhtState

Methods

addNode :: Timestamp -> NodeInfo -> DhtState -> DhtState Source #

removeNode :: PublicKey -> DhtState -> DhtState Source #

viable :: NodeInfo -> DhtState -> Bool Source #

baseKey :: DhtState -> PublicKey Source #

traverseClientLists :: Applicative f => (ClientList -> f ClientList) -> DhtState -> f DhtState Source #

closeNodes :: PublicKey -> DhtState -> [(Distance, NodeInfo)] Source #

foldMapClientLists :: Monoid m => (ClientList -> m) -> DhtState -> m Source #

foldlClientLists :: (a -> ClientList -> a) -> a -> DhtState -> a Source #

nodeListList :: DhtState -> [NodeInfo] Source #

foldNodes :: (a -> NodeInfo -> a) -> a -> DhtState -> a Source #

lookupPublicKey :: PublicKey -> DhtState -> Maybe NodeInfo Source #