Network.MQTT.Types

MQTT Types.

Documentation

data LastWill

An MQTT Will message.

Constructors

LastWill

Fields

• _willRetain :: Bool
• _willQoS :: QoS
• _willTopic :: ByteString
• _willMsg :: ByteString
• _willProps :: [Property]

Instances

Arbitrary LastWill

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen LastWill

shrink :: LastWill -> [LastWill]

Show LastWill

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> LastWill -> ShowS

show :: LastWill -> String

showList :: [LastWill] -> ShowS

Eq LastWill

Defined in Network.MQTT.Types

Methods

(==) :: LastWill -> LastWill -> Bool

(/=) :: LastWill -> LastWill -> Bool

data MQTTPkt

Constructors

ConnPkt ConnectRequest ProtocolLevel

ConnACKPkt ConnACKFlags

PublishPkt PublishRequest

PubACKPkt PubACK

PubRECPkt PubREC

PubRELPkt PubREL

PubCOMPPkt PubCOMP

SubscribePkt SubscribeRequest

SubACKPkt SubscribeResponse

UnsubscribePkt UnsubscribeRequest

UnsubACKPkt UnsubscribeResponse

PingPkt

PongPkt

DisconnectPkt DisconnectRequest

AuthPkt AuthRequest

Instances

Arbitrary MQTTPkt

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen MQTTPkt

shrink :: MQTTPkt -> [MQTTPkt]

Show MQTTPkt

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> MQTTPkt -> ShowS

show :: MQTTPkt -> String

showList :: [MQTTPkt] -> ShowS

Eq MQTTPkt

Defined in Network.MQTT.Types

Methods

(==) :: MQTTPkt -> MQTTPkt -> Bool

(/=) :: MQTTPkt -> MQTTPkt -> Bool

ByteMe MQTTPkt

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> MQTTPkt -> [Word8]

toByteString :: ProtocolLevel -> MQTTPkt -> ByteString

data QoS

QoS values for publishing and subscribing.

Constructors

QoS0

QoS1

QoS2

Instances

Arbitrary QoS

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen QoS

shrink :: QoS -> [QoS]

Bounded QoS

Defined in Network.MQTT.Types

Methods

minBound :: QoS

maxBound :: QoS

Enum QoS

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]

Show QoS

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> QoS -> ShowS

show :: QoS -> String

showList :: [QoS] -> ShowS

Eq QoS

Defined in Network.MQTT.Types

Methods

(==) :: QoS -> QoS -> Bool

(/=) :: QoS -> QoS -> Bool

Ord QoS

Defined in Network.MQTT.Types

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

qosFromInt :: Int -> Maybe QoS

Parse a valid QoS value from an Int.

data ConnectRequest

Constructors

ConnectRequest

Fields

• _username :: Maybe ByteString
• _password :: Maybe ByteString
• _lastWill :: Maybe LastWill
• _cleanSession :: Bool
• _keepAlive :: Word16
• _connID :: ByteString
• _connProperties :: [Property]

Instances

Arbitrary ConnectRequest

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen ConnectRequest

shrink :: ConnectRequest -> [ConnectRequest]

Show ConnectRequest

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> ConnectRequest -> ShowS

show :: ConnectRequest -> String

showList :: [ConnectRequest] -> ShowS

Eq ConnectRequest

Defined in Network.MQTT.Types

Methods

(==) :: ConnectRequest -> ConnectRequest -> Bool

(/=) :: ConnectRequest -> ConnectRequest -> Bool

ByteMe ConnectRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> ConnectRequest -> [Word8]

toByteString :: ProtocolLevel -> ConnectRequest -> ByteString

connectRequest :: ConnectRequest

data SessionReuse

Constructors

NewSession

ExistingSession

Instances

Arbitrary SessionReuse

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen SessionReuse

shrink :: SessionReuse -> [SessionReuse]

Bounded SessionReuse

Defined in Network.MQTT.Types

Methods

