Copyright	(c) Dustin Sallings 2019
License	BSD3
Maintainer	dustin@spy.net
Stability	experimental
Safe Haskell	Safe
Language	Haskell2010

Network.MQTT.Types

Description

MQTT Types.

Synopsis

data LastWill = LastWill {
- _willRetain :: Bool
- _willQoS :: QoS
- _willTopic :: ByteString
- _willMsg :: ByteString
}
data MQTTPkt
- = ConnPkt ConnectRequest
- | ConnACKPkt ConnACKFlags
- | PublishPkt PublishRequest
- | PubACKPkt PubACK
- | PubRECPkt PubREC
- | PubRELPkt PubREL
- | PubCOMPPkt PubCOMP
- | SubscribePkt SubscribeRequest
- | SubACKPkt SubscribeResponse
- | UnsubscribePkt UnsubscribeRequest
- | UnsubACKPkt UnsubscribeResponse
- | PingPkt
- | PongPkt
- | DisconnectPkt
data QoS
- = QoS0
- | QoS1
- | QoS2
data ConnectRequest = ConnectRequest {
- _username :: Maybe ByteString
- _password :: Maybe ByteString
- _lastWill :: Maybe LastWill
- _cleanSession :: Bool
- _keepAlive :: Word16
- _connID :: ByteString
}
connectRequest :: ConnectRequest
data ConnACKFlags = ConnACKFlags Bool ConnACKRC
data ConnACKRC
- = ConnAccepted
- | UnacceptableProtocol
- | IdentifierRejected
- | ServerUnavailable
- | BadCredentials
- | NotAuthorized
- | InvalidConnACKRC Word8
data PublishRequest = PublishRequest {
- _pubDup :: Bool
- _pubQoS :: QoS
- _pubRetain :: Bool
- _pubTopic :: ByteString
- _pubPktID :: Word16
- _pubBody :: ByteString
}
newtype PubACK = PubACK Word16
newtype PubREC = PubREC Word16
newtype PubREL = PubREL Word16
newtype PubCOMP = PubCOMP Word16
data SubscribeRequest = SubscribeRequest Word16 [(ByteString, QoS)]
data SubscribeResponse = SubscribeResponse Word16 [Maybe QoS]
data UnsubscribeRequest = UnsubscribeRequest Word16 [ByteString]
newtype UnsubscribeResponse = UnsubscribeResponse Word16
parsePacket :: Parser MQTTPkt
class ByteMe a where
- toByteString :: a -> ByteString
encodeLength :: Int -> [Word8]
parseHdrLen :: Parser Int
connACKRC :: Word8 -> ConnACKRC

Documentation

data LastWill Source #

An MQTT Will message.

Constructors

LastWill
Fields _willRetain :: Bool _willQoS :: QoS _willTopic :: ByteString _willMsg :: ByteString

Instances

Eq LastWill Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: LastWill -> LastWill -> Bool # (/=) :: LastWill -> LastWill -> Bool #
Show LastWill Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> LastWill -> ShowS # show :: LastWill -> String # showList :: [LastWill] -> ShowS #

data MQTTPkt Source #

Instances

Eq MQTTPkt Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: MQTTPkt -> MQTTPkt -> Bool # (/=) :: MQTTPkt -> MQTTPkt -> Bool #
Show MQTTPkt Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> MQTTPkt -> ShowS # show :: MQTTPkt -> String # showList :: [MQTTPkt] -> ShowS #
ByteMe MQTTPkt Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: MQTTPkt -> [Word8] toByteString :: MQTTPkt -> ByteString Source #

data QoS Source #

QoS values for publishing and subscribing.

Constructors

QoS0
QoS1
QoS2

Instances

Bounded QoS Source #
Instance details Defined in Network.MQTT.Types Methods minBound :: QoS # maxBound :: QoS #
Enum QoS Source #
Instance details Defined in Network.MQTT.Types Methods succ :: QoS -> QoS # pred :: QoS -> QoS # toEnum :: Int -> QoS # fromEnum :: QoS -> Int # enumFrom :: QoS -> [QoS] # enumFromThen :: QoS -> QoS -> [QoS] # enumFromTo :: QoS -> QoS -> [QoS] # enumFromThenTo :: QoS -> QoS -> QoS -> [QoS] #
Eq QoS Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: QoS -> QoS -> Bool # (/=) :: QoS -> QoS -> Bool #
Show QoS Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> QoS -> ShowS # show :: QoS -> String # showList :: [QoS] -> ShowS #

data ConnectRequest Source #

Constructors

