Copyright	(c) Lars Petersen 2016
License	MIT
Maintainer	info@lars-petersen.net
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Network.MQTT.Message

Contents

Message
Packet
Other (internal) exports

Description

Synopsis

Message

data Message Source #

Constructors

Message
Fields msgTopic :: !Topic msgQoS :: !QoS msgRetain :: !Retain msgPayload :: !Payload

Instances

Eq Message Source #
Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Ord Message Source #
Methods compare :: Message -> Message -> Ordering # (<) :: Message -> Message -> Bool # (<=) :: Message -> Message -> Bool # (>) :: Message -> Message -> Bool # (>=) :: Message -> Message -> Bool # max :: Message -> Message -> Message # min :: Message -> Message -> Message #
Show Message Source #
Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #

Topic

data Topic Source #

According to the MQTT specification a topic

must not be empty
must not contain +, # or \NUL characters

Instances

Eq Topic Source #
Methods (==) :: Topic -> Topic -> Bool # (/=) :: Topic -> Topic -> Bool #
Ord Topic Source #
Methods compare :: Topic -> Topic -> Ordering # (<) :: Topic -> Topic -> Bool # (<=) :: Topic -> Topic -> Bool # (>) :: Topic -> Topic -> Bool # (>=) :: Topic -> Topic -> Bool # max :: Topic -> Topic -> Topic # min :: Topic -> Topic -> Topic #
Show Topic Source #
Methods showsPrec :: Int -> Topic -> ShowS # show :: Topic -> String # showList :: [Topic] -> ShowS #
IsString Topic Source #
Methods fromString :: String -> Topic #

topicLevels :: Topic -> NonEmpty Level Source #

topicLength :: Topic -> Int Source #

topicParser :: Parser Topic Source #

topicBuilder :: Topic -> Builder Source #

Filter

data Filter Source #

According to the MQTT specification a filter

must not be empty
must not contain a \NUL character

Instances

Eq Filter Source #
Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
Ord Filter Source #
Methods compare :: Filter -> Filter -> Ordering # (<) :: Filter -> Filter -> Bool # (<=) :: Filter -> Filter -> Bool # (>) :: Filter -> Filter -> Bool # (>=) :: Filter -> Filter -> Bool # max :: Filter -> Filter -> Filter # min :: Filter -> Filter -> Filter #
Show Filter Source #
Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #
IsString Filter Source #
Methods fromString :: String -> Filter #

filterLevels :: Filter -> NonEmpty Level Source #

filterLength :: Filter -> Int Source #

filterParser :: Parser Filter Source #

filterBuilder :: Filter -> Builder Source #

Level

data Level Source #

A Level represents a single path element of a Topic or a Filter.

Instances

Eq Level Source #
Methods (==) :: Level -> Level -> Bool # (/=) :: Level -> Level -> Bool #
Ord Level Source #
Methods compare :: Level -> Level -> Ordering # (<) :: Level -> Level -> Bool # (<=) :: Level -> Level -> Bool # (>) :: Level -> Level -> Bool # (>=) :: Level -> Level -> Bool # max :: Level -> Level -> Level # min :: Level -> Level -> Level #
Show Level Source #
Methods showsPrec :: Int -> Level -> ShowS # show :: Level -> String # showList :: [Level] -> ShowS #
IsString Level Source #
Methods fromString :: String -> Level #

levelParser :: Parser Level Source #

multiLevelWildcard :: Level Source #

The # path element. It must only appear at the end of a Filter.

singleLevelWildcard :: Level Source #

The + path element. It may appear anywhere within a Filter.

startsWithDollar :: Level -> Bool Source #

Returns True iff the Level starts with $.

QoS

data QoS Source #

The quality of service defines the guarantees given wrt to message reception.

Constructors

QoS0	Message delivery is not guaranteed.
QoS1	Message is guaranteed to be delivered at least once.
QoS2	Message is guaranteed to be delivered exactly once.

Instances

Bounded QoS Source #
Methods minBound :: QoS # maxBound :: QoS #
Enum QoS Source #
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 #
Methods (==) :: QoS -> QoS -> Bool # (/=) :: QoS -> QoS -> Bool #
Ord QoS Source #
Methods compare :: QoS -> QoS -> Ordering # (<) :: QoS -> QoS -> Bool # (<=) :: QoS -> QoS -> Bool # (>) :: QoS -> QoS -> Bool # (>=) :: QoS -> QoS -> Bool # max :: QoS -> QoS -> QoS # min :: QoS -> QoS -> QoS #
Show QoS Source #
Methods showsPrec :: Int -> QoS -> ShowS # show :: QoS -> String # showList :: [QoS] -> ShowS #
TrieValue QoS Source #
Associated Types data TrieNode QoS :: * Source # Methods node :: Trie QoS -> Maybe QoS -> TrieNode QoS Source # nodeNull :: QoS -> Bool Source # nodeTree :: TrieNode QoS -> Trie QoS Source # nodeValue :: TrieNode QoS -> Maybe QoS Source #
data TrieNode QoS Source #
data TrieNode QoS = QosNode !Int !(Trie QoS)