minBound :: SessionReuse

maxBound :: SessionReuse

Enum SessionReuse

Defined in Network.MQTT.Types

Methods

succ :: SessionReuse -> SessionReuse

pred :: SessionReuse -> SessionReuse

toEnum :: Int -> SessionReuse

fromEnum :: SessionReuse -> Int

enumFrom :: SessionReuse -> [SessionReuse]

enumFromThen :: SessionReuse -> SessionReuse -> [SessionReuse]

enumFromTo :: SessionReuse -> SessionReuse -> [SessionReuse]

enumFromThenTo :: SessionReuse -> SessionReuse -> SessionReuse -> [SessionReuse]

Show SessionReuse

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> SessionReuse -> ShowS

show :: SessionReuse -> String

showList :: [SessionReuse] -> ShowS

Eq SessionReuse

Defined in Network.MQTT.Types

Methods

(==) :: SessionReuse -> SessionReuse -> Bool

(/=) :: SessionReuse -> SessionReuse -> Bool

data ConnACKFlags

Connection acknowledgment details.

Constructors

ConnACKFlags SessionReuse ConnACKRC [Property]

Instances

Arbitrary ConnACKFlags

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen ConnACKFlags

shrink :: ConnACKFlags -> [ConnACKFlags]

Show ConnACKFlags

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> ConnACKFlags -> ShowS

show :: ConnACKFlags -> String

showList :: [ConnACKFlags] -> ShowS

Eq ConnACKFlags

Defined in Network.MQTT.Types

Methods

(==) :: ConnACKFlags -> ConnACKFlags -> Bool

(/=) :: ConnACKFlags -> ConnACKFlags -> Bool

ByteMe ConnACKFlags

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> ConnACKFlags -> [Word8]

toByteString :: ProtocolLevel -> ConnACKFlags -> ByteString

data ConnACKRC

Constructors

ConnAccepted

UnacceptableProtocol

IdentifierRejected

ServerUnavailable

BadCredentials

NotAuthorized

ConnUnspecifiedError

ConnMalformedPacket

ConnProtocolError

ConnImplementationSpecificError

ConnUnsupportedProtocolVersion

ConnClientIdentifierNotValid

ConnBadUserNameOrPassword

ConnNotAuthorized

ConnServerUnavailable

ConnServerBusy

ConnBanned

ConnBadAuthenticationMethod

ConnTopicNameInvalid

ConnPacketTooLarge

ConnQuotaExceeded

ConnPayloadFormatInvalid

ConnRetainNotSupported

ConnQosNotSupported

ConnUseAnotherServer

ConnServerMoved

ConnConnectionRateExceeded

Instances

Arbitrary ConnACKRC

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen ConnACKRC

shrink :: ConnACKRC -> [ConnACKRC]

Bounded ConnACKRC

Defined in Network.MQTT.Types

Methods

minBound :: ConnACKRC

maxBound :: ConnACKRC

Enum ConnACKRC

Defined in Network.MQTT.Types

Methods

succ :: ConnACKRC -> ConnACKRC

pred :: ConnACKRC -> ConnACKRC

toEnum :: Int -> ConnACKRC

fromEnum :: ConnACKRC -> Int

enumFrom :: ConnACKRC -> [ConnACKRC]

enumFromThen :: ConnACKRC -> ConnACKRC -> [ConnACKRC]

enumFromTo :: ConnACKRC -> ConnACKRC -> [ConnACKRC]

enumFromThenTo :: ConnACKRC -> ConnACKRC -> ConnACKRC -> [ConnACKRC]

Show ConnACKRC

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> ConnACKRC -> ShowS

show :: ConnACKRC -> String

showList :: [ConnACKRC] -> ShowS

Eq ConnACKRC

Defined in Network.MQTT.Types

Methods

(==) :: ConnACKRC -> ConnACKRC -> Bool

(/=) :: ConnACKRC -> ConnACKRC -> Bool

ByteSize ConnACKRC

