Safe Haskell	None
Language	Haskell2010

Snmp.Client

Synopsis

data Session = Session {
- sessionSockets :: !(Chan Socket)
- sessionSocketCount :: !Int
- sessionRequestId :: !(TVar RequestId)
- sessionAesSalt :: !(TVar AesSalt)
- sessionTimeoutMicroseconds :: !Int
- sessionMaxTries :: !Int
- sessionKeyCache :: !(IORef (Map (AuthType, ByteString, EngineId) ByteString))
}
data Config = Config {
- configSocketPoolSize :: !Int
- configTimeoutMicroseconds :: !Int
- configRetries :: !Int
}
data Destination = Destination {
- destinationHost :: !IPv4
- destinationPort :: !Word16
}
data Credentials
- = CredentialsConstructV2 CredentialsV2
- | CredentialsConstructV3 CredentialsV3
newtype CredentialsV2 = CredentialsV2 {
- credentialsV2CommunityString :: ByteString
}
data CredentialsV3 = CredentialsV3 {
- credentialsV3Crypto :: !Crypto
- credentialsV3ContextName :: !ByteString
- credentialsV3User :: !ByteString
}
data Context = Context {
- contextSession :: !Session
- contextDestination :: !Destination
- contextCredentials :: !Credentials
}
data PerHostV3 = PerHostV3 {
- perHostV3AuthoritativeEngineId :: !EngineId
- perHostV3ReceiverTime :: !Int32
- perHostV3ReceiverBoots :: !Int32
}
data SnmpException
openSession :: Config -> IO Session
closeSession :: Session -> IO ()
get :: Context -> ObjectIdentifier -> IO ObjectSyntax
get' :: Context -> ObjectIdentifier -> IO (Either SnmpException ObjectSyntax)
getBulkStep :: Context -> Int -> ObjectIdentifier -> IO (Vector (ObjectIdentifier, ObjectSyntax))
getBulkStep' :: Context -> Int -> ObjectIdentifier -> IO (Either SnmpException (Vector (ObjectIdentifier, ObjectSyntax)))
getBulkChildren :: Context -> Int -> ObjectIdentifier -> IO (Vector (ObjectIdentifier, ObjectSyntax))
getBulkChildren' :: Context -> Int -> ObjectIdentifier -> IO (Either SnmpException (Vector (ObjectIdentifier, ObjectSyntax)))

Documentation

data Session Source #

Constructors

Session
Fields sessionSockets :: !(Chan Socket) sessionSocketCount :: !Int sessionRequestId :: !(TVar RequestId) sessionAesSalt :: !(TVar AesSalt) sessionTimeoutMicroseconds :: !Int sessionMaxTries :: !Int sessionKeyCache :: !(IORef (Map (AuthType, ByteString, EngineId) ByteString))

data Config Source #

Constructors

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

Instances

Eq Config Source #
Instance details Defined in Snmp.Client Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Show Config Source #
Instance details Defined in Snmp.Client Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #

data Destination Source #

Constructors

Destination
Fields destinationHost :: !IPv4 destinationPort :: !Word16

Instances

Eq Destination Source #
Instance details Defined in Snmp.Client Methods (==) :: Destination -> Destination -> Bool # (/=) :: Destination -> Destination -> Bool #
Show Destination Source #
Instance details Defined in Snmp.Client Methods showsPrec :: Int -> Destination -> ShowS # show :: Destination -> String # showList :: [Destination] -> ShowS #

data Credentials Source #

Constructors

CredentialsConstructV2 CredentialsV2
CredentialsConstructV3 CredentialsV3

Instances

Eq Credentials Source #
Instance details Defined in Snmp.Client Methods (==) :: Credentials -> Credentials -> Bool # (/=) :: Credentials -> Credentials -> Bool #
Show Credentials Source #
Instance details Defined in Snmp.Client Methods showsPrec :: Int -> Credentials -> ShowS # show :: Credentials -> String # showList :: [Credentials] -> ShowS #

newtype CredentialsV2 Source #

Constructors

CredentialsV2
Fields credentialsV2CommunityString :: ByteString

Instances

Eq CredentialsV2 Source #
Instance details Defined in Snmp.Client Methods (==) :: CredentialsV2 -> CredentialsV2 -> Bool # (/=) :: CredentialsV2 -> CredentialsV2 -> Bool #
Show CredentialsV2 Source #
Instance details Defined in Snmp.Client 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 #
Instance details Defined in Snmp.Client Methods (==) :: CredentialsV3 -> CredentialsV3 -> Bool # (/=) :: CredentialsV3 -> CredentialsV3 -> Bool #
Show CredentialsV3 Source #
Instance details Defined in Snmp.Client 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

data SnmpException Source #

Instances

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

openSession :: Config -> IO Session Source #

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

closeSession :: Session -> IO () Source #

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

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

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

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

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

getBulkChildren' :: Context -> Int -> ObjectIdentifier -> IO (Either SnmpException (Vector (ObjectIdentifier, ObjectSyntax))) 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