Retain

newtype Retain Source #

Constructors

Retain Bool

Instances

Eq Retain Source #
Methods (==) :: Retain -> Retain -> Bool # (/=) :: Retain -> Retain -> Bool #
Ord Retain Source #
Methods compare :: Retain -> Retain -> Ordering # (<) :: Retain -> Retain -> Bool # (<=) :: Retain -> Retain -> Bool # (>) :: Retain -> Retain -> Bool # (>=) :: Retain -> Retain -> Bool # max :: Retain -> Retain -> Retain # min :: Retain -> Retain -> Retain #
Show Retain Source #
Methods showsPrec :: Int -> Retain -> ShowS # show :: Retain -> String # showList :: [Retain] -> ShowS #

Payload

newtype Payload Source #

Constructors

Payload ByteString

Instances

Eq Payload Source #
Methods (==) :: Payload -> Payload -> Bool # (/=) :: Payload -> Payload -> Bool #
Ord Payload Source #
Methods compare :: Payload -> Payload -> Ordering # (<) :: Payload -> Payload -> Bool # (<=) :: Payload -> Payload -> Bool # (>) :: Payload -> Payload -> Bool # (>=) :: Payload -> Payload -> Bool # max :: Payload -> Payload -> Payload # min :: Payload -> Payload -> Payload #
Show Payload Source #
Methods showsPrec :: Int -> Payload -> ShowS # show :: Payload -> String # showList :: [Payload] -> ShowS #
IsString Payload Source #
Methods fromString :: String -> Payload #

Packet

ClientPacket

data ClientPacket Source #

Instances

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

clientPacketBuilder :: ClientPacket -> Builder Source #

clientPacketParser :: Get ClientPacket Source #

ServerPacket

data ServerPacket Source #

Instances

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

serverPacketBuilder :: ServerPacket -> Builder Source #

serverPacketParser :: Get ServerPacket Source #

PacketIdentifier

newtype PacketIdentifier Source #

Constructors

PacketIdentifier Int

Instances

Eq PacketIdentifier Source #
Methods (==) :: PacketIdentifier -> PacketIdentifier -> Bool # (/=) :: PacketIdentifier -> PacketIdentifier -> Bool #
Ord PacketIdentifier Source #
Methods compare :: PacketIdentifier -> PacketIdentifier -> Ordering # (<) :: PacketIdentifier -> PacketIdentifier -> Bool # (<=) :: PacketIdentifier -> PacketIdentifier -> Bool # (>) :: PacketIdentifier -> PacketIdentifier -> Bool # (>=) :: PacketIdentifier -> PacketIdentifier -> Bool # max :: PacketIdentifier -> PacketIdentifier -> PacketIdentifier # min :: PacketIdentifier -> PacketIdentifier -> PacketIdentifier #
Show PacketIdentifier Source #
Methods showsPrec :: Int -> PacketIdentifier -> ShowS # show :: PacketIdentifier -> String # showList :: [PacketIdentifier] -> ShowS #

ClientIdentifier

newtype ClientIdentifier Source #

Constructors

ClientIdentifier Text

Instances