Defined in Network.MQTT.Types

Methods

toByte :: ConnACKRC -> Word8

fromByte :: Word8 -> ConnACKRC

data PublishRequest

Constructors

PublishRequest

Fields

• _pubDup :: Bool
• _pubQoS :: QoS
• _pubRetain :: Bool
• _pubTopic :: ByteString
• _pubPktID :: PktID
• _pubBody :: ByteString
• _pubProps :: [Property]

Instances

Arbitrary PublishRequest

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen PublishRequest

shrink :: PublishRequest -> [PublishRequest]

Show PublishRequest

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> PublishRequest -> ShowS

show :: PublishRequest -> String

showList :: [PublishRequest] -> ShowS

Eq PublishRequest

Defined in Network.MQTT.Types

Methods

(==) :: PublishRequest -> PublishRequest -> Bool

(/=) :: PublishRequest -> PublishRequest -> Bool

ByteMe PublishRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> PublishRequest -> [Word8]

toByteString :: ProtocolLevel -> PublishRequest -> ByteString

data PubACK

Constructors

PubACK PktID Word8 [Property]

Instances

Arbitrary PubACK

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen PubACK

shrink :: PubACK -> [PubACK]

Show PubACK

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> PubACK -> ShowS

show :: PubACK -> String

showList :: [PubACK] -> ShowS

Eq PubACK

Defined in Network.MQTT.Types

Methods

(==) :: PubACK -> PubACK -> Bool

(/=) :: PubACK -> PubACK -> Bool

ByteMe PubACK

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> PubACK -> [Word8]

toByteString :: ProtocolLevel -> PubACK -> ByteString

data PubREC

Constructors

PubREC PktID Word8 [Property]

Instances

Arbitrary PubREC

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen PubREC

shrink :: PubREC -> [PubREC]

Show PubREC

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> PubREC -> ShowS

show :: PubREC -> String

showList :: [PubREC] -> ShowS

Eq PubREC

Defined in Network.MQTT.Types

Methods

(==) :: PubREC -> PubREC -> Bool

(/=) :: PubREC -> PubREC -> Bool

ByteMe PubREC

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> PubREC -> [Word8]

toByteString :: ProtocolLevel -> PubREC -> ByteString

data PubREL

Constructors

PubREL PktID Word8 [Property]

Instances

Arbitrary PubREL

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen PubREL

shrink :: PubREL -> [PubREL]

Show PubREL

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> PubREL -> ShowS

show :: PubREL -> String

showList :: [PubREL] -> ShowS

Eq PubREL

Defined in Network.MQTT.Types

Methods

(==) :: PubREL -> PubREL -> Bool

(/=) :: PubREL -> PubREL -> Bool

ByteMe PubREL

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> PubREL -> [Word8]

toByteString :: ProtocolLevel -> PubREL -> ByteString

data PubCOMP

Constructors

PubCOMP PktID Word8 [Property]

Instances

Arbitrary PubCOMP

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen PubCOMP

shrink :: PubCOMP -> [PubCOMP]

Show PubCOMP

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> PubCOMP -> ShowS

show :: PubCOMP -> String

showList :: [PubCOMP] -> ShowS

Eq PubCOMP

Defined in Network.MQTT.Types

Methods

(==) :: PubCOMP -> PubCOMP -> Bool

(/=) :: PubCOMP -> PubCOMP -> Bool

ByteMe PubCOMP

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> PubCOMP -> [Word8]

toByteString :: ProtocolLevel -> PubCOMP -> ByteString

data ProtocolLevel

MQTT Protocol Levels

Constructors

Protocol311

MQTT 3.1.1

Protocol50

MQTT 5.0

Instances

Arbitrary ProtocolLevel

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen ProtocolLevel

shrink :: ProtocolLevel -> [ProtocolLevel]

Bounded ProtocolLevel

Defined in Network.MQTT.Types

Methods

minBound :: ProtocolLevel

maxBound :: ProtocolLevel