ConnectRequest
Fields _username :: Maybe ByteString _password :: Maybe ByteString _lastWill :: Maybe LastWill _cleanSession :: Bool _keepAlive :: Word16 _connID :: ByteString

Instances

Eq ConnectRequest Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: ConnectRequest -> ConnectRequest -> Bool # (/=) :: ConnectRequest -> ConnectRequest -> Bool #
Show ConnectRequest Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> ConnectRequest -> ShowS # show :: ConnectRequest -> String # showList :: [ConnectRequest] -> ShowS #
ByteMe ConnectRequest Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: ConnectRequest -> [Word8] toByteString :: ConnectRequest -> ByteString Source #

connectRequest :: ConnectRequest Source #

data ConnACKFlags Source #

Constructors

ConnACKFlags Bool ConnACKRC

Instances

Eq ConnACKFlags Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: ConnACKFlags -> ConnACKFlags -> Bool # (/=) :: ConnACKFlags -> ConnACKFlags -> Bool #
Show ConnACKFlags Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> ConnACKFlags -> ShowS # show :: ConnACKFlags -> String # showList :: [ConnACKFlags] -> ShowS #
ByteMe ConnACKFlags Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: ConnACKFlags -> [Word8] toByteString :: ConnACKFlags -> ByteString Source #

data ConnACKRC Source #

Constructors

ConnAccepted
UnacceptableProtocol
IdentifierRejected
ServerUnavailable
BadCredentials
NotAuthorized
InvalidConnACKRC Word8

Instances

Eq ConnACKRC Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: ConnACKRC -> ConnACKRC -> Bool # (/=) :: ConnACKRC -> ConnACKRC -> Bool #
Show ConnACKRC Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> ConnACKRC -> ShowS # show :: ConnACKRC -> String # showList :: [ConnACKRC] -> ShowS #

data PublishRequest Source #

Constructors

PublishRequest
Fields _pubDup :: Bool _pubQoS :: QoS _pubRetain :: Bool _pubTopic :: ByteString _pubPktID :: Word16 _pubBody :: ByteString

Instances

Eq PublishRequest Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: PublishRequest -> PublishRequest -> Bool # (/=) :: PublishRequest -> PublishRequest -> Bool #
Show PublishRequest Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> PublishRequest -> ShowS # show :: PublishRequest -> String # showList :: [PublishRequest] -> ShowS #
ByteMe PublishRequest Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: PublishRequest -> [Word8] toByteString :: PublishRequest -> ByteString Source #

newtype PubACK Source #

Constructors

PubACK Word16

Instances

Eq PubACK Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: PubACK -> PubACK -> Bool # (/=) :: PubACK -> PubACK -> Bool #
Show PubACK Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> PubACK -> ShowS # show :: PubACK -> String # showList :: [PubACK] -> ShowS #
ByteMe PubACK Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: PubACK -> [Word8] toByteString :: PubACK -> ByteString Source #

newtype PubREC Source #

Constructors

PubREC Word16

Instances

Eq PubREC Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: PubREC -> PubREC -> Bool # (/=) :: PubREC -> PubREC -> Bool #
Show PubREC Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> PubREC -> ShowS # show :: PubREC -> String # showList :: [PubREC] -> ShowS #
ByteMe PubREC Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: PubREC -> [Word8] toByteString :: PubREC -> ByteString Source #

newtype PubREL Source #

Constructors

PubREL Word16

Instances

Eq PubREL Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: PubREL -> PubREL -> Bool # (/=) :: PubREL -> PubREL -> Bool #
Show PubREL Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> PubREL -> ShowS # show :: PubREL -> String # showList :: [PubREL] -> ShowS #
ByteMe PubREL Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: PubREL -> [Word8] toByteString :: PubREL -> ByteString Source #

newtype PubCOMP Source #

Constructors

PubCOMP Word16

Instances

Eq PubCOMP Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: PubCOMP -> PubCOMP -> Bool # (/=) :: PubCOMP -> PubCOMP -> Bool #
Show PubCOMP Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> PubCOMP -> ShowS # show :: PubCOMP -> String # showList :: [PubCOMP] -> ShowS #
ByteMe PubCOMP Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: PubCOMP -> [Word8] toByteString :: PubCOMP -> ByteString Source #

data SubscribeRequest Source #

Constructors

SubscribeRequest Word16 [(ByteString, QoS)]

Instances

Eq SubscribeRequest Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: SubscribeRequest -> SubscribeRequest -> Bool # (/=) :: SubscribeRequest -> SubscribeRequest -> Bool #
Show SubscribeRequest Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> SubscribeRequest -> ShowS # show :: SubscribeRequest -> String # showList :: [SubscribeRequest] -> ShowS #
ByteMe SubscribeRequest Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: SubscribeRequest -> [Word8] toByteString :: SubscribeRequest -> ByteString Source #

