Network.Protocol.Snmp.AgentX.MIBTree

Documentation

type MIBTree = StateT Module

MIBTree, state transformer, with Module under ground

Module

data Module

internal state for build SNMP submodule

Instances

Show Module

create and init Module

mkModule

Arguments

:: (Monad m, MonadIO m, Functor m)

=> OID

base module OID

-> [MIB]

all MIB for create module

-> m Module

Constructor for Module

initModule :: (Monad m, MonadIO m, Functor m) => MIBTree m ()

build tree and init module

registerFullTree :: (Monad m, MonadIO m, Functor m) => MIBTree m ()

register all MIBs in snmp server

unregisterFullTree :: (Monad m, MonadIO m, Functor m) => MIBTree m ()

askTree :: (Monad m, MonadIO m, Functor m) => MIBTree m (Tree IValue)

regByDiff :: (Monad m, MonadIO m, Functor m) => Tree IValue -> Tree IValue -> MIBTree m ()

lenses for Module

moduleOID :: forall cat. ArrowApply cat => Lens cat Module OID

register :: forall cat. ArrowApply cat => Lens cat Module (MVar ([(OID, Maybe Context)], [(OID, Maybe Context)]))

zipper :: forall cat. ArrowApply cat => Lens cat Module (Zipper Tree IValue)

ou :: forall cat. ArrowApply cat => Lens cat Module (Zipper Tree IUpdate)

functions for work with MIBTree

findOne

Arguments

:: (Monad m, MonadIO m, Functor m)

=> OID

path for find

-> Maybe Context

context, you can have many values with one path and different context

-> MIBTree m MIB

find one MIB

findMany :: (Monad m, MonadIO m, Functor m) => [OID] -> Maybe Context -> MIBTree m [MIB]

like findOne, but for many paths

findNext

Arguments

:: (Monad m, MonadIO m, Functor m)

=> SearchRange

SearchRange (getwalk or getnext requests)

-> Maybe Context

context

-> MIBTree m MIB

search result

find next node in MIBTree

findManyNext :: (Monad m, MonadIO m, Functor m) => [SearchRange] -> Maybe Context -> MIBTree m [MIB]

like findNext

MIB

type Parent = String

type Name = String

data MIB

MIB describe objects and object-types in internal tree with data.

Instances

Show MIB

lenses

oi :: MIB -> OID

accessor for OID

val :: MIB -> PVal

accessor for PVal

context :: MIB -> Maybe Context

accessor for Maybe Context

constructors

mkObject

Arguments

:: Integer

OID number for this object

-> Parent

parent name for this object

-> Name

name for this object

-> Maybe Update

Just Update if you need dynamic module

-> MIB

created MIB

Constructor for MIB, create Object in mib tree

mkObjectType

Arguments

:: Integer

OID number for this object

-> Parent

parent

-> Name

name

-> Maybe Context

context

-> PVal

value

-> MIB

created MIB

Constructor for MIB, create Object-Type in mib tree

isObjectType :: MIB -> Bool

check MIB subtype

raw values for build SNMP subagent

newtype Update

Update, for rebuild oid tree in runtime

Constructors

Update

Fields

unUpdate :: forall m. (Monad m, MonadIO m, Functor m) => m [MIB]

Instances

Show Update

data PVal

Wrapper for value

Constructors

Read

Fields

readAIO :: IO Value

ReadWrite

Fields

readAIO :: IO Value

commitSetAIO :: Value -> IO CommitError

testSetAIO :: Value -> IO TestError

undoSetAIO :: Value -> IO UndoError

Instances

Show PVal

isWritable :: PVal -> Bool

check for PVal

helpers for create PVal

rsValue :: Value -> PVal

PVal constructor for read only value

rdValue :: IO Value -> PVal

PVal constructor for read only IO Value

rwValue :: IO Value -> (Value -> IO CommitError) -> (Value -> IO TestError) -> (Value -> IO UndoError) -> PVal

PVal constructor for read write value

regWrapper :: (Monad m, MonadIO m, Functor m) => MIBTree m x -> MIBTree m x

wrap MIBTree action, get MIB tree before and after, register added mibs, unregister removed mibs

mibToVarBind :: (Monad m, MonadIO m, Functor m) => MIB -> m VarBind

convert MIB to VarBind