Enum ProtocolLevel

Defined in Network.MQTT.Types

Methods

succ :: ProtocolLevel -> ProtocolLevel

pred :: ProtocolLevel -> ProtocolLevel

toEnum :: Int -> ProtocolLevel

fromEnum :: ProtocolLevel -> Int

enumFrom :: ProtocolLevel -> [ProtocolLevel]

enumFromThen :: ProtocolLevel -> ProtocolLevel -> [ProtocolLevel]

enumFromTo :: ProtocolLevel -> ProtocolLevel -> [ProtocolLevel]

enumFromThenTo :: ProtocolLevel -> ProtocolLevel -> ProtocolLevel -> [ProtocolLevel]

Show ProtocolLevel

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> ProtocolLevel -> ShowS

show :: ProtocolLevel -> String

showList :: [ProtocolLevel] -> ShowS

Eq ProtocolLevel

Defined in Network.MQTT.Types

Methods

(==) :: ProtocolLevel -> ProtocolLevel -> Bool

(/=) :: ProtocolLevel -> ProtocolLevel -> Bool

ByteMe ProtocolLevel

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> ProtocolLevel -> [Word8]

toByteString :: ProtocolLevel -> ProtocolLevel -> ByteString

data Property

Property represents the various MQTT Properties that may sent or received along with packets in MQTT 5. For detailed use on when and where to use them, consult with the MQTT 5.0 spec.

Constructors

PropPayloadFormatIndicator Word8

PropMessageExpiryInterval Word32

PropContentType ByteString

PropResponseTopic ByteString

PropCorrelationData ByteString

PropSubscriptionIdentifier Int

PropSessionExpiryInterval Word32

PropAssignedClientIdentifier ByteString

PropServerKeepAlive Word16

PropAuthenticationMethod ByteString

PropAuthenticationData ByteString

PropRequestProblemInformation Word8

PropWillDelayInterval Word32

PropRequestResponseInformation Word8

PropResponseInformation ByteString

PropServerReference ByteString

PropReasonString ByteString

PropReceiveMaximum Word16

PropTopicAliasMaximum Word16

PropTopicAlias Word16

PropMaximumQoS Word8

PropRetainAvailable Word8

PropUserProperty ByteString ByteString

PropMaximumPacketSize Word32

PropWildcardSubscriptionAvailable Word8

PropSubscriptionIdentifierAvailable Word8

PropSharedSubscriptionAvailable Word8

Instances

Arbitrary Property

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen Property

shrink :: Property -> [Property]

Show Property

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> Property -> ShowS

show :: Property -> String

showList :: [Property] -> ShowS

Eq Property

Defined in Network.MQTT.Types

Methods

(==) :: Property -> Property -> Bool

(/=) :: Property -> Property -> Bool

ByteMe Property

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> Property -> [Word8]

toByteString :: ProtocolLevel -> Property -> ByteString

data AuthRequest

Constructors

AuthRequest Word8 [Property]

Instances

Arbitrary AuthRequest

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen AuthRequest

shrink :: AuthRequest -> [AuthRequest]

Show AuthRequest

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> AuthRequest -> ShowS

show :: AuthRequest -> String

showList :: [AuthRequest] -> ShowS

Eq AuthRequest

Defined in Network.MQTT.Types

Methods

(==) :: AuthRequest -> AuthRequest -> Bool

(/=) :: AuthRequest -> AuthRequest -> Bool

ByteMe AuthRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> AuthRequest -> [Word8]

toByteString :: ProtocolLevel -> AuthRequest -> ByteString

data SubscribeRequest

Constructors

SubscribeRequest PktID [(ByteString, SubOptions)] [Property]

Instances

Arbitrary SubscribeRequest

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen SubscribeRequest

shrink :: SubscribeRequest -> [SubscribeRequest]

Show SubscribeRequest

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> SubscribeRequest -> ShowS

show :: SubscribeRequest -> String

