net-spider-rpl-0.4.1.5: NetSpider data model and utility for RPL networks
MaintainerToshio Ito <debug.ito@gmail.com>
Safe HaskellNone
LanguageHaskell2010

NetSpider.RPL.DIO

Contents

Description

 
Synopsis

Types

type FoundNodeDIO = FoundNode FindingID DIONode DIOLink Source #

FoundNode for a network described by DIOs.

type SnapshotGraphDIO = SnapshotGraph FindingID DIONode MergedDIOLink Source #

SnapshotGraph for a network described by DIOs. This is what you get by dioDefQuery.

data DIONode Source #

Node attributes about DIO.

Constructors

DIONode 

Fields

Instances

Instances details
Eq DIONode Source # 
Instance details

Defined in NetSpider.RPL.DIO

Methods

(==) :: DIONode -> DIONode -> Bool #

(/=) :: DIONode -> DIONode -> Bool #

Ord DIONode Source # 
Instance details

Defined in NetSpider.RPL.DIO

Methods

compare :: DIONode -> DIONode -> Ordering #

(<) :: DIONode -> DIONode -> Bool #

(<=) :: DIONode -> DIONode -> Bool #

(>) :: DIONode -> DIONode -> Bool #

(>=) :: DIONode -> DIONode -> Bool #

max :: DIONode -> DIONode -> DIONode #

min :: DIONode -> DIONode -> DIONode #

Show DIONode Source # 
Instance details

Defined in NetSpider.RPL.DIO

Methods

showsPrec :: Int -> DIONode -> ShowS #

show :: DIONode -> String #

showList :: [DIONode] -> ShowS #

Generic DIONode Source # 
Instance details

Defined in NetSpider.RPL.DIO

Associated Types

type Rep DIONode :: Type -> Type #

Methods

from :: DIONode -> Rep DIONode x #

to :: Rep DIONode x -> DIONode #

ToJSON DIONode Source #

Since: 0.4.1.0

Instance details

Defined in NetSpider.RPL.DIO

Methods

toJSON :: DIONode -> Value #

toEncoding :: DIONode -> Encoding #

toJSONList :: [DIONode] -> Value #

toEncodingList :: [DIONode] -> Encoding #

FromJSON DIONode Source #

Since: 0.4.1.0

Instance details

Defined in NetSpider.RPL.DIO

Methods

parseJSON :: Value -> Parser DIONode #

parseJSONList :: Value -> Parser [DIONode] #

NodeAttributes DIONode Source # 
Instance details

Defined in NetSpider.RPL.DIO

Methods

writeNodeAttributes :: DIONode -> Binder (Walk SideEffect VFoundNode VFoundNode) #

parseNodeAttributes :: PMap Multi GValue -> Parser DIONode #

ToAttributes DIONode Source # 
Instance details

Defined in NetSpider.RPL.DIO

Methods

toAttributes :: DIONode -> [(AttributeKey, AttributeValue)] #

type Rep DIONode Source # 
Instance details

Defined in NetSpider.RPL.DIO