data SubscribeResponse Source #

Constructors

SubscribeResponse Word16 [Maybe QoS]

Instances

Eq SubscribeResponse Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: SubscribeResponse -> SubscribeResponse -> Bool # (/=) :: SubscribeResponse -> SubscribeResponse -> Bool #
Show SubscribeResponse Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> SubscribeResponse -> ShowS # show :: SubscribeResponse -> String # showList :: [SubscribeResponse] -> ShowS #
ByteMe SubscribeResponse Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: SubscribeResponse -> [Word8] toByteString :: SubscribeResponse -> ByteString Source #

data UnsubscribeRequest Source #

Constructors

UnsubscribeRequest Word16 [ByteString]

Instances

Eq UnsubscribeRequest Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: UnsubscribeRequest -> UnsubscribeRequest -> Bool # (/=) :: UnsubscribeRequest -> UnsubscribeRequest -> Bool #
Show UnsubscribeRequest Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> UnsubscribeRequest -> ShowS # show :: UnsubscribeRequest -> String # showList :: [UnsubscribeRequest] -> ShowS #
ByteMe UnsubscribeRequest Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: UnsubscribeRequest -> [Word8] toByteString :: UnsubscribeRequest -> ByteString Source #

newtype UnsubscribeResponse Source #

Constructors

UnsubscribeResponse Word16

Instances

Eq UnsubscribeResponse Source #
Instance details Defined in Network.MQTT.Types Methods (==) :: UnsubscribeResponse -> UnsubscribeResponse -> Bool # (/=) :: UnsubscribeResponse -> UnsubscribeResponse -> Bool #
Show UnsubscribeResponse Source #
Instance details Defined in Network.MQTT.Types Methods showsPrec :: Int -> UnsubscribeResponse -> ShowS # show :: UnsubscribeResponse -> String # showList :: [UnsubscribeResponse] -> ShowS #
ByteMe UnsubscribeResponse Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: UnsubscribeResponse -> [Word8] toByteString :: UnsubscribeResponse -> ByteString Source #

parsePacket :: Parser MQTTPkt Source #

class ByteMe a where Source #

Minimal complete definition

Nothing

Methods

toByteString :: a -> ByteString Source #

Instances

ByteMe ByteString Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: ByteString -> [Word8] toByteString :: ByteString -> ByteString Source #
ByteMe UnsubscribeResponse Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: UnsubscribeResponse -> [Word8] toByteString :: UnsubscribeResponse -> ByteString Source #
ByteMe UnsubscribeRequest Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: UnsubscribeRequest -> [Word8] toByteString :: UnsubscribeRequest -> ByteString Source #
ByteMe SubscribeResponse Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: SubscribeResponse -> [Word8] toByteString :: SubscribeResponse -> ByteString Source #
ByteMe PubCOMP Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: PubCOMP -> [Word8] toByteString :: PubCOMP -> ByteString Source #
ByteMe PubREL Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: PubREL -> [Word8] toByteString :: PubREL -> ByteString Source #
ByteMe PubREC Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: PubREC -> [Word8] toByteString :: PubREC -> ByteString Source #
ByteMe PubACK Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: PubACK -> [Word8] toByteString :: PubACK -> ByteString Source #
ByteMe SubscribeRequest Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: SubscribeRequest -> [Word8] toByteString :: SubscribeRequest -> ByteString Source #
ByteMe PublishRequest Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: PublishRequest -> [Word8] toByteString :: PublishRequest -> ByteString Source #
ByteMe ConnACKFlags Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: ConnACKFlags -> [Word8] toByteString :: ConnACKFlags -> ByteString Source #
ByteMe MQTTPkt Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: MQTTPkt -> [Word8] toByteString :: MQTTPkt -> ByteString Source #
ByteMe ConnectRequest Source #
Instance details Defined in Network.MQTT.Types Methods toBytes :: ConnectRequest -> [Word8] toByteString :: ConnectRequest -> ByteString Source #

encodeLength :: Int -> [Word8] Source #

parseHdrLen :: Parser Int Source #

connACKRC :: Word8 -> ConnACKRC Source #

ConnPkt ConnectRequest
ConnACKPkt ConnACKFlags
PublishPkt PublishRequest
PubACKPkt PubACK
PubRECPkt PubREC
PubRELPkt PubREL
PubCOMPPkt PubCOMP
SubscribePkt SubscribeRequest
SubACKPkt SubscribeResponse
UnsubscribePkt UnsubscribeRequest
UnsubACKPkt UnsubscribeResponse
PingPkt
PongPkt
DisconnectPkt