showList :: [SubscribeRequest] -> ShowS

Eq SubscribeRequest

Defined in Network.MQTT.Types

Methods

(==) :: SubscribeRequest -> SubscribeRequest -> Bool

(/=) :: SubscribeRequest -> SubscribeRequest -> Bool

ByteMe SubscribeRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> SubscribeRequest -> [Word8]

toByteString :: ProtocolLevel -> SubscribeRequest -> ByteString

data SubOptions

Options used at subscribe time to define how to handle incoming messages.

Constructors

SubOptions

Fields

• _retainHandling :: RetainHandling

  How to handle existing retained messages.

• _retainAsPublished :: Bool

  If true, retain is propagated on subscribe.

• _noLocal :: Bool

  If true, do not send messages initiated from this client back.

• _subQoS :: QoS

  Maximum QoS to use for this subscription.

Instances

Arbitrary SubOptions

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen SubOptions

shrink :: SubOptions -> [SubOptions]

Show SubOptions

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> SubOptions -> ShowS

show :: SubOptions -> String

showList :: [SubOptions] -> ShowS

Eq SubOptions

Defined in Network.MQTT.Types

Methods

(==) :: SubOptions -> SubOptions -> Bool

(/=) :: SubOptions -> SubOptions -> Bool

ByteMe SubOptions

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> SubOptions -> [Word8]

toByteString :: ProtocolLevel -> SubOptions -> ByteString

subOptions :: SubOptions

Reasonable subscription option defaults at QoS0.

data SubscribeResponse

Constructors

SubscribeResponse PktID [Either SubErr QoS] [Property]

Instances

Arbitrary SubscribeResponse

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen SubscribeResponse

shrink :: SubscribeResponse -> [SubscribeResponse]

Show SubscribeResponse

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> SubscribeResponse -> ShowS

show :: SubscribeResponse -> String

showList :: [SubscribeResponse] -> ShowS

Eq SubscribeResponse

Defined in Network.MQTT.Types

Methods

(==) :: SubscribeResponse -> SubscribeResponse -> Bool

(/=) :: SubscribeResponse -> SubscribeResponse -> Bool

ByteMe SubscribeResponse

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> SubscribeResponse -> [Word8]

toByteString :: ProtocolLevel -> SubscribeResponse -> ByteString

data SubErr

Constructors

SubErrUnspecifiedError

SubErrImplementationSpecificError

SubErrNotAuthorized

SubErrTopicFilterInvalid

SubErrPacketIdentifierInUse

SubErrQuotaExceeded

SubErrSharedSubscriptionsNotSupported

SubErrSubscriptionIdentifiersNotSupported

SubErrWildcardSubscriptionsNotSupported

Instances

Arbitrary SubErr

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen SubErr

shrink :: SubErr -> [SubErr]

Bounded SubErr

Defined in Network.MQTT.Types

Methods

minBound :: SubErr

maxBound :: SubErr

Enum SubErr

Defined in Network.MQTT.Types

Methods

succ :: SubErr -> SubErr

pred :: SubErr -> SubErr

toEnum :: Int -> SubErr

fromEnum :: SubErr -> Int

enumFrom :: SubErr -> [SubErr]

enumFromThen :: SubErr -> SubErr -> [SubErr]

enumFromTo :: SubErr -> SubErr -> [SubErr]

enumFromThenTo :: SubErr -> SubErr -> SubErr -> [SubErr]

Show SubErr

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> SubErr -> ShowS

show :: SubErr -> String

showList :: [SubErr] -> ShowS

Eq SubErr

Defined in Network.MQTT.Types

Methods

(==) :: SubErr -> SubErr -> Bool

(/=) :: SubErr -> SubErr -> Bool

data RetainHandling

How to process retained messages on subscriptions.

Constructors

SendOnSubscribe

Send existing retained messages to a new client.

SendOnSubscribeNew

Send existing retained messages that have not yet been sent.

DoNotSendOnSubscribe

