| Copyright | Lukas Braun 2014-2016 |
|---|---|
| License | GPL-3 |
| Maintainer | koomi+mqtt@hackerspace-bamberg.de |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.MQTT.Types
Description
Types representing MQTT messages.
Synopsis
- data Message (t :: MsgType) = Message {
- header :: MqttHeader
- body :: MessageBody t
- data SomeMessage where
- SomeMessage :: SingI t => Message t -> SomeMessage
- data MqttHeader = Header {}
- setDup :: Message t -> Message t
- data MessageBody (t :: MsgType) where
- Connect :: {..} -> MessageBody CONNECT
- ConnAck :: {..} -> MessageBody CONNACK
- Publish :: {..} -> MessageBody PUBLISH
- PubAck :: {..} -> MessageBody PUBACK
- PubRec :: {..} -> MessageBody PUBREC
- PubRel :: {..} -> MessageBody PUBREL
- PubComp :: {..} -> MessageBody PUBCOMP
- Subscribe :: {..} -> MessageBody SUBSCRIBE
- SubAck :: {..} -> MessageBody SUBACK
- Unsubscribe :: {..} -> MessageBody UNSUBSCRIBE
- UnsubAck :: {..} -> MessageBody UNSUBACK
- PingReq :: MessageBody PINGREQ
- PingResp :: MessageBody PINGRESP
- Disconnect :: MessageBody DISCONNECT
- data Will = Will {}
- data QoS
- type MsgID = Word16
- getMsgID :: MessageBody t -> Maybe MsgID
- data Topic
- matches :: Topic -> Topic -> Bool
- fromTopic :: Topic -> MqttText
- toTopic :: MqttText -> Topic
- getLevels :: Topic -> [Text]
- fromLevels :: [Text] -> Topic
- newtype MqttText = MqttText {}
- data ConnectError
- toConnectError :: Word8 -> ConnectError
- data MsgType
- toMsgType :: SingI t => Message t -> MsgType
- toMsgType' :: SomeMessage -> MsgType
- toSMsgType :: SingI t => Message t -> SMsgType t
- type SMsgType = (Sing :: MsgType -> Type)
- withSomeSingI :: MsgType -> (forall t. SingI t => SMsgType t -> r) -> r
- data family Sing (a :: k) :: *
Messages
data Message (t :: MsgType) Source #
A MQTT message, indexed by the type of the message (MsgType).
Constructors
| Message | |
Fields
| |
data SomeMessage where Source #
Any message, hiding the index.
Constructors
| SomeMessage :: SingI t => Message t -> SomeMessage |
data MqttHeader Source #
Fixed header required in every message.
Constructors
| Header | |
Instances
| Eq MqttHeader Source # | |
Defined in Network.MQTT.Types | |
| Ord MqttHeader Source # | |
Defined in Network.MQTT.Types Methods compare :: MqttHeader -> MqttHeader -> Ordering # (<) :: MqttHeader -> MqttHeader -> Bool # (<=) :: MqttHeader -> MqttHeader -> Bool # (>) :: MqttHeader -> MqttHeader -> Bool # (>=) :: MqttHeader -> MqttHeader -> Bool # max :: MqttHeader -> MqttHeader -> MqttHeader # min :: MqttHeader -> MqttHeader -> MqttHeader # | |
| Show MqttHeader Source # | |
Defined in Network.MQTT.Types Methods showsPrec :: Int -> MqttHeader -> ShowS # show :: MqttHeader -> String # showList :: [MqttHeader] -> ShowS # | |
Message body
data MessageBody (t :: MsgType) where Source #
The body of a MQTT message, indexed by the type of the message (MsgType).
Constructors
| Connect :: {..} -> MessageBody CONNECT | |
Fields
| |
| ConnAck :: {..} -> MessageBody CONNACK | |
Fields
| |
| Publish :: {..} -> MessageBody PUBLISH | |
| PubAck :: {..} -> MessageBody PUBACK | |
Fields
| |
| PubRec :: {..} -> MessageBody PUBREC | |
Fields
| |
| PubRel :: {..} -> MessageBody PUBREL | |
Fields
| |
| PubComp :: {..} -> MessageBody PUBCOMP | |
Fields | |
| Subscribe :: {..} -> MessageBody SUBSCRIBE | |
| SubAck :: {..} -> MessageBody SUBACK | |
| Unsubscribe :: {..} -> MessageBody UNSUBSCRIBE | |
Fields
| |
| UnsubAck :: {..} -> MessageBody UNSUBACK | |
Fields | |
| PingReq :: MessageBody PINGREQ | |
| PingResp :: MessageBody PINGRESP | |
| Disconnect :: MessageBody DISCONNECT | |
Miscellaneous
A Will message is published by the broker if a client disconnects without sending a DISCONNECT.
The different levels of QoS
Constructors
| NoConfirm | Fire and forget, message will be published at most once. |
| Confirm | Acknowledged delivery, message will be published at least once. |
| Handshake | Assured delivery, message will be published exactly once. |
A topic is a "hierarchical name space that defines a taxonomy of information sources for which subscribers can register an interest." See the specification for more details.
A topic can be inspected by using the matches function or after using
getLevels, e.g.:
f1 topic
| topic `matches` "mqtt/hs/example" = putStrLn "example"
| topic `matches` "mqtt/hs/#" = putStrLn "wildcard"
f2 topic = case getLevels topic of
["mqtt", "hs", "example"] -> putStrLn "example"
"mqtt" : "hs" : _ -> putStrLn "wildcard"MQTT uses length-prefixed UTF-8 as text encoding.
data ConnectError Source #
Reasons why connecting to a broker might fail.
Constructors
| WrongProtocolVersion | |
| IdentifierRejected | |
| ServerUnavailable | |
| BadLogin | |
| Unauthorized | |
| UnrecognizedReturnCode | |
| InvalidResponse |
Instances
| Show ConnectError Source # | |
Defined in Network.MQTT.Types Methods showsPrec :: Int -> ConnectError -> ShowS # show :: ConnectError -> String # showList :: [ConnectError] -> ShowS # | |
| Exception ConnectError Source # | |
Defined in Network.MQTT.Types Methods toException :: ConnectError -> SomeException # fromException :: SomeException -> Maybe ConnectError # displayException :: ConnectError -> String # | |
toConnectError :: Word8 -> ConnectError Source #
Convert a return code to a ConnectError.
Message types
The various types of messages.
Constructors
| CONNECT | |
| CONNACK | |
| PUBLISH | |
| PUBACK | |
| PUBREC | |
| PUBREL | |
| PUBCOMP | |
| SUBSCRIBE | |
| SUBACK | |
| UNSUBSCRIBE | |
| UNSUBACK | |
| PINGREQ | |
| PINGRESP | |
| DISCONNECT |
Instances
toMsgType' :: SomeMessage -> MsgType Source #
Determine the MsgType of a SomeMessage.
Singletons
Singletons are used to build a bridge between the type and value level.
See the singletons package for more information.
You do not have to use or understand these in order to use this
library, they are mostly used internally to get better guarantees
about the flow of Messages.
withSomeSingI :: MsgType -> (forall t. SingI t => SMsgType t -> r) -> r Source #
Helper to generate both an implicit and explicit singleton.
data family Sing (a :: k) :: * #
The singleton kind-indexed data family.