type Rep DIONode = D1 ('MetaData "DIONode" "NetSpider.RPL.DIO" "net-spider-rpl-0.4.1.5-B5a2IBJNeg2FPRyWz1obDc" 'False) (C1 ('MetaCons "DIONode" 'PrefixI 'True) (S1 ('MetaSel ('Just "rank") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Rank) :*: S1 ('MetaSel ('Just "dioInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TrickleInterval)))

data DIOLink Source #

Link attributes about DIO.

Basically this represents information of a neighbor learned from the DIOs it has sent.

Constructors

DIOLink 

Fields

  • neighborType :: NeighborType

    Type of the neighbor at the other end of this link.

  • neighborRank :: Rank

    Observed rank of the neighbor.

  • metric :: Maybe Rank

    Link metric of this link, calculated as step of Rank. Because Rank computation is up to the Objective Function, this field is optional.

Instances

dioLinkState :: DIOLink -> LinkState Source #

LinkState that should be set for given DIOLink.

data MergedDIOLink Source #

Link attributes merging two DIOLinks from the two end nodes of the link.

Constructors

MergedDIOLink 

Fields

Instances

type Rank = Word Source #

RPL rank

type TrickleInterval = Word Source #

The interval of Trickle timer as decribed as number of doublings of the minimum interval, i.e. log2(I / Imin).

Since: 0.2.1.0

data NeighborType Source #

Classification of RPL neighbors.

Constructors

PreferredParent

The neighbor is the preferred parent.

ParentCandidate

The neighbor is not the preferred parent, but is in the parent set.

OtherNeighbor

The neighbor is not in the parent set.

Instances

Instances details
Bounded NeighborType Source # 
Instance details

Defined in NetSpider.RPL.DIO

Methods

minBound :: NeighborType #

maxBound :: NeighborType #

Enum NeighborType Source # 
Instance details

Defined in NetSpider.RPL.DIO

Methods

succ :: NeighborType -> NeighborType #

pred :: NeighborType -> NeighborType #

toEnum :: Int -> NeighborType #

fromEnum :: NeighborType -> Int #

enumFrom :: NeighborType -> [NeighborType] #

enumFromThen :: NeighborType -> NeighborType -> [NeighborType] #

enumFromTo :: NeighborType -> NeighborType -> [NeighborType] #

enumFromThenTo :: NeighborType -> NeighborType -> NeighborType -> [NeighborType] #

Eq NeighborType Source # 
Instance details

Defined in NetSpider.RPL.DIO

Methods

(==) :: NeighborType -> NeighborType -> Bool #

(/=) :: NeighborType -> NeighborType -> Bool #

Ord NeighborType Source # 
Instance details

Defined in NetSpider.RPL.DIO

Methods

compare :: NeighborType -> NeighborType -> Ordering #

(<) :: NeighborType -> NeighborType -> Bool #

(<=) :: NeighborType -> NeighborType -> Bool #

(>) :: NeighborType -> NeighborType -> Bool #

(>=) :: NeighborType -> NeighborType -> Bool #

max :: NeighborType -> NeighborType -> NeighborType #

min :: NeighborType -> NeighborType -> NeighborType #

Show NeighborType Source # 
Instance details

Defined in NetSpider.RPL.DIO

Methods

showsPrec :: Int -> NeighborType -> ShowS #

show :: NeighborType -> String #

showList :: [NeighborType] -> ShowS #

Generic NeighborType Source # 
Instance details

Defined in NetSpider.RPL.DIO

Associated Types

type Rep NeighborType :: Type -> Type #

Methods

from :: NeighborType -> Rep NeighborType x #

to :: Rep NeighborType x -> NeighborType #

ToJSON NeighborType Source #

Encode to a JSON string.

Since: 0.4.0.0

Instance details

Defined in NetSpider.RPL.DIO

Methods

toJSON :: NeighborType -> Value #

toEncoding :: NeighborType -> Encoding #

toJSONList :: [NeighborType] -> Value #

toEncodingList :: [NeighborType] -> Encoding #

FromJSON NeighborType Source #

Decode from a JSON string.

Since: 0.4.1.0

Instance details

Defined in NetSpider.RPL.DIO

Methods

parseJSON :: Value -> Parser NeighborType #

parseJSONList :: Value -> Parser [NeighborType] #

FromGraphSON NeighborType Source #

Since: 0.4.0.0

Instance details

Defined in NetSpider.RPL.DIO

Methods

parseGraphSON :: GValue -> Parser NeighborType #

LinkAttributes NeighborType Source # 
Instance details

Defined in NetSpider.RPL.DIO

Methods

writeLinkAttributes :: NeighborType -> Binder (Walk SideEffect EFinds EFinds) #

parseLinkAttributes :: PMap Single GValue -> Parser NeighborType #

type Rep NeighborType Source # 
Instance details

Defined in NetSpider.RPL.DIO

type Rep NeighborType = D1 ('MetaData "NeighborType" "NetSpider.RPL.DIO" "net-spider-rpl-0.4.1.5-B5a2IBJNeg2FPRyWz1obDc" 'False) (C1 ('MetaCons "PreferredParent" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ParentCandidate" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OtherNeighbor" 'PrefixI 'False) (U1 :: Type -> Type)))

neighborTypeToText :: NeighborType -> Text Source #

neighborTypeFromText :: Text -> Maybe NeighborType Source #

Query

dioDefQuery Source #

Arguments

:: [FindingID]

startsFrom field.

-> Query FindingID DIONode DIOLink MergedDIOLink 

Default Query for DIO nodes.

dioUnifierConf :: UnifyStdConfig FindingID DIONode DIOLink MergedDIOLink () Source #

UnifyStdConfig for RPL DIO data. Used in defQuery.