Don't send existing retained messages.

Instances

Bounded RetainHandling

Defined in Network.MQTT.Types

Methods

minBound :: RetainHandling

maxBound :: RetainHandling

Enum RetainHandling

Defined in Network.MQTT.Types

Methods

succ :: RetainHandling -> RetainHandling

pred :: RetainHandling -> RetainHandling

toEnum :: Int -> RetainHandling

fromEnum :: RetainHandling -> Int

enumFrom :: RetainHandling -> [RetainHandling]

enumFromThen :: RetainHandling -> RetainHandling -> [RetainHandling]

enumFromTo :: RetainHandling -> RetainHandling -> [RetainHandling]

enumFromThenTo :: RetainHandling -> RetainHandling -> RetainHandling -> [RetainHandling]

Show RetainHandling

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> RetainHandling -> ShowS

show :: RetainHandling -> String

showList :: [RetainHandling] -> ShowS

Eq RetainHandling

Defined in Network.MQTT.Types

Methods

(==) :: RetainHandling -> RetainHandling -> Bool

(/=) :: RetainHandling -> RetainHandling -> Bool

data DisconnectRequest

Constructors

DisconnectRequest DiscoReason [Property]

Instances

Arbitrary DisconnectRequest

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen DisconnectRequest

shrink :: DisconnectRequest -> [DisconnectRequest]

Show DisconnectRequest

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> DisconnectRequest -> ShowS

show :: DisconnectRequest -> String

showList :: [DisconnectRequest] -> ShowS

Eq DisconnectRequest

Defined in Network.MQTT.Types

Methods

(==) :: DisconnectRequest -> DisconnectRequest -> Bool

(/=) :: DisconnectRequest -> DisconnectRequest -> Bool

ByteMe DisconnectRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> DisconnectRequest -> [Word8]

toByteString :: ProtocolLevel -> DisconnectRequest -> ByteString

data UnsubscribeRequest

Constructors

UnsubscribeRequest PktID [ByteString] [Property]

Instances

Arbitrary UnsubscribeRequest

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen UnsubscribeRequest

shrink :: UnsubscribeRequest -> [UnsubscribeRequest]

Show UnsubscribeRequest

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> UnsubscribeRequest -> ShowS

show :: UnsubscribeRequest -> String

showList :: [UnsubscribeRequest] -> ShowS

Eq UnsubscribeRequest

Defined in Network.MQTT.Types

Methods

(==) :: UnsubscribeRequest -> UnsubscribeRequest -> Bool

(/=) :: UnsubscribeRequest -> UnsubscribeRequest -> Bool

ByteMe UnsubscribeRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> UnsubscribeRequest -> [Word8]

toByteString :: ProtocolLevel -> UnsubscribeRequest -> ByteString

data UnsubscribeResponse

Constructors

UnsubscribeResponse PktID [Property] [UnsubStatus]

Instances

Arbitrary UnsubscribeResponse

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen UnsubscribeResponse

shrink :: UnsubscribeResponse -> [UnsubscribeResponse]

Show UnsubscribeResponse

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> UnsubscribeResponse -> ShowS

show :: UnsubscribeResponse -> String

showList :: [UnsubscribeResponse] -> ShowS

Eq UnsubscribeResponse

Defined in Network.MQTT.Types

Methods

(==) :: UnsubscribeResponse -> UnsubscribeResponse -> Bool

(/=) :: UnsubscribeResponse -> UnsubscribeResponse -> Bool

ByteMe UnsubscribeResponse

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> UnsubscribeResponse -> [Word8]

toByteString :: ProtocolLevel -> UnsubscribeResponse -> ByteString

data UnsubStatus

Constructors

UnsubSuccess

UnsubNoSubscriptionExisted

UnsubUnspecifiedError

UnsubImplementationSpecificError

UnsubNotAuthorized

UnsubTopicFilterInvalid

UnsubPacketIdentifierInUse

Instances

Arbitrary UnsubStatus

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen UnsubStatus

