Safe Haskell	None
Language	Haskell2010

Net.Snmp.Client

Synopsis

Documentation

data Session Source #

Constructors

Session
Fields sessionSockets :: !(Chan Socket) sessionSocketCount :: !Int sessionRequestId :: !(TVar RequestId) sessionAesSalt :: !(TVar AesSalt) sessionTimeoutMicroseconds :: !Int sessionMaxTries :: !Int

data Config Source #

Constructors

Config
Fields configSocketPoolSize :: !Int configTimeoutMicroseconds :: !Int configRetries :: !Int

Instances

Eq Config Source #
Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Show Config Source #
Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #

data Destination Source #

Constructors

Destination
Fields destinationHost :: !(Word8, Word8, Word8, Word8) destinationPort :: !Word16

Instances

Eq Destination Source #
Methods (==) :: Destination -> Destination -> Bool # (/=) :: Destination -> Destination -> Bool #
Show Destination Source #
Methods showsPrec :: Int -> Destination -> ShowS # show :: Destination -> String # showList :: [Destination] -> ShowS #

data Credentials Source #

Constructors

CredentialsConstructV2 CredentialsV2
CredentialsConstructV3 CredentialsV3

Instances

Eq Credentials Source #
Methods (==) :: Credentials -> Credentials -> Bool # (/=) :: Credentials -> Credentials -> Bool #
Show Credentials Source #
Methods showsPrec :: Int -> Credentials -> ShowS # show :: Credentials -> String # showList :: [Credentials] -> ShowS #

newtype CredentialsV2 Source #

Constructors

CredentialsV2
Fields credentialsV2CommunityString :: ByteString

Instances

Eq CredentialsV2 Source #
Methods (==) :: CredentialsV2 -> CredentialsV2 -> Bool # (/=) :: CredentialsV2 -> CredentialsV2 -> Bool #
Show CredentialsV2 Source #
Methods showsPrec :: Int -> CredentialsV2 -> ShowS # show :: CredentialsV2 -> String # showList :: [CredentialsV2] -> ShowS #

data CredentialsV3 Source #

Constructors

CredentialsV3
Fields credentialsV3Crypto :: !Crypto credentialsV3ContextName :: !ByteString credentialsV3User :: !ByteString

Instances

Eq CredentialsV3 Source #
Methods (==) :: CredentialsV3 -> CredentialsV3 -> Bool # (/=) :: CredentialsV3 -> CredentialsV3 -> Bool #
Show CredentialsV3 Source #
Methods showsPrec :: Int -> CredentialsV3 -> ShowS # show :: CredentialsV3 -> String # showList :: [CredentialsV3] -> ShowS #

data Context Source #

Constructors

Context
Fields contextSession :: !Session contextDestination :: !Destination contextCredentials :: !Credentials

data PerHostV3 Source #

Constructors

PerHostV3
Fields perHostV3AuthoritativeEngineId :: !EngineId perHostV3ReceiverTime :: !Int32 perHostV3ReceiverBoots :: !Int32

openSession :: Config -> IO Session Source #

Only one connection can be open at a time on a given port.

closeSession :: Session -> IO () Source #

generalRequest :: (RequestId -> Pdus) -> (Pdu -> Either SnmpException a) -> Context -> IO (Either SnmpException a) Source #

nextSalt :: TVar AesSalt -> STM AesSalt Source #

throwSnmpException :: IO (Either SnmpException a) -> IO a Source #

get :: Context -> ObjectIdentifier -> IO ObjectSyntax Source #

getBulkStep :: Context -> Int -> ObjectIdentifier -> IO (Vector (ObjectIdentifier, ObjectSyntax)) Source #

getBulkChildren :: Context -> Int -> ObjectIdentifier -> IO (Vector (ObjectIdentifier, ObjectSyntax)) Source #

get' :: Context -> ObjectIdentifier -> IO (Either SnmpException ObjectSyntax) Source #

getBulkStep' :: Context -> Int -> ObjectIdentifier -> IO (Either SnmpException (Vector (ObjectIdentifier, ObjectSyntax))) Source #

getBulkChildren' :: Context -> Int -> ObjectIdentifier -> IO (Either SnmpException (Vector (ObjectIdentifier, ObjectSyntax))) Source #

oidIsPrefixOf :: ObjectIdentifier -> ObjectIdentifier -> Bool Source #

multipleBindings :: Vector VarBind -> Vector (ObjectIdentifier, ObjectSyntax) Source #

singleBindingValue :: ObjectIdentifier -> Vector VarBind -> Either SnmpException ObjectSyntax Source #

onlyBindings :: Pdu -> Either SnmpException (Vector VarBind) Source #

data SnmpException Source #

Instances

Eq SnmpException Source #
Methods (==) :: SnmpException -> SnmpException -> Bool # (/=) :: SnmpException -> SnmpException -> Bool #
Show SnmpException Source #
Methods showsPrec :: Int -> SnmpException -> ShowS # show :: SnmpException -> String # showList :: [SnmpException] -> ShowS #
Exception SnmpException Source #
Methods toException :: SnmpException -> SomeException # fromException :: SomeException -> Maybe SnmpException # displayException :: SnmpException -> String #

readTMVarTimeout :: Int -> TMVar a -> IO (Maybe a) Source #

fini :: TVar Bool -> STM () Source #

nextRequestId :: TVar RequestId -> IO RequestId Source #

mySockFd :: Socket -> Fd Source #

hexByteStringInternal :: ByteString -> String Source #

inDebugMode :: Bool Source #

SnmpExceptionNotAllBytesSent !Int !Int
SnmpExceptionTimeout
SnmpExceptionTimeoutV3 !MessageV3
SnmpExceptionPduError !ErrorStatus !ErrorIndex
SnmpExceptionMultipleBindings !Int
SnmpExceptionMismatchedBinding !ObjectIdentifier !ObjectIdentifier
SnmpExceptionUnspecified	Should not happen
SnmpExceptionNoSuchObject !ObjectIdentifier
SnmpExceptionNoSuchInstance !ObjectIdentifier
SnmpExceptionEndOfMibView
SnmpExceptionMissedResponse !RequestId !RequestId
SnmpExceptionNonPduResponseV2 !MessageV2
SnmpExceptionNonPduResponseV3 !MessageV3
SnmpExceptionDecoding !String
SnmpExceptionSocketClosed
SnmpExceptionAuthenticationFailure !ByteString !ByteString
SnmpExceptionBadEngineId !MessageV3 !MessageV3
SnmpExceptionDecryptionFailure