Eq ClientIdentifier Source #
Methods (==) :: ClientIdentifier -> ClientIdentifier -> Bool # (/=) :: ClientIdentifier -> ClientIdentifier -> Bool #
Ord ClientIdentifier Source #
Methods compare :: ClientIdentifier -> ClientIdentifier -> Ordering # (<) :: ClientIdentifier -> ClientIdentifier -> Bool # (<=) :: ClientIdentifier -> ClientIdentifier -> Bool # (>) :: ClientIdentifier -> ClientIdentifier -> Bool # (>=) :: ClientIdentifier -> ClientIdentifier -> Bool # max :: ClientIdentifier -> ClientIdentifier -> ClientIdentifier # min :: ClientIdentifier -> ClientIdentifier -> ClientIdentifier #
Show ClientIdentifier Source #
Methods showsPrec :: Int -> ClientIdentifier -> ShowS # show :: ClientIdentifier -> String # showList :: [ClientIdentifier] -> ShowS #
IsString ClientIdentifier Source #
Methods fromString :: String -> ClientIdentifier #
Generic ClientIdentifier Source #
Associated Types type Rep ClientIdentifier :: * -> * # Methods from :: ClientIdentifier -> Rep ClientIdentifier x # to :: Rep ClientIdentifier x -> ClientIdentifier #
Binary ClientIdentifier Source #
Methods put :: ClientIdentifier -> Put # get :: Get ClientIdentifier # putList :: [ClientIdentifier] -> Put #
type Rep ClientIdentifier Source #
type Rep ClientIdentifier = D1 (MetaData "ClientIdentifier" "Network.MQTT.Message" "mqtt-0.1.1.0-6z0Hs5qv6meCmpWtAOex9N" True) (C1 (MetaCons "ClientIdentifier" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

Username

newtype Username Source #

Constructors

Username Text

Instances

Eq Username Source #
Methods (==) :: Username -> Username -> Bool # (/=) :: Username -> Username -> Bool #
Ord Username Source #
Methods compare :: Username -> Username -> Ordering # (<) :: Username -> Username -> Bool # (<=) :: Username -> Username -> Bool # (>) :: Username -> Username -> Bool # (>=) :: Username -> Username -> Bool # max :: Username -> Username -> Username # min :: Username -> Username -> Username #
Show Username Source #
Methods showsPrec :: Int -> Username -> ShowS # show :: Username -> String # showList :: [Username] -> ShowS #
IsString Username Source #
Methods fromString :: String -> Username #
Generic Username Source #
Associated Types type Rep Username :: * -> * # Methods from :: Username -> Rep Username x # to :: Rep Username x -> Username #
Binary Username Source #
Methods put :: Username -> Put # get :: Get Username # putList :: [Username] -> Put #
type Rep Username Source #
type Rep Username = D1 (MetaData "Username" "Network.MQTT.Message" "mqtt-0.1.1.0-6z0Hs5qv6meCmpWtAOex9N" True) (C1 (MetaCons "Username" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

Password

newtype Password Source #

Constructors

Password ByteString

Instances

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

CleanSession

newtype CleanSession Source #

Constructors

CleanSession Bool

Instances

Eq CleanSession Source #
Methods (==) :: CleanSession -> CleanSession -> Bool # (/=) :: CleanSession -> CleanSession -> Bool #
Ord CleanSession Source #
Methods compare :: CleanSession -> CleanSession -> Ordering # (<) :: CleanSession -> CleanSession -> Bool # (<=) :: CleanSession -> CleanSession -> Bool # (>) :: CleanSession -> CleanSession -> Bool # (>=) :: CleanSession -> CleanSession -> Bool # max :: CleanSession -> CleanSession -> CleanSession # min :: CleanSession -> CleanSession -> CleanSession #
Show CleanSession Source #
Methods showsPrec :: Int -> CleanSession -> ShowS # show :: CleanSession -> String # showList :: [CleanSession] -> ShowS #

SessionPresent

newtype SessionPresent Source #

Constructors

SessionPresent Bool

Instances

Eq SessionPresent Source #
Methods (==) :: SessionPresent -> SessionPresent -> Bool # (/=) :: SessionPresent -> SessionPresent -> Bool #
Ord SessionPresent Source #
Methods compare :: SessionPresent -> SessionPresent -> Ordering # (<) :: SessionPresent -> SessionPresent -> Bool # (<=) :: SessionPresent -> SessionPresent -> Bool # (>) :: SessionPresent -> SessionPresent -> Bool # (>=) :: SessionPresent -> SessionPresent -> Bool # max :: SessionPresent -> SessionPresent -> SessionPresent # min :: SessionPresent -> SessionPresent -> SessionPresent #
Show SessionPresent Source #
Methods showsPrec :: Int -> SessionPresent -> ShowS # show :: SessionPresent -> String # showList :: [SessionPresent] -> ShowS #

RejectReason

data RejectReason Source #

Constructors

UnacceptableProtocolVersion
IdentifierRejected
ServerUnavailable
BadUsernameOrPassword
NotAuthorized

Instances

Bounded RejectReason Source #
Methods minBound :: RejectReason # maxBound :: RejectReason #
Enum RejectReason Source #
Methods succ :: RejectReason -> RejectReason # pred :: RejectReason -> RejectReason # toEnum :: Int -> RejectReason # fromEnum :: RejectReason -> Int # enumFrom :: RejectReason -> [RejectReason] # enumFromThen :: RejectReason -> RejectReason -> [RejectReason] # enumFromTo :: RejectReason -> RejectReason -> [RejectReason] # enumFromThenTo :: RejectReason -> RejectReason -> RejectReason -> [RejectReason] #
Eq RejectReason Source #
Methods (==) :: RejectReason -> RejectReason -> Bool # (/=) :: RejectReason -> RejectReason -> Bool #
Ord RejectReason Source #
Methods compare :: RejectReason -> RejectReason -> Ordering # (<) :: RejectReason -> RejectReason -> Bool # (<=) :: RejectReason -> RejectReason -> Bool # (>) :: RejectReason -> RejectReason -> Bool # (>=) :: RejectReason -> RejectReason -> Bool # max :: RejectReason -> RejectReason -> RejectReason # min :: RejectReason -> RejectReason -> RejectReason #
Show RejectReason Source #
Methods showsPrec :: Int -> RejectReason -> ShowS # show :: RejectReason -> String # showList :: [RejectReason] -> ShowS #

Duplicate

newtype Duplicate Source #

Constructors

Duplicate Bool

Instances

Eq Duplicate Source #
Methods (==) :: Duplicate -> Duplicate -> Bool # (/=) :: Duplicate -> Duplicate -> Bool #
Ord Duplicate Source #
Methods compare :: Duplicate -> Duplicate -> Ordering # (<) :: Duplicate -> Duplicate -> Bool # (<=) :: Duplicate -> Duplicate -> Bool # (>) :: Duplicate -> Duplicate -> Bool # (>=) :: Duplicate -> Duplicate -> Bool # max :: Duplicate -> Duplicate -> Duplicate # min :: Duplicate -> Duplicate -> Duplicate #
Show Duplicate Source #
Methods showsPrec :: Int -> Duplicate -> ShowS # show :: Duplicate -> String # showList :: [Duplicate] -> ShowS #

KeepAliveInterval

newtype KeepAliveInterval Source #

Constructors

KeepAliveInterval Word16

Instances

Eq KeepAliveInterval Source #
Methods (==) :: KeepAliveInterval -> KeepAliveInterval -> Bool # (/=) :: KeepAliveInterval -> KeepAliveInterval -> Bool #
Num KeepAliveInterval Source #
Methods (+) :: KeepAliveInterval -> KeepAliveInterval -> KeepAliveInterval # (-) :: KeepAliveInterval -> KeepAliveInterval -> KeepAliveInterval # (*) :: KeepAliveInterval -> KeepAliveInterval -> KeepAliveInterval # negate :: KeepAliveInterval -> KeepAliveInterval # abs :: KeepAliveInterval -> KeepAliveInterval # signum :: KeepAliveInterval -> KeepAliveInterval # fromInteger :: Integer -> KeepAliveInterval #
Ord KeepAliveInterval Source #
Methods compare :: KeepAliveInterval -> KeepAliveInterval -> Ordering # (<) :: KeepAliveInterval -> KeepAliveInterval -> Bool # (<=) :: KeepAliveInterval -> KeepAliveInterval -> Bool # (>) :: KeepAliveInterval -> KeepAliveInterval -> Bool # (>=) :: KeepAliveInterval -> KeepAliveInterval -> Bool # max :: KeepAliveInterval -> KeepAliveInterval -> KeepAliveInterval # min :: KeepAliveInterval -> KeepAliveInterval -> KeepAliveInterval #
Show KeepAliveInterval Source #
Methods showsPrec :: Int -> KeepAliveInterval -> ShowS # show :: KeepAliveInterval -> String # showList :: [KeepAliveInterval] -> ShowS #

Other (internal) exports

lengthParser :: Get Int Source #

lengthBuilder :: Int -> Builder Source #

utf8Parser :: Get Text Source #

utf8Builder :: Text -> (Builder, Int) Source #

ClientConnect
Fields connectClientIdentifier :: !ClientIdentifier connectCleanSession :: !CleanSession connectKeepAlive :: !KeepAliveInterval connectWill :: !(Maybe Message) connectCredentials :: !(Maybe (Username, Maybe Password))
ClientConnectUnsupported
ClientPublish !PacketIdentifier !Duplicate !Message
ClientPublishAcknowledged !PacketIdentifier
ClientPublishReceived !PacketIdentifier
ClientPublishRelease !PacketIdentifier
ClientPublishComplete !PacketIdentifier
ClientSubscribe !PacketIdentifier ![(Filter, QoS)]
ClientUnsubscribe !PacketIdentifier ![Filter]
ClientPingRequest
ClientDisconnect

ServerConnectionAccepted !SessionPresent
ServerConnectionRejected !RejectReason
ServerPublish !PacketIdentifier !Duplicate !Message
ServerPublishAcknowledged !PacketIdentifier
ServerPublishReceived !PacketIdentifier
ServerPublishRelease !PacketIdentifier
ServerPublishComplete !PacketIdentifier
ServerSubscribeAcknowledged !PacketIdentifier ![Maybe QoS]
ServerUnsubscribeAcknowledged !PacketIdentifier
ServerPingResponse