shrink :: UnsubStatus -> [UnsubStatus]

Bounded UnsubStatus

Defined in Network.MQTT.Types

Methods

minBound :: UnsubStatus

maxBound :: UnsubStatus

Enum UnsubStatus

Defined in Network.MQTT.Types

Methods

succ :: UnsubStatus -> UnsubStatus

pred :: UnsubStatus -> UnsubStatus

toEnum :: Int -> UnsubStatus

fromEnum :: UnsubStatus -> Int

enumFrom :: UnsubStatus -> [UnsubStatus]

enumFromThen :: UnsubStatus -> UnsubStatus -> [UnsubStatus]

enumFromTo :: UnsubStatus -> UnsubStatus -> [UnsubStatus]

enumFromThenTo :: UnsubStatus -> UnsubStatus -> UnsubStatus -> [UnsubStatus]

Show UnsubStatus

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> UnsubStatus -> ShowS

show :: UnsubStatus -> String

showList :: [UnsubStatus] -> ShowS

Eq UnsubStatus

Defined in Network.MQTT.Types

Methods

(==) :: UnsubStatus -> UnsubStatus -> Bool

(/=) :: UnsubStatus -> UnsubStatus -> Bool

ByteMe UnsubStatus

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> UnsubStatus -> [Word8]

toByteString :: ProtocolLevel -> UnsubStatus -> ByteString

data DiscoReason

Constructors

DiscoNormalDisconnection

DiscoDisconnectWithWill

DiscoUnspecifiedError

DiscoMalformedPacket

DiscoProtocolError

DiscoImplementationSpecificError

DiscoNotAuthorized

DiscoServerBusy

DiscoServershuttingDown

DiscoKeepAliveTimeout

DiscoSessiontakenOver

DiscoTopicFilterInvalid

DiscoTopicNameInvalid

DiscoReceiveMaximumExceeded

DiscoTopicAliasInvalid

DiscoPacketTooLarge

DiscoMessageRateTooHigh

DiscoQuotaExceeded

DiscoAdministrativeAction

DiscoPayloadFormatInvalid

DiscoRetainNotSupported

DiscoQoSNotSupported

DiscoUseAnotherServer

DiscoServerMoved

DiscoSharedSubscriptionsNotSupported

DiscoConnectionRateExceeded

DiscoMaximumConnectTime

DiscoSubscriptionIdentifiersNotSupported

DiscoWildcardSubscriptionsNotSupported

Instances

Arbitrary DiscoReason

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen DiscoReason

shrink :: DiscoReason -> [DiscoReason]

Bounded DiscoReason

Defined in Network.MQTT.Types

Methods

minBound :: DiscoReason

maxBound :: DiscoReason

Enum DiscoReason

Defined in Network.MQTT.Types

Methods

succ :: DiscoReason -> DiscoReason

pred :: DiscoReason -> DiscoReason

toEnum :: Int -> DiscoReason

fromEnum :: DiscoReason -> Int

enumFrom :: DiscoReason -> [DiscoReason]

enumFromThen :: DiscoReason -> DiscoReason -> [DiscoReason]

enumFromTo :: DiscoReason -> DiscoReason -> [DiscoReason]

enumFromThenTo :: DiscoReason -> DiscoReason -> DiscoReason -> [DiscoReason]

Show DiscoReason

Defined in Network.MQTT.Types

Methods

showsPrec :: Int -> DiscoReason -> ShowS

show :: DiscoReason -> String

showList :: [DiscoReason] -> ShowS

Eq DiscoReason

Defined in Network.MQTT.Types

Methods

(==) :: DiscoReason -> DiscoReason -> Bool

(/=) :: DiscoReason -> DiscoReason -> Bool

ByteSize DiscoReason

Defined in Network.MQTT.Types

Methods

toByte :: DiscoReason -> Word8

fromByte :: Word8 -> DiscoReason

type PktID = Word16

