Safe Haskell	None
Language	Haskell2010

Tox.Onion.Path

Synopsis

class (MonadState OnionPathState m, Timed m, MonadRandomBytes m, Keyed m) => OnionPathMonad m
maxPaths :: Int
pathLifetime :: TimeDiff
unconfirmedPathTimeout :: TimeDiff
confirmedPathTimeout :: TimeDiff
data OnionPath = OnionPath {
- pathNodes :: [NodeInfo]
- pathKeys :: [KeyPair]
- pathConfirmed :: Bool
- pathTries :: Int
- pathExpires :: Timestamp
- pathLastAttempt :: Maybe Timestamp
- pathNum :: Word32
}
isPathAlive :: Timestamp -> OnionPath -> Bool
data OnionPathState = OnionPathState {
- announcePaths :: [OnionPath]
- searchPaths :: [OnionPath]
- lastPathNum :: Word32
}
createPath :: MonadRandomBytes m => [NodeInfo] -> Word32 -> Timestamp -> m OnionPath
maintainPaths :: OnionPathMonad m => [NodeInfo] -> m ()
selectPath :: OnionPathMonad m => Bool -> m (Maybe OnionPath)
pickNodes :: MonadRandomBytes m => [NodeInfo] -> m [NodeInfo]
wrapPath :: Keyed m => KeyPair -> OnionPath -> SocketAddress -> Nonce -> CipherText -> m OnionRequest0

Documentation

class (MonadState OnionPathState m, Timed m, MonadRandomBytes m, Keyed m) => OnionPathMonad m Source #

maxPaths :: Int Source #

pathLifetime :: TimeDiff Source #

unconfirmedPathTimeout :: TimeDiff Source #

confirmedPathTimeout :: TimeDiff Source #

data OnionPath Source #

Constructors

OnionPath
Fields pathNodes :: [NodeInfo] pathKeys :: [KeyPair] pathConfirmed :: Bool pathTries :: Int pathExpires :: Timestamp pathLastAttempt :: Maybe Timestamp pathNum :: Word32

Instances

Instances details

Eq OnionPath Source #
Instance details Defined in Tox.Onion.Path Methods (==) :: OnionPath -> OnionPath -> Bool # (/=) :: OnionPath -> OnionPath -> Bool #
Read OnionPath Source #
Instance details Defined in Tox.Onion.Path Methods readsPrec :: Int -> ReadS OnionPath # readList :: ReadS [OnionPath] # readPrec :: ReadPrec OnionPath # readListPrec :: ReadPrec [OnionPath] #
Show OnionPath Source #
Instance details Defined in Tox.Onion.Path Methods showsPrec :: Int -> OnionPath -> ShowS # show :: OnionPath -> String # showList :: [OnionPath] -> ShowS #
Generic OnionPath Source #
Instance details Defined in Tox.Onion.Path Associated Types type Rep OnionPath :: Type -> Type # Methods from :: OnionPath -> Rep OnionPath x # to :: Rep OnionPath x -> OnionPath #
Arbitrary OnionPath Source #
Instance details Defined in Tox.Onion.Path Methods arbitrary :: Gen OnionPath # shrink :: OnionPath -> [OnionPath] #
type Rep OnionPath Source #
Instance details Defined in Tox.Onion.Path type Rep OnionPath = D1 ('MetaData "OnionPath" "Tox.Onion.Path" "toxcore-0.2.12-inplace" 'False) (C1 ('MetaCons "OnionPath" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pathNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [NodeInfo]) :: (S1 ('MetaSel ('Just "pathKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [KeyPair]) :: S1 ('MetaSel ('Just "pathConfirmed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "pathTries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "pathExpires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Timestamp)) :: (S1 ('MetaSel ('Just "pathLastAttempt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Timestamp)) :: S1 ('MetaSel ('Just "pathNum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)))))

isPathAlive :: Timestamp -> OnionPath -> Bool Source #

data OnionPathState Source #

Constructors

OnionPathState
Fields announcePaths :: [OnionPath] searchPaths :: [OnionPath] lastPathNum :: Word32

Instances

Instances details

Eq OnionPathState Source #
Instance details Defined in Tox.Onion.Path Methods (==) :: OnionPathState -> OnionPathState -> Bool # (/=) :: OnionPathState -> OnionPathState -> Bool #
Read OnionPathState Source #
Instance details Defined in Tox.Onion.Path Methods readsPrec :: Int -> ReadS OnionPathState # readList :: ReadS [OnionPathState] # readPrec :: ReadPrec OnionPathState # readListPrec :: ReadPrec [OnionPathState] #
Show OnionPathState Source #
Instance details Defined in Tox.Onion.Path Methods showsPrec :: Int -> OnionPathState -> ShowS # show :: OnionPathState -> String # showList :: [OnionPathState] -> ShowS #
Generic OnionPathState Source #
Instance details Defined in Tox.Onion.Path Associated Types type Rep OnionPathState :: Type -> Type # Methods from :: OnionPathState -> Rep OnionPathState x # to :: Rep OnionPathState x -> OnionPathState #
Arbitrary OnionPathState Source #
Instance details Defined in Tox.Onion.Path Methods arbitrary :: Gen OnionPathState # shrink :: OnionPathState -> [OnionPathState] #
type Rep OnionPathState Source #
Instance details Defined in Tox.Onion.Path type Rep OnionPathState = D1 ('MetaData "OnionPathState" "Tox.Onion.Path" "toxcore-0.2.12-inplace" 'False) (C1 ('MetaCons "OnionPathState" 'PrefixI 'True) (S1 ('MetaSel ('Just "announcePaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [OnionPath]) :: (S1 ('MetaSel ('Just "searchPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [OnionPath]) :: S1 ('MetaSel ('Just "lastPathNum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))))

createPath :: MonadRandomBytes m => [NodeInfo] -> Word32 -> Timestamp -> m OnionPath Source #

maintainPaths :: OnionPathMonad m => [NodeInfo] -> m () Source #

Maintain the set of onion paths.

selectPath :: OnionPathMonad m => Bool -> m (Maybe OnionPath) Source #

Select a random path for sending.

pickNodes :: MonadRandomBytes m => [NodeInfo] -> m [NodeInfo] Source #

Pick 3 random nodes for a path. Returns empty list if not enough nodes.

wrapPath Source #

Arguments

:: Keyed m
=> KeyPair	Our DHT KeyPair
-> OnionPath	The path to follow (A, B, C)
-> SocketAddress	Final destination Node D
-> Nonce	Nonce for all layers
-> CipherText	Final encrypted payload for Node D
-> m OnionRequest0

Wrap data into a nested Onion Request payload.