parsePacket :: ProtocolLevel -> Parser MQTTPkt

class ByteMe a where

Minimal complete definition

Nothing

Methods

toByteString :: ProtocolLevel -> a -> ByteString

Instances

ByteMe ByteString

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> ByteString -> [Word8]

toByteString :: ProtocolLevel -> ByteString -> ByteString

ByteMe AuthRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> AuthRequest -> [Word8]

toByteString :: ProtocolLevel -> AuthRequest -> ByteString

ByteMe ConnACKFlags

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> ConnACKFlags -> [Word8]

toByteString :: ProtocolLevel -> ConnACKFlags -> ByteString

ByteMe ConnectRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> ConnectRequest -> [Word8]

toByteString :: ProtocolLevel -> ConnectRequest -> ByteString

ByteMe DisconnectRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> DisconnectRequest -> [Word8]

toByteString :: ProtocolLevel -> DisconnectRequest -> ByteString

ByteMe MQTTPkt

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> MQTTPkt -> [Word8]

toByteString :: ProtocolLevel -> MQTTPkt -> ByteString

ByteMe Property

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> Property -> [Word8]

toByteString :: ProtocolLevel -> Property -> ByteString

ByteMe ProtocolLevel

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> ProtocolLevel -> [Word8]

toByteString :: ProtocolLevel -> ProtocolLevel -> ByteString

ByteMe PubACK

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> PubACK -> [Word8]

toByteString :: ProtocolLevel -> PubACK -> ByteString

ByteMe PubCOMP

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> PubCOMP -> [Word8]

toByteString :: ProtocolLevel -> PubCOMP -> ByteString

ByteMe PubREC

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> PubREC -> [Word8]

toByteString :: ProtocolLevel -> PubREC -> ByteString

ByteMe PubREL

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> PubREL -> [Word8]

toByteString :: ProtocolLevel -> PubREL -> ByteString

ByteMe PublishRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> PublishRequest -> [Word8]

toByteString :: ProtocolLevel -> PublishRequest -> ByteString

ByteMe SubOptions

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> SubOptions -> [Word8]

toByteString :: ProtocolLevel -> SubOptions -> ByteString

ByteMe SubscribeRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> SubscribeRequest -> [Word8]

toByteString :: ProtocolLevel -> SubscribeRequest -> ByteString

ByteMe SubscribeResponse

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> SubscribeResponse -> [Word8]

toByteString :: ProtocolLevel -> SubscribeResponse -> ByteString

ByteMe UnsubStatus

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> UnsubStatus -> [Word8]

toByteString :: ProtocolLevel -> UnsubStatus -> ByteString

ByteMe UnsubscribeRequest

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> UnsubscribeRequest -> [Word8]

toByteString :: ProtocolLevel -> UnsubscribeRequest -> ByteString

ByteMe UnsubscribeResponse

Defined in Network.MQTT.Types

Methods

toBytes :: ProtocolLevel -> UnsubscribeResponse -> [Word8]

toByteString :: ProtocolLevel -> UnsubscribeResponse -> ByteString

parseConnect :: Parser MQTTPkt

Parse a CONNect packet. This is useful when examining the beginning of the stream as it allows you to determine the protocol being used throughout the rest of the session.

encodeLength :: Int -> [Word8]

parseHdrLen :: Parser Int

parseProperty :: Parser Property

parseProperties :: ProtocolLevel -> Parser [Property]

bsProps :: ProtocolLevel -> [Property] -> ByteString

parseSubOptions :: Parser SubOptions

class ByteSize a where

Methods

toByte :: a -> Word8

fromByte :: Word8 -> a

Instances

ByteSize ConnACKRC

Defined in Network.MQTT.Types

Methods

toByte :: ConnACKRC -> Word8

fromByte :: Word8 -> ConnACKRC

ByteSize DiscoReason

Defined in Network.MQTT.Types

Methods

toByte :: DiscoReason -> Word8

fromByte :: Word8 -> DiscoReason