Stability	unstable
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Xmpp.Internal

Description

This module allows for low-level access to Pontarius XMPP. Generally, the Network.Xmpp module should be used instead.

The Stream object provides the most low-level access to the XMPP stream: a simple and single-threaded interface which exposes the conduit Event source, as well as the input and output byte streams. Custom stateful Stream functions can be executed using withStream.

The TLS, SASL, and Session functionalities of Pontarius XMPP are built on top of this API.

Synopsis

withConnection :: (Stream -> IO (b, Stream)) -> Session -> IO (Either XmppFailure b)
modifyHandlers :: (EventHandlers -> EventHandlers) -> Session -> IO ()
setConnectionClosedHandler :: (XmppFailure -> Session -> IO ()) -> Session -> IO ()
runConnectionClosedHandler :: Session -> XmppFailure -> IO ()
runHandler :: (EventHandlers -> IO a) -> Session -> IO a
endSession :: Session -> IO ()
closeConnection :: Session -> IO ()
readWorker :: (XmppElement -> IO ()) -> (XmppFailure -> IO ()) -> TMVar Stream -> IO a
startThreadsWith :: TMVar (ByteString -> IO (Either XmppFailure ())) -> (XmppElement -> IO ()) -> TMVar EventHandlers -> Stream -> Maybe Int -> IO (Either XmppFailure (IO (), TMVar Stream, ThreadId))
connPersist :: Maybe Int -> TMVar (ByteString -> IO a) -> IO ()
semWrite :: WriteSemaphore -> ByteString -> IO (Either XmppFailure ())
writeXmppElem :: WriteSemaphore -> XmppElement -> IO (Either XmppFailure ())
writeStanza :: WriteSemaphore -> Stanza -> IO (Either XmppFailure ())
sendRawStanza :: Stanza -> Session -> IO (Either XmppFailure ())
sendStanza :: Stanza -> Session -> IO (Either XmppFailure ())
getStanzaChan :: Session -> TChan (Stanza, [Annotation])
getStanza :: Session -> IO (Stanza, [Annotation])
dupSession :: Session -> IO Session
getJid :: Session -> IO (Maybe Jid)
getFeatures :: Session -> IO StreamFeatures
waitForStream :: Session -> IO ()
streamState :: Session -> STM ConnectionState
type StanzaHandler = (XmppElement -> IO (Either XmppFailure ())) -> XmppElement -> [Annotation] -> IO [(XmppElement, [Annotation])]
type Resource = Text
type AuthData = Maybe (ConnectionState -> [SaslHandler], Maybe Resource)
data Annotation = forall f.(Typeable f, Show f) => Annotation {
- fromAnnotation :: f
}
type Annotated a = (a, [Annotation])
getAnnotation :: Typeable b => Annotated a -> Maybe b
data Plugin' = Plugin' {
- inHandler :: XmppElement -> [Annotation] -> IO [(XmppElement, [Annotation])]
- outHandler :: XmppElement -> IO (Either XmppFailure ())
- onSessionUp :: Session -> IO ()
}
type Plugin = (XmppElement -> IO (Either XmppFailure ())) -> ExceptT XmppFailure IO Plugin'
type RosterPushCallback = Roster -> RosterUpdate -> IO ()
data SessionConfiguration = SessionConfiguration {
- sessionStreamConfiguration :: StreamConfiguration
- onConnectionClosed :: Session -> XmppFailure -> IO ()
- sessionStanzaIDs :: IO (IO Text)
- plugins :: [Plugin]
- enableRoster :: Bool
- initialRoster :: IO (Maybe Roster)
- onRosterPush :: Maybe RosterPushCallback
- enablePresenceTracking :: Bool
- onPresenceChange :: Maybe (Jid -> PeerStatus -> PeerStatus -> IO ())
- keepAlive :: Maybe Int
}
data EventHandlers = EventHandlers {
- connectionClosedHandler :: XmppFailure -> IO ()
}
data Interrupt = Interrupt (TMVar ())
type WriteSemaphore = TMVar (ByteString -> IO (Either XmppFailure ()))
data Session = Session {
- stanzaCh :: TChan (Stanza, [Annotation])
- iqHandlers :: TVar IQHandlers
- writeSemaphore :: WriteSemaphore
- readerThread :: ThreadId
- idGenerator :: IO Text
- streamRef :: TMVar Stream
- eventHandlers :: TMVar EventHandlers
- stopThreads :: IO ()
- rosterRef :: TVar Roster
- presenceRef :: TVar Peers
- conf :: SessionConfiguration
- sendStanza' :: Stanza -> IO (Either XmppFailure ())
- sRealm :: HostName
- sSaslCredentials :: Maybe (ConnectionState -> [SaslHandler], Maybe Text)
- reconnectWait :: TVar Int
}
type IQHandlers = (Map (IQRequestType, Text) (TChan IQRequestTicket), Map Text (Either (Maybe Jid) Jid, TMVar (Maybe (Annotated IQResponse))))
data IQRequestTicket = IQRequestTicket {
- answerTicket :: Either StanzaError (Maybe Element) -> [ExtendedAttribute] -> IO (Maybe (Either XmppFailure ()))
- iqRequestBody :: IQRequest
- iqRequestAnnotations :: [Annotation]
}
data IQSendError
- = IQSendError XmppFailure
- | IQTimeOut
pullMessageA :: Session -> IO (Either (Annotated MessageError) (Annotated Message))
pullMessage :: Session -> IO (Either MessageError Message)
getMessageA :: Session -> IO (Annotated Message)
getMessage :: Session -> IO Message
waitForMessageA :: (Annotated Message -> Bool) -> Session -> IO (Annotated Message)
waitForMessage :: (Message -> Bool) -> Session -> IO Message
waitForMessageErrorA :: (Annotated MessageError -> Bool) -> Session -> IO (Annotated MessageError)
waitForMessageError :: (MessageError -> Bool) -> Session -> IO MessageError
filterMessagesA :: (Annotated MessageError -> Bool) -> (Annotated Message -> Bool) -> Session -> IO (Either (Annotated MessageError) (Annotated Message))
filterMessages :: (MessageError -> Bool) -> (Message -> Bool) -> Session -> IO (Either MessageError Message)
sendMessage :: Message -> Session -> IO (Either XmppFailure ())
pullPresenceA :: Session -> IO (Either (Annotated PresenceError) (Annotated Presence))
pullPresence :: Session -> IO (Either PresenceError Presence)
waitForPresenceA :: (Annotated Presence -> Bool) -> Session -> IO (Annotated Presence)
waitForPresence :: (Presence -> Bool) -> Session -> IO Presence
sendPresence :: Presence -> Session -> IO (Either XmppFailure ())
sendIQ :: Maybe Integer -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> [ExtendedAttribute] -> Session -> IO (Either XmppFailure (STM (Maybe (Annotated IQResponse))))
sendIQA' :: Maybe Integer -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> [ExtendedAttribute] -> Session -> IO (Either IQSendError (Annotated IQResponse))
sendIQ' :: Maybe Integer -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> [ExtendedAttribute] -> Session -> IO (Either IQSendError IQResponse)
listenIQ :: IQRequestType -> Text -> Session -> IO (Either (STM IQRequestTicket) (STM IQRequestTicket))
unlistenIQ :: IQRequestType -> Text -> Session -> IO ()
answerIQ :: IQRequestTicket -> Either StanzaError (Maybe Element) -> [ExtendedAttribute] -> IO (Maybe (Either XmppFailure ()))
class IQRequestClass a where
- data IQResponseType a
- pickleRequest :: PU Element a
- pickleResponse :: PU [Element] (IQResponseType a)
- requestType :: a -> IQRequestType
- requestNamespace :: a -> Text
data IQRequestError
- = IQRequestSendError XmppFailure
- | IQRequestTimeout
- | IQRequestUnpickleError UnpickleError
sendIQRequest :: (IQRequestClass a, MonadError IQRequestError m, MonadIO m) => Maybe Integer -> Maybe Jid -> a -> Session -> m (Either IQError (IQResponseType a))
type IQRequestHandler a = a -> IO (Either StanzaError (IQResponseType a))
runIQHandler :: IQRequestClass a => IQRequestHandler a -> Session -> IO ()
newSession :: Stream -> SessionConfiguration -> HostName -> Maybe (ConnectionState -> [SaslHandler], Maybe Text) -> IO (Either XmppFailure Session)
session :: HostName -> AuthData -> SessionConfiguration -> IO (Either XmppFailure Session)
newStanzaID :: Session -> IO Text
reconnect :: Integer -> Session -> IO (Bool, [XmppFailure])
reconnect' :: Session -> IO Integer
reconnectNow :: Session -> IO (Maybe XmppFailure)
simpleAuth :: Username -> Password -> AuthData
semWrite :: WriteSemaphore -> ByteString -> IO (Either XmppFailure ())
writeXmppElem :: WriteSemaphore -> XmppElement -> IO (Either XmppFailure ())
writeStanza :: WriteSemaphore -> Stanza -> IO (Either XmppFailure ())
sendRawStanza :: Stanza -> Session -> IO (Either XmppFailure ())
sendStanza :: Stanza -> Session -> IO (Either XmppFailure ())
getStanzaChan :: Session -> TChan (Stanza, [Annotation])
getStanza :: Session -> IO (Stanza, [Annotation])
dupSession :: Session -> IO Session
getJid :: Session -> IO (Maybe Jid)
getFeatures :: Session -> IO StreamFeatures
waitForStream :: Session -> IO ()
streamState :: Session -> STM ConnectionState
sendIQ :: Maybe Integer -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> [ExtendedAttribute] -> Session -> IO (Either XmppFailure (STM (Maybe (Annotated IQResponse))))
sendIQA' :: Maybe Integer -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> [ExtendedAttribute] -> Session -> IO (Either IQSendError (Annotated IQResponse))
sendIQ' :: Maybe Integer -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> [ExtendedAttribute] -> Session -> IO (Either IQSendError IQResponse)
listenIQ :: IQRequestType -> Text -> Session -> IO (Either (STM IQRequestTicket) (STM IQRequestTicket))
unlistenIQ :: IQRequestType -> Text -> Session -> IO ()
answerIQ :: IQRequestTicket -> Either StanzaError (Maybe Element) -> [ExtendedAttribute] -> IO (Maybe (Either XmppFailure ()))
class IQRequestClass a where
- data IQResponseType a
- pickleRequest :: PU Element a
- pickleResponse :: PU [Element] (IQResponseType a)
- requestType :: a -> IQRequestType
- requestNamespace :: a -> Text
data IQRequestError
- = IQRequestSendError XmppFailure
- | IQRequestTimeout
- | IQRequestUnpickleError UnpickleError
sendIQRequest :: (IQRequestClass a, MonadError IQRequestError m, MonadIO m) => Maybe Integer -> Maybe Jid -> a -> Session -> m (Either IQError (IQResponseType a))
type IQRequestHandler a = a -> IO (Either StanzaError (IQResponseType a))
runIQHandler :: IQRequestClass a => IQRequestHandler a -> Session -> IO ()
pullMessageA :: Session -> IO (Either (Annotated MessageError) (Annotated Message))
pullMessage :: Session -> IO (Either MessageError Message)
getMessageA :: Session -> IO (Annotated Message)
getMessage :: Session -> IO Message
waitForMessageA :: (Annotated Message -> Bool) -> Session -> IO (Annotated Message)
waitForMessage :: (Message -> Bool) -> Session -> IO Message
waitForMessageErrorA :: (Annotated MessageError -> Bool) -> Session -> IO (Annotated MessageError)
waitForMessageError :: (MessageError -> Bool) -> Session -> IO MessageError
filterMessagesA :: (Annotated MessageError -> Bool) -> (Annotated Message -> Bool) -> Session -> IO (Either (Annotated MessageError) (Annotated Message))
filterMessages :: (MessageError -> Bool) -> (Message -> Bool) -> Session -> IO (Either MessageError Message)
sendMessage :: Message -> Session -> IO (Either XmppFailure ())
withConnection :: (Stream -> IO (b, Stream)) -> Session -> IO (Either XmppFailure b)
modifyHandlers :: (EventHandlers -> EventHandlers) -> Session -> IO ()
setConnectionClosedHandler :: (XmppFailure -> Session -> IO ()) -> Session -> IO ()
runConnectionClosedHandler :: Session -> XmppFailure -> IO ()
runHandler :: (EventHandlers -> IO a) -> Session -> IO a
endSession :: Session -> IO ()
closeConnection :: Session -> IO ()
pullPresenceA :: Session -> IO (Either (Annotated PresenceError) (Annotated Presence))
pullPresence :: Session -> IO (Either PresenceError Presence)
waitForPresenceA :: (Annotated Presence -> Bool) -> Session -> IO (Annotated Presence)
waitForPresence :: (Presence -> Bool) -> Session -> IO Presence
sendPresence :: Presence -> Session -> IO (Either XmppFailure ())
readWorker :: (XmppElement -> IO ()) -> (XmppFailure -> IO ()) -> TMVar Stream -> IO a
startThreadsWith :: TMVar (ByteString -> IO (Either XmppFailure ())) -> (XmppElement -> IO ()) -> TMVar EventHandlers -> Stream -> Maybe Int -> IO (Either XmppFailure (IO (), TMVar Stream, ThreadId))
connPersist :: Maybe Int -> TMVar (ByteString -> IO a) -> IO ()
type StanzaHandler = (XmppElement -> IO (Either XmppFailure ())) -> XmppElement -> [Annotation] -> IO [(XmppElement, [Annotation])]
type Resource = Text
type AuthData = Maybe (ConnectionState -> [SaslHandler], Maybe Resource)
data Annotation = forall f.(Typeable f, Show f) => Annotation {
- fromAnnotation :: f
}
type Annotated a = (a, [Annotation])
getAnnotation :: Typeable b => Annotated a -> Maybe b
data Plugin' = Plugin' {
- inHandler :: XmppElement -> [Annotation] -> IO [(XmppElement, [Annotation])]
- outHandler :: XmppElement -> IO (Either XmppFailure ())
- onSessionUp :: Session -> IO ()
}
type Plugin = (XmppElement -> IO (Either XmppFailure ())) -> ExceptT XmppFailure IO Plugin'
type RosterPushCallback = Roster -> RosterUpdate -> IO ()
data SessionConfiguration = SessionConfiguration {
- sessionStreamConfiguration :: StreamConfiguration
- onConnectionClosed :: Session -> XmppFailure -> IO ()
- sessionStanzaIDs :: IO (IO Text)
- plugins :: [Plugin]
- enableRoster :: Bool
- initialRoster :: IO (Maybe Roster)
- onRosterPush :: Maybe RosterPushCallback
- enablePresenceTracking :: Bool
- onPresenceChange :: Maybe (Jid -> PeerStatus -> PeerStatus -> IO ())
- keepAlive :: Maybe Int
}
data EventHandlers = EventHandlers {
- connectionClosedHandler :: XmppFailure -> IO ()
}
data Interrupt = Interrupt (TMVar ())
type WriteSemaphore = TMVar (ByteString -> IO (Either XmppFailure ()))
data Session = Session {
- stanzaCh :: TChan (Stanza, [Annotation])
- iqHandlers :: TVar IQHandlers
- writeSemaphore :: WriteSemaphore
- readerThread :: ThreadId
- idGenerator :: IO Text
- streamRef :: TMVar Stream
- eventHandlers :: TMVar EventHandlers
- stopThreads :: IO ()
- rosterRef :: TVar Roster
- presenceRef :: TVar Peers
- conf :: SessionConfiguration
- sendStanza' :: Stanza -> IO (Either XmppFailure ())
- sRealm :: HostName
- sSaslCredentials :: Maybe (ConnectionState -> [SaslHandler], Maybe Text)
- reconnectWait :: TVar Int
}
type IQHandlers = (Map (IQRequestType, Text) (TChan IQRequestTicket), Map Text (Either (Maybe Jid) Jid, TMVar (Maybe (Annotated IQResponse))))
data IQRequestTicket = IQRequestTicket {
- answerTicket :: Either StanzaError (Maybe Element) -> [ExtendedAttribute] -> IO (Maybe (Either XmppFailure ()))
- iqRequestBody :: IQRequest
- iqRequestAnnotations :: [Annotation]
}
data IQSendError
- = IQSendError XmppFailure
- | IQTimeOut
data MessageBody = MessageBody {
- bodyLang :: Maybe LangTag
- bodyContent :: Text
}
data MessageThread = MessageThread {
- threadID :: Text
- threadParent :: Maybe Text
}
data MessageSubject = MessageSubject {
- subjectLang :: Maybe LangTag
- subjectContent :: Text
}
data InstantMessage = InstantMessage {
- imThread :: Maybe MessageThread
- imSubject :: [MessageSubject]
- imBody :: [MessageBody]
}
instantMessage :: InstantMessage
getIM :: Message -> Maybe InstantMessage
sanitizeIM :: InstantMessage -> InstantMessage
withIM :: Message -> InstantMessage -> Message
imToElements :: InstantMessage -> [Element]
simpleIM :: Jid -> Text -> Message
answerIM :: [MessageBody] -> Message -> Maybe Message
xpIM :: PU [Element] InstantMessage
xpMessageSubject :: PU [Element] [MessageSubject]
xpMessageBody :: PU [Element] [MessageBody]
xpMessageThread :: PU [Element] (Maybe MessageThread)
data ShowStatus
- = StatusAway
- | StatusChat
- | StatusDnd
- | StatusXa
data IMPresence = IMP {
- showStatus :: Maybe ShowStatus
- status :: Maybe Text
- priority :: Maybe Int
}
imPresence :: IMPresence
getIMPresence :: Presence -> Maybe IMPresence
withIMPresence :: IMPresence -> Presence -> Presence
xpIMPresence :: PU [Element] IMPresence
xpShow :: PU Text ShowStatus
timeout :: Maybe Integer
rosterSet :: Jid -> Maybe Text -> [Text] -> Session -> IO (Either IQSendError (Annotated IQResponse))
rosterAdd :: Jid -> Maybe Text -> [Text] -> Session -> IO (Either IQSendError (Annotated IQResponse))
rosterRemove :: Jid -> Session -> IO Bool
getRosterSTM :: Session -> STM Roster
getRoster :: Session -> IO Roster
initRoster :: Session -> IO ()
handleRoster :: Maybe Jid -> TVar Roster -> RosterPushCallback -> StanzaHandler
retrieveRoster :: Maybe Roster -> Session -> IO (Maybe Roster)
toItem :: QueryItem -> Item
fromItem :: Item -> QueryItem
xpItems :: PU [Node] [QueryItem]
xpQuery :: PU [Node] Query
xpSubscription :: PU Text Subscription
data Subscription
- = None
- | To
- | From
- | Both
- | Remove
data Roster = Roster {
- ver :: Maybe Text
- items :: Map Jid Item
}
data Item = Item {
- riApproved :: Bool
- riAsk :: Bool
- riJid :: Jid
- riName :: Maybe Text
- riSubscription :: Subscription
- riGroups :: [Text]
}
data RosterUpdate
- = RosterUpdateRemove Jid
- | RosterUpdateAdd Item
data QueryItem = QueryItem {
- qiApproved :: Maybe Bool
- qiAsk :: Bool
- qiJid :: Jid
- qiName :: Maybe Text
- qiSubscription :: Maybe Subscription
- qiGroups :: [Text]
}
data Query = Query {
- queryVer :: Maybe Text
- queryItems :: [QueryItem]
}
xpNonemptyText :: PU Text NonemptyText
xpStreamElement :: PU [Node] (Either StreamErrorInfo XmppElement)
xpStreamStanza :: PU [Node] (Either StreamErrorInfo Stanza)
xpExtendedAttrs :: PU [Attribute] [ExtendedAttribute]
xpStanza :: PU [Node] Stanza
xpMessage :: PU [Node] Message
xpPresence :: PU [Node] Presence
xpIQRequest :: PU [Node] IQRequest
xpIQResult :: PU [Node] IQResult
xpStanzaErrorCondition :: PU [Node] StanzaErrorCondition
xpStanzaError :: PU [Node] StanzaError
xpMessageError :: PU [Node] MessageError
xpPresenceError :: PU [Node] PresenceError
xpIQError :: PU [Node] IQError
xpStreamError :: PU [Node] StreamErrorInfo
xpLangTag :: PU [Attribute] (Maybe LangTag)
xpLang :: PU Text LangTag
xmlLang :: Name
pickleElem :: PU [Node] a -> a -> Element
unpickleElem :: PU [Node] a -> Element -> Either UnpickleError a
xpNodeElem :: PU [Node] a -> PU Element a
mbl :: Maybe [a] -> [a]
lmb :: [t] -> Maybe [t]
xpStream :: PU [Node] (Text, Maybe Jid, Maybe Jid, Maybe Text, Maybe LangTag)
xpStreamFeatures :: PU [Node] StreamFeatures
xpJid :: PU Text Jid
xpIQRequestType :: PU Text IQRequestType
xpMessageType :: PU Text MessageType
xpPresenceType :: PU Text PresenceType
xpStanzaErrorType :: PU Text StanzaErrorType
xpStreamErrorCondition :: PU Text StreamErrorCondition
xmppSasl :: [SaslHandler] -> Stream -> IO (Either XmppFailure (Maybe AuthFailure))
digestMd5 :: Username -> Maybe AuthZID -> Password -> SaslHandler
scramSha1 :: Username -> Maybe AuthZID -> Password -> SaslHandler
plain :: Username -> Maybe AuthZID -> Password -> SaslHandler
auth :: [SaslHandler] -> Maybe Text -> Stream -> IO (Either XmppFailure (Maybe AuthFailure))
makeNonce :: IO ByteString
saslInitE :: Text -> Maybe Text -> Element
saslResponseE :: Maybe Text -> Element
xpSuccess :: PU [Node] (Maybe Text)
pairs :: ByteString -> Either String Pairs
xpFailure :: PU [Node] SaslFailure
xpSaslError :: PU Text SaslError
xpChallenge :: PU [Node] (Maybe Text)
xpSaslElement :: PU [Node] SaslElement
quote :: ByteString -> ByteString
saslInit :: Text -> Maybe ByteString -> ExceptT AuthFailure (StateT StreamState IO) ()
pullSaslElement :: ExceptT AuthFailure (StateT StreamState IO) SaslElement
pullChallenge :: ExceptT AuthFailure (StateT StreamState IO) (Maybe ByteString)
saslFromJust :: Maybe a -> ExceptT AuthFailure (StateT StreamState IO) a
pullSuccess :: ExceptT AuthFailure (StateT StreamState IO) (Maybe Text)
pullFinalMessage :: ExceptT AuthFailure (StateT StreamState IO) (Maybe ByteString)
toPairs :: ByteString -> ExceptT AuthFailure (StateT StreamState IO) Pairs
respond :: Maybe ByteString -> ExceptT AuthFailure (StateT StreamState IO) ()
prepCredentials :: Text -> Maybe Text -> Text -> ExceptT AuthFailure (StateT StreamState IO) (Text, Maybe Text, Text)
xorBS :: ByteString -> ByteString -> ByteString
merge :: [ByteString] -> ByteString
(+++) :: ByteString -> ByteString -> ByteString
digestMd5 :: Username -> Maybe AuthZID -> Password -> SaslHandler
scramSha1 :: Username -> Maybe AuthZID -> Password -> SaslHandler
plain :: Username -> Maybe AuthZID -> Password -> SaslHandler
digestMd5 :: Username -> Maybe AuthZID -> Password -> SaslHandler
plain :: Username -> Maybe AuthZID -> Password -> SaslHandler
hashToken :: Hash ctx hash => hash
scram :: Hash ctx hash => hash -> Text -> Maybe Text -> Text -> ExceptT AuthFailure (StateT StreamState IO) ()
scramSha1 :: Username -> Maybe AuthZID -> Password -> SaslHandler
nonAsciiSpaces :: Set Char
toSpace :: Char -> Text
saslPrepQuery :: StringPrepProfile
saslPrepStore :: StringPrepProfile
normalizePassword :: Text -> Maybe Text
normalizeUsername :: Text -> Maybe Text
type Username = Text
type Password = Text
type AuthZID = Text
data SaslElement
- = SaslSuccess (Maybe Text)
- | SaslChallenge (Maybe Text)
type Pairs = [(ByteString, ByteString)]
type SaslHandler = (Text, StateT StreamState IO (Either XmppFailure (Maybe AuthFailure)))
presenceSubscribe :: Jid -> Presence
presenceSubscribed :: Jid -> Presence
presenceUnsubscribe :: Jid -> Presence
presenceUnsubscribed :: Jid -> Presence
presenceOnline :: Presence
presenceOffline :: Presence
answerMessage :: Message -> [Element] -> Maybe Message
presTo :: Presence -> Jid -> Presence
mkStanzaError :: StanzaErrorCondition -> StanzaError
iqError :: StanzaErrorCondition -> IQRequest -> IQError
iqResult :: Maybe Element -> IQRequest -> IQResult
associatedErrorType :: StanzaErrorCondition -> StanzaErrorType
type StreamSink a = ConduitM Event Void (ExceptT XmppFailure IO) a
readMaybe_ :: Read a => String -> Maybe a
streamUnpickleElem :: PU [Node] a -> Element -> StreamSink a
throwOutJunk :: Monad m => ConduitM Event a m ()
openElementFromEvents :: StreamSink Element
startStream :: StateT StreamState IO (Either XmppFailure ())
flattenAttrs :: [(Name, [Content])] -> [(Name, Text)]
restartStream :: StateT StreamState IO (Either XmppFailure ())
sourceStreamHandleRaw :: (MonadIO m, MonadError XmppFailure m) => StreamHandle -> ConduitM i ByteString m ()
sourceStreamHandle :: (MonadIO m, MonadError XmppFailure m) => StreamHandle -> ConduitM i ByteString m ()
logInput :: MonadIO m => ConduitM ByteString ByteString m ()
bufferSrc :: ConduitT () o (ExceptT XmppFailure IO) () -> IO (ConduitM i o (ExceptT XmppFailure IO) ())
streamS :: Maybe Jid -> StreamSink (Either Element (Text, Maybe Jid, Maybe Jid, Maybe Text, Maybe LangTag, StreamFeatures))
openStream :: HostName -> StreamConfiguration -> IO (Either XmppFailure Stream)
closeStreams :: Stream -> IO ()
closeStreams' :: StateT StreamState IO ()
debugOut :: MonadIO m => ByteString -> m ()
wrapIOException :: MonadIO m => String -> IO a -> m (Either XmppFailure a)
pushElement :: Element -> StateT StreamState IO (Either XmppFailure ())
nsHack :: Element -> Element
pushStanza :: Stanza -> Stream -> IO (Either XmppFailure ())
pushXmlDecl :: StateT StreamState IO (Either XmppFailure ())
pushOpenElement :: Element -> StateT StreamState IO (Either XmppFailure ())
runEventsSink :: ConduitT Event Void (ExceptT XmppFailure IO) b -> StateT StreamState IO (Either XmppFailure b)
pullElement :: StateT StreamState IO (Either XmppFailure Element)
pullUnpickle :: PU [Node] a -> StateT StreamState IO (Either XmppFailure a)
pullStanza :: Stream -> IO (Either XmppFailure Stanza)
pullXmppElement :: Stream -> IO (Either XmppFailure XmppElement)
catchPush :: IO () -> IO (Either XmppFailure ())
zeroHandle :: StreamHandle
xmppNoStream :: StreamState
zeroSource :: ConduitT () a (ExceptT XmppFailure IO) ()
handleToStreamHandle :: Handle -> StreamHandle
createStream :: HostName -> StreamConfiguration -> ExceptT XmppFailure IO Stream
connect :: HostName -> StreamConfiguration -> ExceptT XmppFailure IO (Maybe StreamHandle)
connectSrv :: ResolvConf -> String -> ExceptT XmppFailure IO (Maybe Handle)
connectHandle :: AddrInfo -> IO Handle
connectTcp :: [AddrInfo] -> IO (Maybe Handle)
fixDnsResult :: Either e a -> Maybe a
resolveAndConnectTcp :: HostName -> PortNumber -> IO (Maybe Handle)
resolvSrvsAndConnectTcp :: [(HostName, PortNumber)] -> IO (Maybe Handle)
rethrowErrorCall :: IO a -> IO a
srvLookup :: Text -> ResolvSeed -> ExceptT XmppFailure IO (Maybe [(Domain, Word16)])
killStream :: Stream -> IO (Either XmppFailure ())
pushIQ :: Text -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> Stream -> IO (Either XmppFailure (Either IQError IQResult))
debugConduit :: (Show o, MonadIO m) => ConduitM o o m b
elements :: MonadError XmppFailure m => ConduitT Event Element m ()
withStream :: StateT StreamState IO a -> Stream -> IO a
withStream' :: StateT StreamState IO a -> Stream -> IO a
mkStream :: StreamState -> IO Stream
tryIOError :: IO a -> IO (Either IOError a)
mkBackend :: StreamHandle -> Backend
starttlsE :: Element
tls :: Stream -> IO (Either XmppFailure ())
client :: MonadIO m => ClientParams -> Backend -> m Context
tlsinit :: (MonadIO m, MonadIO m1) => ClientParams -> Backend -> m (ConduitT () ByteString m1 (), ConduitT ByteString Void m1 (), ByteString -> IO (), Int -> m1 ByteString, Context)
mkReadBuffer :: IO ByteString -> IO (Int -> IO ByteString)
connectTls :: ResolvConf -> ClientParams -> String -> ExceptT XmppFailure IO StreamHandle
wrapExceptions :: IO a -> IO (Either XmppFailure a)
newtype NonemptyText = Nonempty {
- fromNonempty :: Text
}
nonEmpty :: Text -> Maybe NonemptyText
text :: NonemptyText -> Text
data IQError = IQError {
- iqErrorID :: !Text
- iqErrorFrom :: !(Maybe Jid)
- iqErrorTo :: !(Maybe Jid)
- iqErrorLangTag :: !(Maybe LangTag)
- iqErrorStanzaError :: !StanzaError
- iqErrorPayload :: !(Maybe Element)
- iqErrorAttributes :: ![ExtendedAttribute]
}
data IQRequest = IQRequest {
- iqRequestID :: !Text
- iqRequestFrom :: !(Maybe Jid)
- iqRequestTo :: !(Maybe Jid)
- iqRequestLangTag :: !(Maybe LangTag)
- iqRequestType :: !IQRequestType
- iqRequestPayload :: !Element
- iqRequestAttributes :: ![ExtendedAttribute]
}
data IQRequestType
- = Get
- | Set
data IQResponse
- = IQResponseError IQError
- | IQResponseResult IQResult
data IQResult = IQResult {
- iqResultID :: !Text
- iqResultFrom :: !(Maybe Jid)
- iqResultTo :: !(Maybe Jid)
- iqResultLangTag :: !(Maybe LangTag)
- iqResultPayload :: !(Maybe Element)
- iqResultAttributes :: ![ExtendedAttribute]
}
data LangTag = LangTag {
- primaryTag :: !Text
- subtags :: ![Text]
}
langTagQ :: QuasiQuoter
langTagFromText :: Text -> Maybe LangTag
langTagToText :: LangTag -> Text
parseLangTag :: String -> LangTag
type ExtendedAttribute = (Name, Text)
data Message = Message {
- messageID :: !(Maybe Text)
- messageFrom :: !(Maybe Jid)
- messageTo :: !(Maybe Jid)
- messageLangTag :: !(Maybe LangTag)
- messageType :: !MessageType
- messagePayload :: ![Element]
- messageAttributes :: ![ExtendedAttribute]
}
message :: Message
data MessageError = MessageError {
- messageErrorID :: !(Maybe Text)
- messageErrorFrom :: !(Maybe Jid)
- messageErrorTo :: !(Maybe Jid)
- messageErrorLangTag :: !(Maybe LangTag)
- messageErrorStanzaError :: !StanzaError
- messageErrorPayload :: ![Element]
- messageErrorAttributes :: ![ExtendedAttribute]
}
messageError :: MessageError
data MessageType
- = Chat
- | GroupChat
- | Headline
- | Normal
data Presence = Presence {
- presenceID :: !(Maybe Text)
- presenceFrom :: !(Maybe Jid)
- presenceTo :: !(Maybe Jid)
- presenceLangTag :: !(Maybe LangTag)
- presenceType :: !PresenceType
- presencePayload :: ![Element]
- presenceAttributes :: ![ExtendedAttribute]
}
presence :: Presence
data PresenceError = PresenceError {
- presenceErrorID :: !(Maybe Text)
- presenceErrorFrom :: !(Maybe Jid)
- presenceErrorTo :: !(Maybe Jid)
- presenceErrorLangTag :: !(Maybe LangTag)
- presenceErrorStanzaError :: !StanzaError
- presenceErrorPayload :: ![Element]
- presenceErrorAttributes :: ![ExtendedAttribute]
}
data PresenceType
- = Subscribe
- | Subscribed
- | Unsubscribe
- | Unsubscribed
- | Probe
- | Available
- | Unavailable
data SaslError
- = SaslAborted
- | SaslAccountDisabled
- | SaslCredentialsExpired
- | SaslEncryptionRequired
- | SaslIncorrectEncoding
- | SaslInvalidAuthzid
- | SaslInvalidMechanism
- | SaslMalformedRequest
- | SaslMechanismTooWeak
- | SaslNotAuthorized
- | SaslTemporaryAuthFailure
data SaslFailure = SaslFailure {
- saslFailureCondition :: SaslError
- saslFailureText :: Maybe (Maybe LangTag, Text)
}
data StreamFeatures = StreamFeatures {
- streamFeaturesTls :: !(Maybe Bool)
- streamFeaturesMechanisms :: ![Text]
- streamFeaturesRosterVer :: !(Maybe Bool)
- streamFeaturesPreApproval :: !Bool
- streamFeaturesSession :: !(Maybe Bool)
- streamFeaturesOther :: ![Element]
}
data Stanza
- = IQRequestS !IQRequest
- | IQResultS !IQResult
- | IQErrorS !IQError
- | MessageS !Message
- | MessageErrorS !MessageError
- | PresenceS !Presence
- | PresenceErrorS !PresenceError
data XmppElement
- = XmppStanza !Stanza
- | XmppNonza !Element
messageS :: Stanza
messageErrorS :: Stanza
presenceS :: Stanza
data StanzaError = StanzaError {
- stanzaErrorType :: StanzaErrorType
- stanzaErrorCondition :: StanzaErrorCondition
- stanzaErrorText :: Maybe (Maybe LangTag, NonemptyText)
- stanzaErrorApplicationSpecificCondition :: Maybe Element
}
data StanzaErrorCondition
- = BadRequest
- | Conflict
- | FeatureNotImplemented
- | Forbidden
- | Gone (Maybe NonemptyText)
- | InternalServerError
- | ItemNotFound
- | JidMalformed
- | NotAcceptable
- | NotAllowed
- | NotAuthorized
- | PolicyViolation
- | RecipientUnavailable
- | Redirect (Maybe NonemptyText)
- | RegistrationRequired
- | RemoteServerNotFound
- | RemoteServerTimeout
- | ResourceConstraint
- | ServiceUnavailable
- | SubscriptionRequired
- | UndefinedCondition
- | UnexpectedRequest
data StanzaErrorType
- = Cancel
- | Continue
- | Modify
- | Auth
- | Wait
data XmppFailure
- = StreamErrorFailure StreamErrorInfo
- | StreamEndFailure
- | StreamCloseError ([Element], XmppFailure)
- | TcpConnectionFailure
- | XmppIllegalTcpDetails
- | TlsError XmppTlsError
- | TlsNoServerSupport
- | XmppNoStream
- | XmppAuthFailure AuthFailure
- | TlsStreamSecured
- | XmppOtherFailure
- | XmppIOException IOException
- | XmppInvalidXml String
data XmppTlsError
- = XmppTlsError TLSError
- | XmppTlsException TLSException
data StreamErrorCondition
- = StreamBadFormat
- | StreamBadNamespacePrefix
- | StreamConflict
- | StreamConnectionTimeout
- | StreamHostGone
- | StreamHostUnknown
- | StreamImproperAddressing
- | StreamInternalServerError
- | StreamInvalidFrom
- | StreamInvalidNamespace
- | StreamInvalidXml
- | StreamNotAuthorized
- | StreamNotWellFormed
- | StreamPolicyViolation
- | StreamRemoteConnectionFailed
- | StreamReset
- | StreamResourceConstraint
- | StreamRestrictedXml
- | StreamSeeOtherHost
- | StreamSystemShutdown
- | StreamUndefinedCondition
- | StreamUnsupportedEncoding
- | StreamUnsupportedFeature
- | StreamUnsupportedStanzaType
- | StreamUnsupportedVersion
data Version = Version {
- majorVersion :: !Integer
- minorVersion :: !Integer
}
versionFromText :: Text -> Maybe Version
data StreamHandle = StreamHandle {
- streamSend :: ByteString -> IO (Either XmppFailure ())
- streamReceive :: Int -> IO (Either XmppFailure ByteString)
- streamFlush :: IO ()
- streamClose :: IO ()
}
newtype Stream = Stream {
- unStream :: TMVar StreamState
}
data StreamState = StreamState {
- streamConnectionState :: !ConnectionState
- streamHandle :: StreamHandle
- streamEventSource :: ConduitT () Event (ExceptT XmppFailure IO) ()
- streamFeatures :: !StreamFeatures
- streamAddress :: !(Maybe Text)
- streamFrom :: !(Maybe Jid)
- streamId :: !(Maybe Text)
- streamLang :: !(Maybe LangTag)
- streamJid :: !(Maybe Jid)
- streamConfiguration :: StreamConfiguration
}
data ConnectionState
- = Closed
- | Plain
- | Secured
- | Finished
data StreamErrorInfo = StreamErrorInfo {
- errorCondition :: !StreamErrorCondition
- errorText :: !(Maybe (Maybe LangTag, NonemptyText))
- errorXml :: !(Maybe Element)
}
data ConnectionDetails
- = UseRealm
- | UseSrv HostName
- | UseHost HostName PortNumber
- | UseConnection (ExceptT XmppFailure IO StreamHandle)
data StreamConfiguration = StreamConfiguration {
- preferredLang :: !(Maybe LangTag)
- toJid :: !(Maybe (Jid, Bool))
- connectionDetails :: ConnectionDetails
- resolvConf :: ResolvConf
- tlsBehaviour :: TlsBehaviour
- tlsParams :: ClientParams
}
xmppDefaultParams :: ClientParams
xmppDefaultParamsStrong :: ClientParams
data Jid = Jid {
- localpart_ :: !(Maybe NonemptyText)
- domainpart_ :: !NonemptyText
- resourcepart_ :: !(Maybe NonemptyText)
}
jidQ :: QuasiQuoter
jid :: QuasiQuoter
isBare :: Jid -> Bool
isFull :: Jid -> Bool
jidFromText :: Text -> Maybe Jid
jidFromTexts :: Maybe Text -> Text -> Maybe Text -> Maybe Jid
(<~) :: Jid -> Jid -> Bool
nodeprepProfile :: StringPrepProfile
resourceprepProfile :: StringPrepProfile
jidToText :: Jid -> Text
jidToTexts :: Jid -> (Maybe Text, Text, Maybe Text)
toBare :: Jid -> Jid
localpart :: Jid -> Maybe Text
domainpart :: Jid -> Text
resourcepart :: Jid -> Maybe Text
parseJid :: String -> Jid
data TlsBehaviour
- = RequireTls
- | PreferTls
- | PreferPlain
- | RefuseTls
data AuthFailure
- = AuthNoAcceptableMechanism [Text]
- | AuthStreamFailure XmppFailure
- | AuthSaslFailure SaslFailure
- | AuthIllegalCredentials
- | AuthOtherFailure
openElementToEvents :: Element -> [Event]
renderOpenElement :: Element -> ByteString
renderElement :: Element -> ByteString
checkHostName :: Text -> Maybe Text
withTMVar :: TMVar a -> (a -> IO (c, a)) -> IO c

Documentation

withConnection :: (Stream -> IO (b, Stream)) -> Session -> IO (Either XmppFailure b) Source #

Run an XmppConMonad action in isolation. Reader and writer workers will be temporarily stopped and resumed with the new session details once the action returns. The action will run in the calling thread. Any uncaught exceptions will be interpreted as connection failure. withConnection :: XmppConMonad a -> Context -> IO (Either StreamError a)

modifyHandlers :: (EventHandlers -> EventHandlers) -> Session -> IO () Source #

Executes a function to update the event handlers.

setConnectionClosedHandler :: (XmppFailure -> Session -> IO ()) -> Session -> IO () Source #

Changes the handler to be executed when the server connection is closed. To avoid race conditions the initial value should be set in the configuration when creating the session

runConnectionClosedHandler :: Session -> XmppFailure -> IO () Source #

runHandler :: (EventHandlers -> IO a) -> Session -> IO a Source #

Run an event handler.

endSession :: Session -> IO () Source #

End the current XMPP session. Kills the associated threads and closes the connection.

Note that XMPP clients (that have signalled availability) should send "Unavailable" presence prior to disconnecting.

The connectionClosedHandler will not be called (to avoid possibly reestablishing the connection).

closeConnection :: Session -> IO () Source #

Close the connection to the server. Closes the stream (by enforcing a write lock and sending a </stream:stream> element), waits (blocks) for three seconds, and then closes the connection.

readWorker :: (XmppElement -> IO ()) -> (XmppFailure -> IO ()) -> TMVar Stream -> IO a Source #

startThreadsWith :: TMVar (ByteString -> IO (Either XmppFailure ())) -> (XmppElement -> IO ()) -> TMVar EventHandlers -> Stream -> Maybe Int -> IO (Either XmppFailure (IO (), TMVar Stream, ThreadId)) Source #

Runs thread in XmppState monad. Returns channel of incoming and outgoing stances, respectively, and an Action to stop the Threads and close the connection.

connPersist :: Maybe Int -> TMVar (ByteString -> IO a) -> IO () Source #

Sends a blank space every delay seconds to keep the connection alive.

semWrite :: WriteSemaphore -> ByteString -> IO (Either XmppFailure ()) Source #

writeXmppElem :: WriteSemaphore -> XmppElement -> IO (Either XmppFailure ()) Source #

writeStanza :: WriteSemaphore -> Stanza -> IO (Either XmppFailure ()) Source #

sendRawStanza :: Stanza -> Session -> IO (Either XmppFailure ()) Source #

Send a stanza to the server without running plugins. (The stanza is sent as is)

sendStanza :: Stanza -> Session -> IO (Either XmppFailure ()) Source #

Send a stanza to the server, managed by plugins

getStanzaChan :: Session -> TChan (Stanza, [Annotation]) Source #

Get the channel of incoming stanzas.

getStanza :: Session -> IO (Stanza, [Annotation]) Source #

Get the next incoming stanza

dupSession :: Session -> IO Session Source #

Duplicate the inbound channel of the session object. Most receiving functions discard stanzas they are not interested in from the inbound channel. Duplicating the channel ensures that those stanzas can aren't lost and can still be handled somewhere else.

getJid :: Session -> IO (Maybe Jid) Source #

Return the JID assigned to us by the server

getFeatures :: Session -> IO StreamFeatures Source #

Return the stream features the server announced

waitForStream :: Session -> IO () Source #

Wait until the connection of the stream is re-established

streamState :: Session -> STM ConnectionState Source #

type StanzaHandler Source #

Arguments

= (XmppElement -> IO (Either XmppFailure ()))	outgoing stanza
-> XmppElement	stanza to handle
-> [Annotation]	annotations added by previous handlers
-> IO [(XmppElement, [Annotation])]	modified stanzas and additional annotations

type Resource = Text Source #

type AuthData = Maybe (ConnectionState -> [SaslHandler], Maybe Resource) Source #

SASL handlers and the desired JID resource

Nothing to disable authentication

The allowed SASL mecahnism can depend on the connection state. For example, plain should be avoided unless the connection state is Secured

It is recommended to leave the resource up to the server

data Annotation Source #

Annotations are auxiliary data attached to received stanzas by Plugins to convey information regarding their operation. For example, a plugin for encryption might attach information about whether a received stanza was encrypted and which algorithm was used.

Constructors

forall f.(Typeable f, Show f) => Annotation
Fields fromAnnotation :: f

Instances

Instances details

Show Annotation Source #
Instance details Defined in Network.Xmpp.Concurrent.Types Methods showsPrec :: Int -> Annotation -> ShowS # show :: Annotation -> String # showList :: [Annotation] -> ShowS #

type Annotated a = (a, [Annotation]) Source #

getAnnotation :: Typeable b => Annotated a -> Maybe b Source #

Retrieve the first matching annotation

data Plugin' Source #

Constructors

Plugin'
Fields inHandler :: XmppElement -> [Annotation] -> IO [(XmppElement, [Annotation])] Resulting stanzas and additional Annotations outHandler :: XmppElement -> IO (Either XmppFailure ()) onSessionUp :: Session -> IO () In order to allow plugins to tie the knot (Plugin / Session) we pass the plugin the completed Session once it exists

type Plugin Source #

Arguments

= (XmppElement -> IO (Either XmppFailure ()))	pass stanza to next plugin
-> ExceptT XmppFailure IO Plugin'

type RosterPushCallback = Roster -> RosterUpdate -> IO () Source #

data SessionConfiguration Source #

Configuration for the Session object.

Constructors

SessionConfiguration

Fields

sessionStreamConfiguration :: StreamConfiguration
Configuration for the Stream object.
onConnectionClosed :: Session -> XmppFailure -> IO ()
Handler to be run when the conection to the XMPP server is closed. See also reconnect and 'reconnect'' for easy reconnection. The default does nothing
sessionStanzaIDs :: IO (IO Text)
Function to generate new stanza identifiers.
plugins :: [Plugin]
Plugins can modify incoming and outgoing stanzas, for example to en- and decrypt them, respectively
enableRoster :: Bool
Enable roster handling according to rfc 6121. See getRoster to acquire the current roster
initialRoster :: IO (Maybe Roster)
Initial Roster to user when versioned rosters are supported
onRosterPush :: Maybe RosterPushCallback
Callback called on a roster Push. The callback is called after the roster is updated
enablePresenceTracking :: Bool
Track incomming presence stancas.
onPresenceChange :: Maybe (Jid -> PeerStatus -> PeerStatus -> IO ())
Callback that is invoked when the presence status of a peer changes, i.e. it comes online, goes offline or its IM presence changes. The arguments are the (full) JID of the peer, the old state and the new state. The function is called in a new thread to avoid blocking handling stanzas
keepAlive :: Maybe Int
How often to send keep-alives Nothing disables keep-alive

Instances

Instances details

Default SessionConfiguration Source #
Instance details Defined in Network.Xmpp.Concurrent.Types Methods def :: SessionConfiguration #

data EventHandlers Source #

Handlers to be run when the Xmpp session ends and when the Xmpp connection is closed.

Constructors

EventHandlers
Fields connectionClosedHandler :: XmppFailure -> IO ()

data Interrupt Source #

Interrupt is used to signal to the reader thread that it should stop. Th contained semphore signals the reader to resume it's work.

Constructors

Interrupt (TMVar ())

Instances

Instances details

Exception Interrupt Source #
Instance details Defined in Network.Xmpp.Concurrent.Types Methods toException :: Interrupt -> SomeException # fromException :: SomeException -> Maybe Interrupt # displayException :: Interrupt -> String #
Show Interrupt Source #
Instance details Defined in Network.Xmpp.Concurrent.Types Methods showsPrec :: Int -> Interrupt -> ShowS # show :: Interrupt -> String # showList :: [Interrupt] -> ShowS #

type WriteSemaphore = TMVar (ByteString -> IO (Either XmppFailure ())) Source #

data Session Source #

The Session object represents a single session with an XMPP server. You can use session to establish a session

Constructors

Session

Fields

stanzaCh :: TChan (Stanza, [Annotation])
iqHandlers :: TVar IQHandlers
writeSemaphore :: WriteSemaphore
readerThread :: ThreadId
idGenerator :: IO Text
streamRef :: TMVar Stream
Lock (used by withStream) to make sure that a maximum of one Stream action is executed at any given time.
eventHandlers :: TMVar EventHandlers
stopThreads :: IO ()
rosterRef :: TVar Roster
presenceRef :: TVar Peers
conf :: SessionConfiguration
sendStanza' :: Stanza -> IO (Either XmppFailure ())
sRealm :: HostName
sSaslCredentials :: Maybe (ConnectionState -> [SaslHandler], Maybe Text)
reconnectWait :: TVar Int

type IQHandlers = (Map (IQRequestType, Text) (TChan IQRequestTicket), Map Text (Either (Maybe Jid) Jid, TMVar (Maybe (Annotated IQResponse)))) Source #

IQHandlers holds the registered channels for incoming IQ requests and TMVars of and TMVars for expected IQ responses (the second Text represent a stanza identifier.

data IQRequestTicket Source #

A received and wrapped up IQ request. Prevents you from (illegally) answering a single IQ request multiple times

Constructors

IQRequestTicket
Fields answerTicket :: Either StanzaError (Maybe Element) -> [ExtendedAttribute] -> IO (Maybe (Either XmppFailure ())) Send an answer to an IQ request once. Subsequent calls will do nothing and return Nothing iqRequestBody :: IQRequest The actual IQ request that created this ticket. iqRequestAnnotations :: [Annotation] Annotations set by plugins in receive

data IQSendError Source #

Error that can occur during sendIQ'

Constructors

IQSendError XmppFailure
IQTimeOut

Instances

Instances details

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

pullMessageA :: Session -> IO (Either (Annotated MessageError) (Annotated Message)) Source #

Draw and discard stanzas from the inbound channel until a message or message error is found. Returns the message or message error with annotations.

pullMessage :: Session -> IO (Either MessageError Message) Source #

Draw and discard stanzas from the inbound channel until a message or message error is found. Returns the message or message error.

getMessageA :: Session -> IO (Annotated Message) Source #

Draw and discard stanzas from the inbound channel until a message is found. Returns the message with annotations.

getMessage :: Session -> IO Message Source #

Draw and discard stanzas from the inbound channel until a message is found. Returns the message.

waitForMessageA :: (Annotated Message -> Bool) -> Session -> IO (Annotated Message) Source #

Draw and discard stanzas from the inbound channel until a message matching the given predicate is found. Returns the matching message with annotations.

waitForMessage :: (Message -> Bool) -> Session -> IO Message Source #

Draw and discard stanzas from the inbound channel until a message matching the given predicate is found. Returns the matching message.

waitForMessageErrorA :: (Annotated MessageError -> Bool) -> Session -> IO (Annotated MessageError) Source #

Draw and discard stanzas from the inbound channel until a message error matching the given predicate is found. Returns the matching message error with annotations.

waitForMessageError :: (MessageError -> Bool) -> Session -> IO MessageError Source #

Draw and discard stanzas from the inbound channel until a message error matching the given predicate is found. Returns the matching message error

filterMessagesA :: (Annotated MessageError -> Bool) -> (Annotated Message -> Bool) -> Session -> IO (Either (Annotated MessageError) (Annotated Message)) Source #

Draw and discard stanzas from the inbound channel until a message or message error matching the given respective predicate is found. Returns the matching message or message error with annotations

filterMessages :: (MessageError -> Bool) -> (Message -> Bool) -> Session -> IO (Either MessageError Message) Source #

Draw and discard stanzas from the inbound channel until a message or message error matching the given respective predicate is found. Returns the matching message or message error.

sendMessage :: Message -> Session -> IO (Either XmppFailure ()) Source #

Send a message stanza. Returns Left when the Message could not be sent.

pullPresenceA :: Session -> IO (Either (Annotated PresenceError) (Annotated Presence)) Source #

Read a presence stanza from the inbound stanza channel, discards any other stanzas. Returns the presence stanza with annotations.

pullPresence :: Session -> IO (Either PresenceError Presence) Source #

Read a presence stanza from the inbound stanza channel, discards any other stanzas. Returns the presence stanza.

waitForPresenceA :: (Annotated Presence -> Bool) -> Session -> IO (Annotated Presence) Source #

Draw and discard stanzas from the inbound channel until a presence stanza matching the given predicate is found. Return the presence stanza with annotations.

waitForPresence :: (Presence -> Bool) -> Session -> IO Presence Source #

Draw and discard stanzas from the inbound channel until a presence stanza matching the given predicate is found. Return the presence stanza with annotations.

sendPresence :: Presence -> Session -> IO (Either XmppFailure ()) Source #

Send a presence stanza.

sendIQ Source #

Arguments

:: Maybe Integer	Timeout . When the timeout is reached the response TMVar will be filled with `IQResponseTimeout` and the id is removed from the list of IQ handlers. `Nothing` deactivates the timeout
-> Maybe Jid	Recipient (to)
-> IQRequestType	IQ type (`Get` or `Set`)
-> Maybe LangTag	Language tag of the payload (`Nothing` for default)
-> Element	The IQ body (there has to be exactly one)
-> [ExtendedAttribute]	Additional stanza attributes
-> Session
-> IO (Either XmppFailure (STM (Maybe (Annotated IQResponse))))

Sends an IQ, returns an STM action that returns the first inbound IQ with a matching ID that has type result or error or Nothing if the timeout was reached.

When sending the action fails, an XmppFailure is returned.

sendIQA' :: Maybe Integer -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> [ExtendedAttribute] -> Session -> IO (Either IQSendError (Annotated IQResponse)) Source #

Like sendIQ, but waits for the answer IQ.

sendIQ' :: Maybe Integer -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> [ExtendedAttribute] -> Session -> IO (Either IQSendError IQResponse) Source #

Like sendIQ, but waits for the answer IQ. Discards plugin Annotations

listenIQ Source #

Arguments

:: IQRequestType	Type of IQs to receive (`Get` or `Set`)
-> Text	Namespace of the child element
-> Session
-> IO (Either (STM IQRequestTicket) (STM IQRequestTicket))

Register your interest in inbound IQ stanzas of a specific type and namespace. The returned STM action yields the received, matching IQ stanzas.

If a handler for IQ stanzas with the given type and namespace is already registered, the producer will be wrapped in Left. In this case the returned request tickets may already be processed elsewhere.

unlistenIQ Source #

Arguments

:: IQRequestType	Type of IQ (`Get` or `Set`)
-> Text	Namespace of the child element
-> Session
-> IO ()

Unregister a previously registered IQ handler. No more IQ stanzas will be delivered to any of the returned producers.

answerIQ :: IQRequestTicket -> Either StanzaError (Maybe Element) -> [ExtendedAttribute] -> IO (Maybe (Either XmppFailure ())) Source #

Answer an IQ request. Only the first answer ist sent and Just True is returned when the answer is sucessfully sent. If an error occured during sending Just False is returned (and another attempt can be undertaken). Subsequent answers after the first sucessful one are dropped and (False is returned in that case)

class IQRequestClass a where Source #

Associated Types

data IQResponseType a Source #

Methods

pickleRequest :: PU Element a Source #

pickleResponse :: PU [Element] (IQResponseType a) Source #

requestType :: a -> IQRequestType Source #

requestNamespace :: a -> Text Source #

data IQRequestError Source #

Constructors

IQRequestSendError XmppFailure
IQRequestTimeout
IQRequestUnpickleError UnpickleError

Instances

Instances details

Show IQRequestError Source #
Instance details Defined in Network.Xmpp.Concurrent.IQ Methods showsPrec :: Int -> IQRequestError -> ShowS # show :: IQRequestError -> String # showList :: [IQRequestError] -> ShowS #

sendIQRequest :: (IQRequestClass a, MonadError IQRequestError m, MonadIO m) => Maybe Integer -> Maybe Jid -> a -> Session -> m (Either IQError (IQResponseType a)) Source #

Send an IQ request. May throw IQSendError, UnpickleError,

type IQRequestHandler a = a -> IO (Either StanzaError (IQResponseType a)) Source #

runIQHandler :: IQRequestClass a => IQRequestHandler a -> Session -> IO () Source #

newSession :: Stream -> SessionConfiguration -> HostName -> Maybe (ConnectionState -> [SaslHandler], Maybe Text) -> IO (Either XmppFailure Session) Source #

Creates and initializes a new Xmpp context.

session Source #

Arguments

:: HostName	The hostname / realm
-> AuthData
-> SessionConfiguration	configuration details
-> IO (Either XmppFailure Session)

Creates a Session object by setting up a connection with an XMPP server.

Will connect to the specified host with the provided configuration. If the third parameter is a Just value, session will attempt to authenticate and acquire an XMPP resource.

newStanzaID :: Session -> IO Text Source #

Generates a new stanza identifier based on the sessionStanzaIDs field of SessionConfiguration.

reconnect Source #

Arguments

:: Integer	Maximum number of retries (numbers of 1 or less will perform exactly one retry)
-> Session	Session to reconnect
-> IO (Bool, [XmppFailure])	Whether or not the reconnect attempt was successful, and a list of failure modes encountered

Reconnect with the stored settings.

Waits a random amount of seconds (between 0 and 60 inclusive) before the first attempt and an increasing amount after each attempt after that. Caps out at 2-5 minutes.

This function does not set your presence to online, so you will have to do this yourself.

reconnect' Source #

Arguments

:: Session	Session to reconnect
-> IO Integer	Number of failed retries before connection could be established

Reconnect with the stored settings with an unlimited number of retries.

Waits a random amount of seconds (between 0 and 60 inclusive) before the first attempt and an increasing amount after each attempt after that. Caps out at 2-5 minutes.

This function does not set your presence to online, so you will have to do this yourself.

reconnectNow Source #

Arguments

:: Session	session to reconnect
-> IO (Maybe XmppFailure)

Reconnect immediately with the stored settings. Returns Just the error when the reconnect attempt fails and Nothing when no failure was encountered.

This function does not set your presence to online, so you will have to do this yourself.

simpleAuth :: Username -> Password -> AuthData Source #

Authenticate using, in order of preference, scramSha1, digestMd5 and finally, if both of those are not support and the stream is Secured with TLS, try plain

The resource will be decided by the server

semWrite :: WriteSemaphore -> ByteString -> IO (Either XmppFailure ()) Source #

writeXmppElem :: WriteSemaphore -> XmppElement -> IO (Either XmppFailure ()) Source #

writeStanza :: WriteSemaphore -> Stanza -> IO (Either XmppFailure ()) Source #

sendRawStanza :: Stanza -> Session -> IO (Either XmppFailure ()) Source #

Send a stanza to the server without running plugins. (The stanza is sent as is)

sendStanza :: Stanza -> Session -> IO (Either XmppFailure ()) Source #

Send a stanza to the server, managed by plugins

getStanzaChan :: Session -> TChan (Stanza, [Annotation]) Source #

Get the channel of incoming stanzas.

getStanza :: Session -> IO (Stanza, [Annotation]) Source #

Get the next incoming stanza

dupSession :: Session -> IO Session Source #

Duplicate the inbound channel of the session object. Most receiving functions discard stanzas they are not interested in from the inbound channel. Duplicating the channel ensures that those stanzas can aren't lost and can still be handled somewhere else.

getJid :: Session -> IO (Maybe Jid) Source #

Return the JID assigned to us by the server

getFeatures :: Session -> IO StreamFeatures Source #

Return the stream features the server announced

waitForStream :: Session -> IO () Source #

Wait until the connection of the stream is re-established

streamState :: Session -> STM ConnectionState Source #

sendIQ Source #

Arguments

:: Maybe Integer	Timeout . When the timeout is reached the response TMVar will be filled with `IQResponseTimeout` and the id is removed from the list of IQ handlers. `Nothing` deactivates the timeout
-> Maybe Jid	Recipient (to)
-> IQRequestType	IQ type (`Get` or `Set`)
-> Maybe LangTag	Language tag of the payload (`Nothing` for default)
-> Element	The IQ body (there has to be exactly one)
-> [ExtendedAttribute]	Additional stanza attributes
-> Session
-> IO (Either XmppFailure (STM (Maybe (Annotated IQResponse))))

Sends an IQ, returns an STM action that returns the first inbound IQ with a matching ID that has type result or error or Nothing if the timeout was reached.

When sending the action fails, an XmppFailure is returned.

sendIQA' :: Maybe Integer -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> [ExtendedAttribute] -> Session -> IO (Either IQSendError (Annotated IQResponse)) Source #

Like sendIQ, but waits for the answer IQ.

sendIQ' :: Maybe Integer -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> [ExtendedAttribute] -> Session -> IO (Either IQSendError IQResponse) Source #

Like sendIQ, but waits for the answer IQ. Discards plugin Annotations

listenIQ Source #

Arguments

:: IQRequestType	Type of IQs to receive (`Get` or `Set`)
-> Text	Namespace of the child element
-> Session
-> IO (Either (STM IQRequestTicket) (STM IQRequestTicket))

Register your interest in inbound IQ stanzas of a specific type and namespace. The returned STM action yields the received, matching IQ stanzas.

If a handler for IQ stanzas with the given type and namespace is already registered, the producer will be wrapped in Left. In this case the returned request tickets may already be processed elsewhere.

unlistenIQ Source #

Arguments

:: IQRequestType	Type of IQ (`Get` or `Set`)
-> Text	Namespace of the child element
-> Session
-> IO ()

Unregister a previously registered IQ handler. No more IQ stanzas will be delivered to any of the returned producers.

answerIQ :: IQRequestTicket -> Either StanzaError (Maybe Element) -> [ExtendedAttribute] -> IO (Maybe (Either XmppFailure ())) Source #

Answer an IQ request. Only the first answer ist sent and Just True is returned when the answer is sucessfully sent. If an error occured during sending Just False is returned (and another attempt can be undertaken). Subsequent answers after the first sucessful one are dropped and (False is returned in that case)

class IQRequestClass a where Source #

Associated Types

data IQResponseType a Source #

Methods

pickleRequest :: PU Element a Source #

pickleResponse :: PU [Element] (IQResponseType a) Source #

requestType :: a -> IQRequestType Source #

requestNamespace :: a -> Text Source #

data IQRequestError Source #

Constructors

IQRequestSendError XmppFailure
IQRequestTimeout
IQRequestUnpickleError UnpickleError

Instances

Instances details

Show IQRequestError Source #
Instance details Defined in Network.Xmpp.Concurrent.IQ Methods showsPrec :: Int -> IQRequestError -> ShowS # show :: IQRequestError -> String # showList :: [IQRequestError] -> ShowS #

sendIQRequest :: (IQRequestClass a, MonadError IQRequestError m, MonadIO m) => Maybe Integer -> Maybe Jid -> a -> Session -> m (Either IQError (IQResponseType a)) Source #

Send an IQ request. May throw IQSendError, UnpickleError,

type IQRequestHandler a = a -> IO (Either StanzaError (IQResponseType a)) Source #

runIQHandler :: IQRequestClass a => IQRequestHandler a -> Session -> IO () Source #

pullMessageA :: Session -> IO (Either (Annotated MessageError) (Annotated Message)) Source #

Draw and discard stanzas from the inbound channel until a message or message error is found. Returns the message or message error with annotations.

pullMessage :: Session -> IO (Either MessageError Message) Source #

Draw and discard stanzas from the inbound channel until a message or message error is found. Returns the message or message error.

getMessageA :: Session -> IO (Annotated Message) Source #

Draw and discard stanzas from the inbound channel until a message is found. Returns the message with annotations.

getMessage :: Session -> IO Message Source #

Draw and discard stanzas from the inbound channel until a message is found. Returns the message.

waitForMessageA :: (Annotated Message -> Bool) -> Session -> IO (Annotated Message) Source #

Draw and discard stanzas from the inbound channel until a message matching the given predicate is found. Returns the matching message with annotations.

waitForMessage :: (Message -> Bool) -> Session -> IO Message Source #

Draw and discard stanzas from the inbound channel until a message matching the given predicate is found. Returns the matching message.

waitForMessageErrorA :: (Annotated MessageError -> Bool) -> Session -> IO (Annotated MessageError) Source #

Draw and discard stanzas from the inbound channel until a message error matching the given predicate is found. Returns the matching message error with annotations.

waitForMessageError :: (MessageError -> Bool) -> Session -> IO MessageError Source #

Draw and discard stanzas from the inbound channel until a message error matching the given predicate is found. Returns the matching message error

filterMessagesA :: (Annotated MessageError -> Bool) -> (Annotated Message -> Bool) -> Session -> IO (Either (Annotated MessageError) (Annotated Message)) Source #

Draw and discard stanzas from the inbound channel until a message or message error matching the given respective predicate is found. Returns the matching message or message error with annotations

filterMessages :: (MessageError -> Bool) -> (Message -> Bool) -> Session -> IO (Either MessageError Message) Source #

Draw and discard stanzas from the inbound channel until a message or message error matching the given respective predicate is found. Returns the matching message or message error.

sendMessage :: Message -> Session -> IO (Either XmppFailure ()) Source #

Send a message stanza. Returns Left when the Message could not be sent.

withConnection :: (Stream -> IO (b, Stream)) -> Session -> IO (Either XmppFailure b) Source #

Run an XmppConMonad action in isolation. Reader and writer workers will be temporarily stopped and resumed with the new session details once the action returns. The action will run in the calling thread. Any uncaught exceptions will be interpreted as connection failure. withConnection :: XmppConMonad a -> Context -> IO (Either StreamError a)

modifyHandlers :: (EventHandlers -> EventHandlers) -> Session -> IO () Source #

Executes a function to update the event handlers.

setConnectionClosedHandler :: (XmppFailure -> Session -> IO ()) -> Session -> IO () Source #

Changes the handler to be executed when the server connection is closed. To avoid race conditions the initial value should be set in the configuration when creating the session

runConnectionClosedHandler :: Session -> XmppFailure -> IO () Source #

runHandler :: (EventHandlers -> IO a) -> Session -> IO a Source #

Run an event handler.

endSession :: Session -> IO () Source #

End the current XMPP session. Kills the associated threads and closes the connection.

Note that XMPP clients (that have signalled availability) should send "Unavailable" presence prior to disconnecting.

The connectionClosedHandler will not be called (to avoid possibly reestablishing the connection).

closeConnection :: Session -> IO () Source #

Close the connection to the server. Closes the stream (by enforcing a write lock and sending a </stream:stream> element), waits (blocks) for three seconds, and then closes the connection.

pullPresenceA :: Session -> IO (Either (Annotated PresenceError) (Annotated Presence)) Source #

Read a presence stanza from the inbound stanza channel, discards any other stanzas. Returns the presence stanza with annotations.

pullPresence :: Session -> IO (Either PresenceError Presence) Source #

Read a presence stanza from the inbound stanza channel, discards any other stanzas. Returns the presence stanza.

waitForPresenceA :: (Annotated Presence -> Bool) -> Session -> IO (Annotated Presence) Source #

Draw and discard stanzas from the inbound channel until a presence stanza matching the given predicate is found. Return the presence stanza with annotations.

waitForPresence :: (Presence -> Bool) -> Session -> IO Presence Source #

Draw and discard stanzas from the inbound channel until a presence stanza matching the given predicate is found. Return the presence stanza with annotations.

sendPresence :: Presence -> Session -> IO (Either XmppFailure ()) Source #

Send a presence stanza.

readWorker :: (XmppElement -> IO ()) -> (XmppFailure -> IO ()) -> TMVar Stream -> IO a Source #

startThreadsWith :: TMVar (ByteString -> IO (Either XmppFailure ())) -> (XmppElement -> IO ()) -> TMVar EventHandlers -> Stream -> Maybe Int -> IO (Either XmppFailure (IO (), TMVar Stream, ThreadId)) Source #

Runs thread in XmppState monad. Returns channel of incoming and outgoing stances, respectively, and an Action to stop the Threads and close the connection.

connPersist :: Maybe Int -> TMVar (ByteString -> IO a) -> IO () Source #

Sends a blank space every delay seconds to keep the connection alive.

type StanzaHandler Source #

Arguments

= (XmppElement -> IO (Either XmppFailure ()))	outgoing stanza
-> XmppElement	stanza to handle
-> [Annotation]	annotations added by previous handlers
-> IO [(XmppElement, [Annotation])]	modified stanzas and additional annotations

type Resource = Text Source #

type AuthData = Maybe (ConnectionState -> [SaslHandler], Maybe Resource) Source #

SASL handlers and the desired JID resource

Nothing to disable authentication

The allowed SASL mecahnism can depend on the connection state. For example, plain should be avoided unless the connection state is Secured

It is recommended to leave the resource up to the server

data Annotation Source #

Annotations are auxiliary data attached to received stanzas by Plugins to convey information regarding their operation. For example, a plugin for encryption might attach information about whether a received stanza was encrypted and which algorithm was used.

Constructors

forall f.(Typeable f, Show f) => Annotation
Fields fromAnnotation :: f

Instances

Instances details

Show Annotation Source #
Instance details Defined in Network.Xmpp.Concurrent.Types Methods showsPrec :: Int -> Annotation -> ShowS # show :: Annotation -> String # showList :: [Annotation] -> ShowS #

type Annotated a = (a, [Annotation]) Source #

getAnnotation :: Typeable b => Annotated a -> Maybe b Source #

Retrieve the first matching annotation

data Plugin' Source #

Constructors

Plugin'
Fields inHandler :: XmppElement -> [Annotation] -> IO [(XmppElement, [Annotation])] Resulting stanzas and additional Annotations outHandler :: XmppElement -> IO (Either XmppFailure ()) onSessionUp :: Session -> IO () In order to allow plugins to tie the knot (Plugin / Session) we pass the plugin the completed Session once it exists

type Plugin Source #

Arguments

= (XmppElement -> IO (Either XmppFailure ()))	pass stanza to next plugin
-> ExceptT XmppFailure IO Plugin'

type RosterPushCallback = Roster -> RosterUpdate -> IO () Source #

data SessionConfiguration Source #

Configuration for the Session object.

Constructors

SessionConfiguration

Fields

sessionStreamConfiguration :: StreamConfiguration
Configuration for the Stream object.
onConnectionClosed :: Session -> XmppFailure -> IO ()
Handler to be run when the conection to the XMPP server is closed. See also reconnect and 'reconnect'' for easy reconnection. The default does nothing
sessionStanzaIDs :: IO (IO Text)
Function to generate new stanza identifiers.
plugins :: [Plugin]
Plugins can modify incoming and outgoing stanzas, for example to en- and decrypt them, respectively
enableRoster :: Bool
Enable roster handling according to rfc 6121. See getRoster to acquire the current roster
initialRoster :: IO (Maybe Roster)
Initial Roster to user when versioned rosters are supported
onRosterPush :: Maybe RosterPushCallback
Callback called on a roster Push. The callback is called after the roster is updated
enablePresenceTracking :: Bool
Track incomming presence stancas.
onPresenceChange :: Maybe (Jid -> PeerStatus -> PeerStatus -> IO ())
Callback that is invoked when the presence status of a peer changes, i.e. it comes online, goes offline or its IM presence changes. The arguments are the (full) JID of the peer, the old state and the new state. The function is called in a new thread to avoid blocking handling stanzas
keepAlive :: Maybe Int
How often to send keep-alives Nothing disables keep-alive

Instances

Instances details

Default SessionConfiguration Source #
Instance details Defined in Network.Xmpp.Concurrent.Types Methods def :: SessionConfiguration #

data EventHandlers Source #

Handlers to be run when the Xmpp session ends and when the Xmpp connection is closed.

Constructors

EventHandlers
Fields connectionClosedHandler :: XmppFailure -> IO ()

data Interrupt Source #

Interrupt is used to signal to the reader thread that it should stop. Th contained semphore signals the reader to resume it's work.

Constructors

Interrupt (TMVar ())

Instances

Instances details

Exception Interrupt Source #
Instance details Defined in Network.Xmpp.Concurrent.Types Methods toException :: Interrupt -> SomeException # fromException :: SomeException -> Maybe Interrupt # displayException :: Interrupt -> String #
Show Interrupt Source #
Instance details Defined in Network.Xmpp.Concurrent.Types Methods showsPrec :: Int -> Interrupt -> ShowS # show :: Interrupt -> String # showList :: [Interrupt] -> ShowS #

type WriteSemaphore = TMVar (ByteString -> IO (Either XmppFailure ())) Source #

data Session Source #

The Session object represents a single session with an XMPP server. You can use session to establish a session

Constructors

Session

Fields

stanzaCh :: TChan (Stanza, [Annotation])
iqHandlers :: TVar IQHandlers
writeSemaphore :: WriteSemaphore
readerThread :: ThreadId
idGenerator :: IO Text
streamRef :: TMVar Stream
Lock (used by withStream) to make sure that a maximum of one Stream action is executed at any given time.
eventHandlers :: TMVar EventHandlers
stopThreads :: IO ()
rosterRef :: TVar Roster
presenceRef :: TVar Peers
conf :: SessionConfiguration
sendStanza' :: Stanza -> IO (Either XmppFailure ())
sRealm :: HostName
sSaslCredentials :: Maybe (ConnectionState -> [SaslHandler], Maybe Text)
reconnectWait :: TVar Int

type IQHandlers = (Map (IQRequestType, Text) (TChan IQRequestTicket), Map Text (Either (Maybe Jid) Jid, TMVar (Maybe (Annotated IQResponse)))) Source #

IQHandlers holds the registered channels for incoming IQ requests and TMVars of and TMVars for expected IQ responses (the second Text represent a stanza identifier.

data IQRequestTicket Source #

A received and wrapped up IQ request. Prevents you from (illegally) answering a single IQ request multiple times

Constructors

IQRequestTicket
Fields answerTicket :: Either StanzaError (Maybe Element) -> [ExtendedAttribute] -> IO (Maybe (Either XmppFailure ())) Send an answer to an IQ request once. Subsequent calls will do nothing and return Nothing iqRequestBody :: IQRequest The actual IQ request that created this ticket. iqRequestAnnotations :: [Annotation] Annotations set by plugins in receive

data IQSendError Source #

Error that can occur during sendIQ'

Constructors

IQSendError XmppFailure
IQTimeOut

Instances

Instances details

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

data MessageBody Source #

Constructors

MessageBody
Fields bodyLang :: Maybe LangTag bodyContent :: Text

data MessageThread Source #

Constructors

MessageThread
Fields threadID :: Text threadParent :: Maybe Text

data MessageSubject Source #

Constructors

MessageSubject
Fields subjectLang :: Maybe LangTag subjectContent :: Text

data InstantMessage Source #

The instant message (IM) specific part of a message.

Constructors

InstantMessage
Fields imThread :: Maybe MessageThread imSubject :: [MessageSubject] imBody :: [MessageBody]

Instances

Instances details

Default InstantMessage Source #
Instance details Defined in Network.Xmpp.IM.Message Methods def :: InstantMessage #

instantMessage :: InstantMessage Source #

Empty instant message.

getIM :: Message -> Maybe InstantMessage Source #

Get the IM specific parts of a message. Returns Nothing when the received payload is not valid IM data.

sanitizeIM :: InstantMessage -> InstantMessage Source #

withIM :: Message -> InstantMessage -> Message Source #

Append IM data to a message. Additional IM bodies with the same Langtag are discarded.

imToElements :: InstantMessage -> [Element] Source #

simpleIM Source #

Arguments

:: Jid	recipient
-> Text	body
-> Message

Generate a simple message

answerIM :: [MessageBody] -> Message -> Maybe Message Source #

Generate an answer from a received message. The recepient is taken from the original sender, the sender is set to Nothing, message ID, language tag, message type as well as subject and thread are inherited.

Additional IM bodies with the same Langtag are discarded.

xpIM :: PU [Element] InstantMessage Source #

xpMessageSubject :: PU [Element] [MessageSubject] Source #

xpMessageBody :: PU [Element] [MessageBody] Source #

xpMessageThread :: PU [Element] (Maybe MessageThread) Source #

data ShowStatus Source #

Constructors

StatusAway
StatusChat
StatusDnd
StatusXa

Instances

Instances details

Read ShowStatus Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods readsPrec :: Int -> ReadS ShowStatus # readList :: ReadS [ShowStatus] # readPrec :: ReadPrec ShowStatus # readListPrec :: ReadPrec [ShowStatus] #
Show ShowStatus Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods showsPrec :: Int -> ShowStatus -> ShowS # show :: ShowStatus -> String # showList :: [ShowStatus] -> ShowS #
Eq ShowStatus Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods (==) :: ShowStatus -> ShowStatus -> Bool # (/=) :: ShowStatus -> ShowStatus -> Bool #

data IMPresence Source #

Constructors

IMP
Fields showStatus :: Maybe ShowStatus status :: Maybe Text priority :: Maybe Int

Instances

Instances details

Show IMPresence Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods showsPrec :: Int -> IMPresence -> ShowS # show :: IMPresence -> String # showList :: [IMPresence] -> ShowS #
Default IMPresence Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods def :: IMPresence #
Eq IMPresence Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods (==) :: IMPresence -> IMPresence -> Bool # (/=) :: IMPresence -> IMPresence -> Bool #

imPresence :: IMPresence Source #

getIMPresence :: Presence -> Maybe IMPresence Source #

Try to extract RFC6121 IM presence information from presence stanza. Returns Nothing when the data is malformed, (Just IMPresence) otherwise.

withIMPresence :: IMPresence -> Presence -> Presence Source #

xpIMPresence :: PU [Element] IMPresence Source #

xpShow :: PU Text ShowStatus Source #

timeout :: Maybe Integer Source #

Timeout to use with IQ requests

rosterSet Source #

Arguments

:: Jid	JID of the item
-> Maybe Text	Name alias
-> [Text]	Groups (duplicates will be removed)
-> Session
-> IO (Either IQSendError (Annotated IQResponse))

Add or update an item to the roster.

To update the item just send the complete set of new data.

rosterAdd :: Jid -> Maybe Text -> [Text] -> Session -> IO (Either IQSendError (Annotated IQResponse)) Source #

Synonym to rosterSet

rosterRemove :: Jid -> Session -> IO Bool Source #

Remove an item from the roster. Return True when the item is sucessfully removed or if it wasn't in the roster to begin with.

getRosterSTM :: Session -> STM Roster Source #

Retrieve the current Roster state (STM version)

getRoster :: Session -> IO Roster Source #

Retrieve the current Roster state

initRoster :: Session -> IO () Source #

Get the initial roster or refresh the roster. You don't need to call this on your own.

handleRoster :: Maybe Jid -> TVar Roster -> RosterPushCallback -> StanzaHandler Source #

retrieveRoster :: Maybe Roster -> Session -> IO (Maybe Roster) Source #

toItem :: QueryItem -> Item Source #

fromItem :: Item -> QueryItem Source #

xpItems :: PU [Node] [QueryItem] Source #

xpQuery :: PU [Node] Query Source #

xpSubscription :: PU Text Subscription Source #

data Subscription Source #

Constructors

None	the user does not have a subscription to the contact's presence information, and the contact does not have a subscription to the user's presence information
To	the user has a subscription to the contact's presence information, but the contact does not have a subscription to the user's presence information
From	the contact has a subscription to the user's presence information, but the user does not have a subscription to the contact's presence information
Both	both the user and the contact have subscriptions to each other's presence information
Remove

Instances

Instances details

Read Subscription Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods readsPrec :: Int -> ReadS Subscription # readList :: ReadS [Subscription] # readPrec :: ReadPrec Subscription # readListPrec :: ReadPrec [Subscription] #
Show Subscription Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods showsPrec :: Int -> Subscription -> ShowS # show :: Subscription -> String # showList :: [Subscription] -> ShowS #
Eq Subscription Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods (==) :: Subscription -> Subscription -> Bool # (/=) :: Subscription -> Subscription -> Bool #

data Roster Source #

Constructors

Roster
Fields ver :: Maybe Text items :: Map Jid Item

Instances

Instances details

Show Roster Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods showsPrec :: Int -> Roster -> ShowS # show :: Roster -> String # showList :: [Roster] -> ShowS #

data Item Source #

Roster Items

Constructors

Item
Fields riApproved :: Bool riAsk :: Bool riJid :: Jid riName :: Maybe Text riSubscription :: Subscription riGroups :: [Text]

Instances

Instances details

Show Item Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods showsPrec :: Int -> Item -> ShowS # show :: Item -> String # showList :: [Item] -> ShowS #

data RosterUpdate Source #

Constructors

RosterUpdateRemove Jid
RosterUpdateAdd Item	New or updated item

Instances

Instances details

Show RosterUpdate Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods showsPrec :: Int -> RosterUpdate -> ShowS # show :: RosterUpdate -> String # showList :: [RosterUpdate] -> ShowS #

data QueryItem Source #

Constructors

QueryItem
Fields qiApproved :: Maybe Bool qiAsk :: Bool qiJid :: Jid qiName :: Maybe Text qiSubscription :: Maybe Subscription qiGroups :: [Text]

Instances

Instances details

Show QueryItem Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods showsPrec :: Int -> QueryItem -> ShowS # show :: QueryItem -> String # showList :: [QueryItem] -> ShowS #

data Query Source #

Constructors

Query
Fields queryVer :: Maybe Text queryItems :: [QueryItem]

Instances

Instances details

Show Query Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #

xpNonemptyText :: PU Text NonemptyText Source #

xpStreamElement :: PU [Node] (Either StreamErrorInfo XmppElement) Source #

xpStreamStanza :: PU [Node] (Either StreamErrorInfo Stanza) Source #

xpExtendedAttrs :: PU [Attribute] [ExtendedAttribute] Source #

xpStanza :: PU [Node] Stanza Source #

xpMessage :: PU [Node] Message Source #

xpPresence :: PU [Node] Presence Source #

xpIQRequest :: PU [Node] IQRequest Source #

xpIQResult :: PU [Node] IQResult Source #

xpStanzaErrorCondition :: PU [Node] StanzaErrorCondition Source #

xpStanzaError :: PU [Node] StanzaError Source #

xpMessageError :: PU [Node] MessageError Source #

xpPresenceError :: PU [Node] PresenceError Source #

xpIQError :: PU [Node] IQError Source #

xpStreamError :: PU [Node] StreamErrorInfo Source #

xpLangTag :: PU [Attribute] (Maybe LangTag) Source #

xpLang :: PU Text LangTag Source #

xmlLang :: Name Source #

pickleElem :: PU [Node] a -> a -> Element Source #

unpickleElem :: PU [Node] a -> Element -> Either UnpickleError a Source #

xpNodeElem :: PU [Node] a -> PU Element a Source #

mbl :: Maybe [a] -> [a] Source #

lmb :: [t] -> Maybe [t] Source #

xpStream :: PU [Node] (Text, Maybe Jid, Maybe Jid, Maybe Text, Maybe LangTag) Source #

xpStreamFeatures :: PU [Node] StreamFeatures Source #

xpJid :: PU Text Jid Source #

xpIQRequestType :: PU Text IQRequestType Source #

xpMessageType :: PU Text MessageType Source #

xpPresenceType :: PU Text PresenceType Source #

xpStanzaErrorType :: PU Text StanzaErrorType Source #

xpStreamErrorCondition :: PU Text StreamErrorCondition Source #

xmppSasl Source #

Arguments

:: [SaslHandler]	Acceptable authentication mechanisms and their corresponding handlers
-> Stream
-> IO (Either XmppFailure (Maybe AuthFailure))

Uses the first supported mechanism to authenticate, if any. Updates the state with non-password credentials and restarts the stream upon success. Returns Nothing on success, an AuthFailure if authentication fails, or an XmppFailure if anything else fails.

digestMd5 Source #

Arguments

:: Username	Authentication identity (authcid or username)
-> Maybe AuthZID	Authorization identity (authzid)
-> Password	Password
-> SaslHandler

scramSha1 Source #

Arguments

:: Username	username
-> Maybe AuthZID	authorization ID
-> Password	password
-> SaslHandler

plain Source #

Arguments

:: Username	authentication ID (username)
-> Maybe AuthZID	authorization ID
-> Password	password
-> SaslHandler

auth :: [SaslHandler] -> Maybe Text -> Stream -> IO (Either XmppFailure (Maybe AuthFailure)) Source #

Authenticate to the server using the first matching method and bind a resource.

makeNonce :: IO ByteString Source #

saslInitE :: Text -> Maybe Text -> Element Source #

saslResponseE :: Maybe Text -> Element Source #

xpSuccess :: PU [Node] (Maybe Text) Source #

pairs :: ByteString -> Either String Pairs Source #

xpFailure :: PU [Node] SaslFailure Source #

xpSaslError :: PU Text SaslError Source #

xpChallenge :: PU [Node] (Maybe Text) Source #

xpSaslElement :: PU [Node] SaslElement Source #

Pickler for SaslElement.

quote :: ByteString -> ByteString Source #

Add quotationmarks around a byte string.

saslInit :: Text -> Maybe ByteString -> ExceptT AuthFailure (StateT StreamState IO) () Source #

pullSaslElement :: ExceptT AuthFailure (StateT StreamState IO) SaslElement Source #

Pull the next element.

pullChallenge :: ExceptT AuthFailure (StateT StreamState IO) (Maybe ByteString) Source #

Pull the next element, checking that it is a challenge.

saslFromJust :: Maybe a -> ExceptT AuthFailure (StateT StreamState IO) a Source #

Extract value from Just, failing with AuthOtherFailure on Nothing.

pullSuccess :: ExceptT AuthFailure (StateT StreamState IO) (Maybe Text) Source #

Pull the next element and check that it is success.

pullFinalMessage :: ExceptT AuthFailure (StateT StreamState IO) (Maybe ByteString) Source #

Pull the next element. When it's success, return it's payload. If it's a challenge, send an empty response and pull success.

toPairs :: ByteString -> ExceptT AuthFailure (StateT StreamState IO) Pairs Source #

Extract p=q pairs from a challenge.

respond :: Maybe ByteString -> ExceptT AuthFailure (StateT StreamState IO) () Source #

Send a SASL response element. The content will be base64-encoded.

prepCredentials :: Text -> Maybe Text -> Text -> ExceptT AuthFailure (StateT StreamState IO) (Text, Maybe Text, Text) Source #

Run the appropriate stringprep profiles on the credentials. May fail with AuthStringPrepFailure

xorBS :: ByteString -> ByteString -> ByteString Source #

Bit-wise xor of byte strings

merge :: [ByteString] -> ByteString Source #

Join byte strings with ","

(+++) :: ByteString -> ByteString -> ByteString Source #

Infix concatenation of byte strings

digestMd5 Source #

Arguments

:: Username	Authentication identity (authcid or username)
-> Maybe AuthZID	Authorization identity (authzid)
-> Password	Password
-> SaslHandler

scramSha1 Source #

Arguments

:: Username	username
-> Maybe AuthZID	authorization ID
-> Password	password
-> SaslHandler

plain Source #

Arguments

:: Username	authentication ID (username)
-> Maybe AuthZID	authorization ID
-> Password	password
-> SaslHandler

digestMd5 Source #

Arguments

:: Username	Authentication identity (authcid or username)
-> Maybe AuthZID	Authorization identity (authzid)
-> Password	Password
-> SaslHandler

plain Source #

Arguments

:: Username	authentication ID (username)
-> Maybe AuthZID	authorization ID
-> Password	password
-> SaslHandler

hashToken :: Hash ctx hash => hash Source #

A nicer name for undefined, for use as a dummy token to determin the hash function to use

scram Source #

Arguments

:: Hash ctx hash
=> hash	Dummy argument to determine the hash to use; you can safely pass undefined or a `hashToken` to it
-> Text	Authentication ID (user name)
-> Maybe Text	Authorization ID
-> Text	Password
-> ExceptT AuthFailure (StateT StreamState IO) ()

Salted Challenge Response Authentication Mechanism (SCRAM) SASL mechanism according to RFC 5802.

This implementation is independent and polymorphic in the used hash function.

scramSha1 Source #

Arguments

:: Username	username
-> Maybe AuthZID	authorization ID
-> Password	password
-> SaslHandler

nonAsciiSpaces :: Set Char Source #

toSpace :: Char -> Text Source #

saslPrepQuery :: StringPrepProfile Source #

saslPrepStore :: StringPrepProfile Source #

normalizePassword :: Text -> Maybe Text Source #

normalizeUsername :: Text -> Maybe Text Source #

type Username = Text Source #

type Password = Text Source #

type AuthZID = Text Source #

data SaslElement Source #

Constructors

SaslSuccess (Maybe Text)
SaslChallenge (Maybe Text)

type Pairs = [(ByteString, ByteString)] Source #

type SaslHandler = (Text, StateT StreamState IO (Either XmppFailure (Maybe AuthFailure))) Source #

Tuple defining the SASL Handler's name, and a SASL mechanism computation. The SASL mechanism is a stateful Stream computation, which has the possibility of resulting in an authentication error.

presenceSubscribe :: Jid -> Presence Source #

Request subscription with an entity.

presenceSubscribed :: Jid -> Presence Source #

Approve a subscripton of an entity.

presenceUnsubscribe :: Jid -> Presence Source #

End a subscription with an entity.

presenceUnsubscribed :: Jid -> Presence Source #

Deny a not-yet approved or terminate a previously approved subscription of an entity

presenceOnline :: Presence Source #

Signal to the server that the client is available for communication.

presenceOffline :: Presence Source #

Signal to the server that the client is no longer available for communication.

answerMessage :: Message -> [Element] -> Maybe Message Source #

Produce an answer message with the given payload, setting "from" to the "to" attributes in the original message. Produces a Nothing value of the provided message message has no "from" attribute. Sets the "from" attribute to Nothing to let the server assign one.

presTo :: Presence -> Jid -> Presence Source #

Add a recipient to a presence notification.

mkStanzaError Source #

Arguments

:: StanzaErrorCondition	condition
-> StanzaError

Create a StanzaError with condition and the associatedErrorType. Leave the error text and the application specific condition empty

iqError :: StanzaErrorCondition -> IQRequest -> IQError Source #

Create an IQ error response to an IQ request using the given condition. The error type is derived from the condition using associatedErrorType and both text and the application specific condition are left empty

iqResult :: Maybe Element -> IQRequest -> IQResult Source #

Create an IQ Result matching an IQ request

associatedErrorType :: StanzaErrorCondition -> StanzaErrorType Source #

The RECOMMENDED error type associated with an error condition. The following conditions allow for multiple types

FeatureNotImplemented: Cancel or Modify (returns Cancel)
PolicyViolation: Modify or Wait (Modify)
RemoteServerTimeout: Wait or unspecified other (Wait)
UndefinedCondition: Any condition (Cancel)

type StreamSink a = ConduitM Event Void (ExceptT XmppFailure IO) a Source #

readMaybe_ :: Read a => String -> Maybe a Source #

streamUnpickleElem :: PU [Node] a -> Element -> StreamSink a Source #

throwOutJunk :: Monad m => ConduitM Event a m () Source #

openElementFromEvents :: StreamSink Element Source #

startStream :: StateT StreamState IO (Either XmppFailure ()) Source #

flattenAttrs :: [(Name, [Content])] -> [(Name, Text)] Source #

restartStream :: StateT StreamState IO (Either XmppFailure ()) Source #

sourceStreamHandleRaw :: (MonadIO m, MonadError XmppFailure m) => StreamHandle -> ConduitM i ByteString m () Source #

sourceStreamHandle :: (MonadIO m, MonadError XmppFailure m) => StreamHandle -> ConduitM i ByteString m () Source #

logInput :: MonadIO m => ConduitM ByteString ByteString m () Source #

bufferSrc :: ConduitT () o (ExceptT XmppFailure IO) () -> IO (ConduitM i o (ExceptT XmppFailure IO) ()) Source #

streamS :: Maybe Jid -> StreamSink (Either Element (Text, Maybe Jid, Maybe Jid, Maybe Text, Maybe LangTag, StreamFeatures)) Source #

openStream :: HostName -> StreamConfiguration -> IO (Either XmppFailure Stream) Source #

Connects to the XMPP server and opens the XMPP stream against the given realm.

closeStreams :: Stream -> IO () Source #

Send "/stream:stream" and wait for the server to finish processing and to close the connection. Any remaining elements from the server are returned. Surpresses StreamEndFailure exceptions, but may throw a StreamCloseError.

closeStreams' :: StateT StreamState IO () Source #

debugOut :: MonadIO m => ByteString -> m () Source #

wrapIOException :: MonadIO m => String -> IO a -> m (Either XmppFailure a) Source #

pushElement :: Element -> StateT StreamState IO (Either XmppFailure ()) Source #

nsHack :: Element -> Element Source #

pushStanza :: Stanza -> Stream -> IO (Either XmppFailure ()) Source #

Encode and send stanza

pushXmlDecl :: StateT StreamState IO (Either XmppFailure ()) Source #

pushOpenElement :: Element -> StateT StreamState IO (Either XmppFailure ()) Source #

runEventsSink :: ConduitT Event Void (ExceptT XmppFailure IO) b -> StateT StreamState IO (Either XmppFailure b) Source #

pullElement :: StateT StreamState IO (Either XmppFailure Element) Source #

pullUnpickle :: PU [Node] a -> StateT StreamState IO (Either XmppFailure a) Source #

pullStanza :: Stream -> IO (Either XmppFailure Stanza) Source #

Pulls a stanza (or stream error) from the stream.

pullXmppElement :: Stream -> IO (Either XmppFailure XmppElement) Source #

Pulls a stanza, nonza or stream error from the stream.

catchPush :: IO () -> IO (Either XmppFailure ()) Source #

zeroHandle :: StreamHandle Source #

xmppNoStream :: StreamState Source #

zeroSource :: ConduitT () a (ExceptT XmppFailure IO) () Source #

handleToStreamHandle :: Handle -> StreamHandle Source #

createStream :: HostName -> StreamConfiguration -> ExceptT XmppFailure IO Stream Source #

connect :: HostName -> StreamConfiguration -> ExceptT XmppFailure IO (Maybe StreamHandle) Source #

connectSrv :: ResolvConf -> String -> ExceptT XmppFailure IO (Maybe Handle) Source #

connectHandle :: AddrInfo -> IO Handle Source #

connectTcp :: [AddrInfo] -> IO (Maybe Handle) Source #

fixDnsResult :: Either e a -> Maybe a Source #

resolveAndConnectTcp :: HostName -> PortNumber -> IO (Maybe Handle) Source #

resolvSrvsAndConnectTcp :: [(HostName, PortNumber)] -> IO (Maybe Handle) Source #

rethrowErrorCall :: IO a -> IO a Source #

srvLookup :: Text -> ResolvSeed -> ExceptT XmppFailure IO (Maybe [(Domain, Word16)]) Source #

killStream :: Stream -> IO (Either XmppFailure ()) Source #

Close the connection and updates the XmppConMonad Stream state. Does not send the stream end tag.

pushIQ :: Text -> Maybe Jid -> IQRequestType -> Maybe LangTag -> Element -> Stream -> IO (Either XmppFailure (Either IQError IQResult)) Source #

debugConduit :: (Show o, MonadIO m) => ConduitM o o m b Source #

elements :: MonadError XmppFailure m => ConduitT Event Element m () Source #

withStream :: StateT StreamState IO a -> Stream -> IO a Source #

withStream' :: StateT StreamState IO a -> Stream -> IO a Source #

mkStream :: StreamState -> IO Stream Source #

tryIOError :: IO a -> IO (Either IOError a) Source #

mkBackend :: StreamHandle -> Backend Source #

starttlsE :: Element Source #

tls :: Stream -> IO (Either XmppFailure ()) Source #

Checks for TLS support and run starttls procedure if applicable

client :: MonadIO m => ClientParams -> Backend -> m Context Source #

tlsinit :: (MonadIO m, MonadIO m1) => ClientParams -> Backend -> m (ConduitT () ByteString m1 (), ConduitT ByteString Void m1 (), ByteString -> IO (), Int -> m1 ByteString, Context) Source #

mkReadBuffer :: IO ByteString -> IO (Int -> IO ByteString) Source #

connectTls Source #

Arguments

:: ResolvConf	Resolv conf to use (try `defaultResolvConf` as a default)
-> ClientParams	TLS parameters to use when securing the connection
-> String	Host to use when connecting (will be resolved using SRV records)
-> ExceptT XmppFailure IO StreamHandle

Connect to an XMPP server and secure the connection with TLS before starting the XMPP streams

NB RFC 6120 does not specify this method, but some servers, notably GCS, seem to use it.

wrapExceptions :: IO a -> IO (Either XmppFailure a) Source #

newtype NonemptyText Source #

Type of Texts that contain at least on non-space character

Constructors

Nonempty
Fields fromNonempty :: Text

Instances

Instances details

IsString NonemptyText Source #
Instance details Defined in Network.Xmpp.Types Methods fromString :: String -> NonemptyText #
Read NonemptyText Source #
Instance details Defined in Network.Xmpp.Types Methods readsPrec :: Int -> ReadS NonemptyText # readList :: ReadS [NonemptyText] # readPrec :: ReadPrec NonemptyText # readListPrec :: ReadPrec [NonemptyText] #
Show NonemptyText Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> NonemptyText -> ShowS # show :: NonemptyText -> String # showList :: [NonemptyText] -> ShowS #
Eq NonemptyText Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: NonemptyText -> NonemptyText -> Bool # (/=) :: NonemptyText -> NonemptyText -> Bool #
Ord NonemptyText Source #
Instance details Defined in Network.Xmpp.Types Methods compare :: NonemptyText -> NonemptyText -> Ordering # (<) :: NonemptyText -> NonemptyText -> Bool # (<=) :: NonemptyText -> NonemptyText -> Bool # (>) :: NonemptyText -> NonemptyText -> Bool # (>=) :: NonemptyText -> NonemptyText -> Bool # max :: NonemptyText -> NonemptyText -> NonemptyText # min :: NonemptyText -> NonemptyText -> NonemptyText #

nonEmpty :: Text -> Maybe NonemptyText Source #

Check that Text contains at least one non-space character and wrap it

text :: NonemptyText -> Text Source #

Same as fromNonempty

data IQError Source #

The answer to an IQ request that generated an error.

Constructors

IQError
Fields iqErrorID :: !Text iqErrorFrom :: !(Maybe Jid) iqErrorTo :: !(Maybe Jid) iqErrorLangTag :: !(Maybe LangTag) iqErrorStanzaError :: !StanzaError iqErrorPayload :: !(Maybe Element) iqErrorAttributes :: ![ExtendedAttribute]

Instances

Instances details

Generic IQError Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep IQError :: Type -> Type # Methods from :: IQError -> Rep IQError x # to :: Rep IQError x -> IQError #
Show IQError Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> IQError -> ShowS # show :: IQError -> String # showList :: [IQError] -> ShowS #
Eq IQError Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: IQError -> IQError -> Bool # (/=) :: IQError -> IQError -> Bool #
IsErrorStanza IQError Source #
Instance details Defined in Network.Xmpp.Lens Methods stanzaError :: Lens IQError StanzaError Source #
IsStanza IQError Source #
Instance details Defined in Network.Xmpp.Lens Methods from :: Lens IQError (Maybe Jid) Source # to :: Lens IQError (Maybe Jid) Source # lang :: Lens IQError (Maybe LangTag) Source # sid :: Lens IQError (Maybe Text) Source # payloadT :: Traversal IQError Element Source #
HasStanzaPayload IQError (Maybe Element) Source #
Instance details Defined in Network.Xmpp.Lens Methods payload :: Lens IQError (Maybe Element) Source #
type Rep IQError Source #
Instance details Defined in Network.Xmpp.Types type Rep IQError = D1 ('MetaData "IQError" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "IQError" 'PrefixI 'True) ((S1 ('MetaSel ('Just "iqErrorID") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "iqErrorFrom") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)) :: S1 ('MetaSel ('Just "iqErrorTo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)))) :: ((S1 ('MetaSel ('Just "iqErrorLangTag") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe LangTag)) :: S1 ('MetaSel ('Just "iqErrorStanzaError") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StanzaError)) :: (S1 ('MetaSel ('Just "iqErrorPayload") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Element)) :: S1 ('MetaSel ('Just "iqErrorAttributes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ExtendedAttribute])))))

data IQRequest Source #

A "request" Info/Query (IQ) stanza is one with either "get" or "set" as type. It always contains an xml payload.

Constructors

IQRequest
Fields iqRequestID :: !Text iqRequestFrom :: !(Maybe Jid) iqRequestTo :: !(Maybe Jid) iqRequestLangTag :: !(Maybe LangTag) iqRequestType :: !IQRequestType iqRequestPayload :: !Element iqRequestAttributes :: ![ExtendedAttribute]

Instances

Instances details

Generic IQRequest Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep IQRequest :: Type -> Type # Methods from :: IQRequest -> Rep IQRequest x # to :: Rep IQRequest x -> IQRequest #
Show IQRequest Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> IQRequest -> ShowS # show :: IQRequest -> String # showList :: [IQRequest] -> ShowS #
Eq IQRequest Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: IQRequest -> IQRequest -> Bool # (/=) :: IQRequest -> IQRequest -> Bool #
IsStanza IQRequest Source #
Instance details Defined in Network.Xmpp.Lens Methods from :: Lens IQRequest (Maybe Jid) Source # to :: Lens IQRequest (Maybe Jid) Source # lang :: Lens IQRequest (Maybe LangTag) Source # sid :: Lens IQRequest (Maybe Text) Source # payloadT :: Traversal IQRequest Element Source #
HasStanzaPayload IQRequest Element Source #
Instance details Defined in Network.Xmpp.Lens Methods payload :: Lens IQRequest Element Source #
type Rep IQRequest Source #
Instance details Defined in Network.Xmpp.Types type Rep IQRequest = D1 ('MetaData "IQRequest" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "IQRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "iqRequestID") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "iqRequestFrom") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)) :: S1 ('MetaSel ('Just "iqRequestTo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)))) :: ((S1 ('MetaSel ('Just "iqRequestLangTag") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe LangTag)) :: S1 ('MetaSel ('Just "iqRequestType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 IQRequestType)) :: (S1 ('MetaSel ('Just "iqRequestPayload") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Element) :: S1 ('MetaSel ('Just "iqRequestAttributes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ExtendedAttribute])))))

data IQRequestType Source #

The type of IQ request that is made.

Constructors

Get
Set

Instances

Instances details

Generic IQRequestType Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep IQRequestType :: Type -> Type # Methods from :: IQRequestType -> Rep IQRequestType x # to :: Rep IQRequestType x -> IQRequestType #
Read IQRequestType Source #
Instance details Defined in Network.Xmpp.Types Methods readsPrec :: Int -> ReadS IQRequestType # readList :: ReadS [IQRequestType] # readPrec :: ReadPrec IQRequestType # readListPrec :: ReadPrec [IQRequestType] #
Show IQRequestType Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> IQRequestType -> ShowS # show :: IQRequestType -> String # showList :: [IQRequestType] -> ShowS #
Eq IQRequestType Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: IQRequestType -> IQRequestType -> Bool # (/=) :: IQRequestType -> IQRequestType -> Bool #
Ord IQRequestType Source #
Instance details Defined in Network.Xmpp.Types Methods compare :: IQRequestType -> IQRequestType -> Ordering # (<) :: IQRequestType -> IQRequestType -> Bool # (<=) :: IQRequestType -> IQRequestType -> Bool # (>) :: IQRequestType -> IQRequestType -> Bool # (>=) :: IQRequestType -> IQRequestType -> Bool # max :: IQRequestType -> IQRequestType -> IQRequestType # min :: IQRequestType -> IQRequestType -> IQRequestType #
type Rep IQRequestType Source #
Instance details Defined in Network.Xmpp.Types type Rep IQRequestType = D1 ('MetaData "IQRequestType" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "Get" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Set" 'PrefixI 'False) (U1 :: Type -> Type))

data IQResponse Source #

A "response" Info/Query (IQ) stanza is either an IQError, an IQ stanza of type "result" (IQResult)

Constructors

IQResponseError IQError
IQResponseResult IQResult

Instances

Instances details

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

data IQResult Source #

The (non-error) answer to an IQ request.

Constructors

IQResult
Fields iqResultID :: !Text iqResultFrom :: !(Maybe Jid) iqResultTo :: !(Maybe Jid) iqResultLangTag :: !(Maybe LangTag) iqResultPayload :: !(Maybe Element) iqResultAttributes :: ![ExtendedAttribute]

Instances

Instances details

Generic IQResult Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep IQResult :: Type -> Type # Methods from :: IQResult -> Rep IQResult x # to :: Rep IQResult x -> IQResult #
Show IQResult Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> IQResult -> ShowS # show :: IQResult -> String # showList :: [IQResult] -> ShowS #
Eq IQResult Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: IQResult -> IQResult -> Bool # (/=) :: IQResult -> IQResult -> Bool #
IsStanza IQResult Source #
Instance details Defined in Network.Xmpp.Lens Methods from :: Lens IQResult (Maybe Jid) Source # to :: Lens IQResult (Maybe Jid) Source # lang :: Lens IQResult (Maybe LangTag) Source # sid :: Lens IQResult (Maybe Text) Source # payloadT :: Traversal IQResult Element Source #
HasStanzaPayload IQResult (Maybe Element) Source #
Instance details Defined in Network.Xmpp.Lens Methods payload :: Lens IQResult (Maybe Element) Source #
type Rep IQResult Source #
Instance details Defined in Network.Xmpp.Types type Rep IQResult = D1 ('MetaData "IQResult" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "IQResult" 'PrefixI 'True) ((S1 ('MetaSel ('Just "iqResultID") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "iqResultFrom") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)) :: S1 ('MetaSel ('Just "iqResultTo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)))) :: (S1 ('MetaSel ('Just "iqResultLangTag") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe LangTag)) :: (S1 ('MetaSel ('Just "iqResultPayload") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Element)) :*: S1 ('MetaSel ('Just "iqResultAttributes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ExtendedAttribute])))))

data LangTag Source #

The language tag in accordance with RFC 5646 (in the form of "en-US"). It has a primary tag and a number of subtags. Two language tags are considered equal if and only if they contain the same tags (case-insensitive).

Constructors

LangTag
Fields primaryTag :: !Text subtags :: ![Text]

Instances

Instances details

Read LangTag Source #
Instance details Defined in Network.Xmpp.Types Methods readsPrec :: Int -> ReadS LangTag # readList :: ReadS [LangTag] # readPrec :: ReadPrec LangTag # readListPrec :: ReadPrec [LangTag] #
Show LangTag Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> LangTag -> ShowS # show :: LangTag -> String # showList :: [LangTag] -> ShowS #
Eq LangTag Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: LangTag -> LangTag -> Bool # (/=) :: LangTag -> LangTag -> Bool #

langTagQ :: QuasiQuoter Source #

langTagFromText :: Text -> Maybe LangTag Source #

Parses, validates, and possibly constructs a LangTag object.

langTagToText :: LangTag -> Text Source #

parseLangTag :: String -> LangTag Source #

type ExtendedAttribute = (Name, Text) Source #

data Message Source #

The message stanza. Used for push type communication.

Constructors

Message
Fields messageID :: !(Maybe Text) messageFrom :: !(Maybe Jid) messageTo :: !(Maybe Jid) messageLangTag :: !(Maybe LangTag) messageType :: !MessageType messagePayload :: ![Element] messageAttributes :: ![ExtendedAttribute]

Instances

Instances details

Generic Message Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep Message :: Type -> Type # Methods from :: Message -> Rep Message x # to :: Rep Message x -> Message #
Show Message Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Default Message Source #
Instance details Defined in Network.Xmpp.Types Methods def :: Message #
Eq Message Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
IsStanza Message Source #
Instance details Defined in Network.Xmpp.Lens Methods from :: Lens Message (Maybe Jid) Source # to :: Lens Message (Maybe Jid) Source # lang :: Lens Message (Maybe LangTag) Source # sid :: Lens Message (Maybe Text) Source # payloadT :: Traversal Message Element Source #
HasStanzaPayload Message [Element] Source #
Instance details Defined in Network.Xmpp.Lens Methods payload :: Lens Message [Element] Source #
type Rep Message Source #
Instance details Defined in Network.Xmpp.Types type Rep Message = D1 ('MetaData "Message" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "Message" 'PrefixI 'True) ((S1 ('MetaSel ('Just "messageID") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "messageFrom") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)) :: S1 ('MetaSel ('Just "messageTo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)))) :: ((S1 ('MetaSel ('Just "messageLangTag") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe LangTag)) :: S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MessageType)) :: (S1 ('MetaSel ('Just "messagePayload") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Element]) :: S1 ('MetaSel ('Just "messageAttributes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ExtendedAttribute])))))

message :: Message Source #

An empty message

message = Message { messageID      = Nothing
                  , messageFrom    = Nothing
                  , messageTo      = Nothing
                  , messageLangTag = Nothing
                  , messageType    = Normal
                  , messagePayload = []
                  }

data MessageError Source #

An error stanza generated in response to a Message.

Constructors

MessageError
Fields messageErrorID :: !(Maybe Text) messageErrorFrom :: !(Maybe Jid) messageErrorTo :: !(Maybe Jid) messageErrorLangTag :: !(Maybe LangTag) messageErrorStanzaError :: !StanzaError messageErrorPayload :: ![Element] messageErrorAttributes :: ![ExtendedAttribute]

Instances

Instances details

Generic MessageError Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep MessageError :: Type -> Type # Methods from :: MessageError -> Rep MessageError x # to :: Rep MessageError x -> MessageError #
Show MessageError Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> MessageError -> ShowS # show :: MessageError -> String # showList :: [MessageError] -> ShowS #
Default MessageError Source #
Instance details Defined in Network.Xmpp.Types Methods def :: MessageError #
Eq MessageError Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: MessageError -> MessageError -> Bool # (/=) :: MessageError -> MessageError -> Bool #
IsErrorStanza MessageError Source #
Instance details Defined in Network.Xmpp.Lens Methods stanzaError :: Lens MessageError StanzaError Source #
IsStanza MessageError Source #
Instance details Defined in Network.Xmpp.Lens Methods from :: Lens MessageError (Maybe Jid) Source # to :: Lens MessageError (Maybe Jid) Source # lang :: Lens MessageError (Maybe LangTag) Source # sid :: Lens MessageError (Maybe Text) Source # payloadT :: Traversal MessageError Element Source #
HasStanzaPayload MessageError [Element] Source #
Instance details Defined in Network.Xmpp.Lens Methods payload :: Lens MessageError [Element] Source #
type Rep MessageError Source #
Instance details Defined in Network.Xmpp.Types type Rep MessageError = D1 ('MetaData "MessageError" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "MessageError" 'PrefixI 'True) ((S1 ('MetaSel ('Just "messageErrorID") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "messageErrorFrom") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)) :: S1 ('MetaSel ('Just "messageErrorTo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)))) :: ((S1 ('MetaSel ('Just "messageErrorLangTag") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe LangTag)) :: S1 ('MetaSel ('Just "messageErrorStanzaError") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StanzaError)) :: (S1 ('MetaSel ('Just "messageErrorPayload") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Element]) :: S1 ('MetaSel ('Just "messageErrorAttributes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ExtendedAttribute])))))

messageError :: MessageError Source #

data MessageType Source #

The type of a Message being sent (http://xmpp.org/rfcs/rfc6121.html#message-syntax-type)

Constructors

Chat	The message is sent in the context of a one-to-one chat session. Typically an interactive client will present a message of type chat in an interface that enables one-to-one chat between the two parties, including an appropriate conversation history.
GroupChat	The message is sent in the context of a multi-user chat environment (similar to that of `IRC`). Typically a receiving client will present a message of type groupchat in an interface that enables many-to-many chat between the parties, including a roster of parties in the chatroom and an appropriate conversation history.
Headline	The message provides an alert, a notification, or other transient information to which no reply is expected (e.g., news headlines, sports updates, near-real-time market data, or syndicated content). Because no reply to the message is expected, typically a receiving client will present a message of type headline in an interface that appropriately differentiates the message from standalone messages, chat messages, and groupchat messages (e.g., by not providing the recipient with the ability to reply).
Normal	The message is a standalone message that is sent outside the context of a one-to-one conversation or groupchat, and to which it is expected that the recipient will reply. Typically a receiving client will present a message of type normal in an interface that enables the recipient to reply, but without a conversation history. This is the default value.

Instances

Instances details

Generic MessageType Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep MessageType :: Type -> Type # Methods from :: MessageType -> Rep MessageType x # to :: Rep MessageType x -> MessageType #
Read MessageType Source #
Instance details Defined in Network.Xmpp.Types Methods readsPrec :: Int -> ReadS MessageType # readList :: ReadS [MessageType] # readPrec :: ReadPrec MessageType # readListPrec :: ReadPrec [MessageType] #
Show MessageType Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> MessageType -> ShowS # show :: MessageType -> String # showList :: [MessageType] -> ShowS #
Eq MessageType Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: MessageType -> MessageType -> Bool # (/=) :: MessageType -> MessageType -> Bool #
type Rep MessageType Source #
Instance details Defined in Network.Xmpp.Types type Rep MessageType = D1 ('MetaData "MessageType" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) ((C1 ('MetaCons "Chat" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GroupChat" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Headline" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Normal" 'PrefixI 'False) (U1 :: Type -> Type)))

data Presence Source #

The presence stanza. Used for communicating status updates.

Constructors

Presence
Fields presenceID :: !(Maybe Text) presenceFrom :: !(Maybe Jid) presenceTo :: !(Maybe Jid) presenceLangTag :: !(Maybe LangTag) presenceType :: !PresenceType presencePayload :: ![Element] presenceAttributes :: ![ExtendedAttribute]

Instances

Instances details

Generic Presence Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep Presence :: Type -> Type # Methods from :: Presence -> Rep Presence x # to :: Rep Presence x -> Presence #
Show Presence Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> Presence -> ShowS # show :: Presence -> String # showList :: [Presence] -> ShowS #
Default Presence Source #
Instance details Defined in Network.Xmpp.Types Methods def :: Presence #
Eq Presence Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: Presence -> Presence -> Bool # (/=) :: Presence -> Presence -> Bool #
IsStanza Presence Source #
Instance details Defined in Network.Xmpp.Lens Methods from :: Lens Presence (Maybe Jid) Source # to :: Lens Presence (Maybe Jid) Source # lang :: Lens Presence (Maybe LangTag) Source # sid :: Lens Presence (Maybe Text) Source # payloadT :: Traversal Presence Element Source #
HasStanzaPayload Presence [Element] Source #
Instance details Defined in Network.Xmpp.Lens Methods payload :: Lens Presence [Element] Source #
type Rep Presence Source #
Instance details Defined in Network.Xmpp.Types type Rep Presence = D1 ('MetaData "Presence" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "Presence" 'PrefixI 'True) ((S1 ('MetaSel ('Just "presenceID") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "presenceFrom") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)) :: S1 ('MetaSel ('Just "presenceTo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)))) :: ((S1 ('MetaSel ('Just "presenceLangTag") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe LangTag)) :: S1 ('MetaSel ('Just "presenceType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PresenceType)) :: (S1 ('MetaSel ('Just "presencePayload") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Element]) :: S1 ('MetaSel ('Just "presenceAttributes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ExtendedAttribute])))))

presence :: Presence Source #

An empty presence.

data PresenceError Source #

An error stanza generated in response to a Presence.

Constructors

PresenceError
Fields presenceErrorID :: !(Maybe Text) presenceErrorFrom :: !(Maybe Jid) presenceErrorTo :: !(Maybe Jid) presenceErrorLangTag :: !(Maybe LangTag) presenceErrorStanzaError :: !StanzaError presenceErrorPayload :: ![Element] presenceErrorAttributes :: ![ExtendedAttribute]

Instances

Instances details

Generic PresenceError Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep PresenceError :: Type -> Type # Methods from :: PresenceError -> Rep PresenceError x # to :: Rep PresenceError x -> PresenceError #
Show PresenceError Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> PresenceError -> ShowS # show :: PresenceError -> String # showList :: [PresenceError] -> ShowS #
Eq PresenceError Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: PresenceError -> PresenceError -> Bool # (/=) :: PresenceError -> PresenceError -> Bool #
IsErrorStanza PresenceError Source #
Instance details Defined in Network.Xmpp.Lens Methods stanzaError :: Lens PresenceError StanzaError Source #
IsStanza PresenceError Source #
Instance details Defined in Network.Xmpp.Lens Methods from :: Lens PresenceError (Maybe Jid) Source # to :: Lens PresenceError (Maybe Jid) Source # lang :: Lens PresenceError (Maybe LangTag) Source # sid :: Lens PresenceError (Maybe Text) Source # payloadT :: Traversal PresenceError Element Source #
HasStanzaPayload PresenceError [Element] Source #
Instance details Defined in Network.Xmpp.Lens Methods payload :: Lens PresenceError [Element] Source #
type Rep PresenceError Source #
Instance details Defined in Network.Xmpp.Types type Rep PresenceError = D1 ('MetaData "PresenceError" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "PresenceError" 'PrefixI 'True) ((S1 ('MetaSel ('Just "presenceErrorID") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "presenceErrorFrom") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)) :: S1 ('MetaSel ('Just "presenceErrorTo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Jid)))) :: ((S1 ('MetaSel ('Just "presenceErrorLangTag") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe LangTag)) :: S1 ('MetaSel ('Just "presenceErrorStanzaError") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StanzaError)) :: (S1 ('MetaSel ('Just "presenceErrorPayload") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Element]) :: S1 ('MetaSel ('Just "presenceErrorAttributes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ExtendedAttribute])))))

data PresenceType Source #

PresenceType holds Xmpp presence types. The "error" message type is left out as errors are using PresenceError.

Constructors

Subscribe	Sender wants to subscribe to presence
Subscribed	Sender has approved the subscription
Unsubscribe	Sender is unsubscribing from presence
Unsubscribed	Sender has denied or cancelled a subscription
Probe	Sender requests current presence; should only be used by servers
Available	Sender wants to express availability (no type attribute is defined)
Unavailable

Instances

Instances details

Generic PresenceType Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep PresenceType :: Type -> Type # Methods from :: PresenceType -> Rep PresenceType x # to :: Rep PresenceType x -> PresenceType #
Read PresenceType Source #
Instance details Defined in Network.Xmpp.Types Methods readsPrec :: Int -> ReadS PresenceType # readList :: ReadS [PresenceType] # readPrec :: ReadPrec PresenceType # readListPrec :: ReadPrec [PresenceType] #
Show PresenceType Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> PresenceType -> ShowS # show :: PresenceType -> String # showList :: [PresenceType] -> ShowS #
Eq PresenceType Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: PresenceType -> PresenceType -> Bool # (/=) :: PresenceType -> PresenceType -> Bool #
type Rep PresenceType Source #
Instance details Defined in Network.Xmpp.Types type Rep PresenceType = D1 ('MetaData "PresenceType" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) ((C1 ('MetaCons "Subscribe" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Subscribed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Unsubscribe" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Unsubscribed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Probe" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Available" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Unavailable" 'PrefixI 'False) (U1 :: Type -> Type))))

data SaslError Source #

Constructors

SaslAborted	Client aborted.
SaslAccountDisabled	The account has been temporarily disabled.
SaslCredentialsExpired	The authentication failed because the credentials have expired.
SaslEncryptionRequired	The mechanism requested cannot be used the confidentiality and integrity of the underlying stream is protected (typically with TLS).
SaslIncorrectEncoding	The base64 encoding is incorrect.
SaslInvalidAuthzid	The authzid has an incorrect format or the initiating entity does not have the appropriate permissions to authorize that ID.
SaslInvalidMechanism	The mechanism is not supported by the receiving entity.
SaslMalformedRequest	Invalid syntax.
SaslMechanismTooWeak	The receiving entity policy requires a stronger mechanism.
SaslNotAuthorized	Invalid credentials provided, or some generic authentication failure has occurred.
SaslTemporaryAuthFailure	There receiving entity reported a temporary error condition; the initiating entity is recommended to try again later.

Instances

Instances details

Generic SaslError Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep SaslError :: Type -> Type # Methods from :: SaslError -> Rep SaslError x # to :: Rep SaslError x -> SaslError #
Read SaslError Source #
Instance details Defined in Network.Xmpp.Types Methods readsPrec :: Int -> ReadS SaslError # readList :: ReadS [SaslError] # readPrec :: ReadPrec SaslError # readListPrec :: ReadPrec [SaslError] #
Show SaslError Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> SaslError -> ShowS # show :: SaslError -> String # showList :: [SaslError] -> ShowS #
Eq SaslError Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: SaslError -> SaslError -> Bool # (/=) :: SaslError -> SaslError -> Bool #
type Rep SaslError Source #
Instance details Defined in Network.Xmpp.Types type Rep SaslError = D1 ('MetaData "SaslError" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (((C1 ('MetaCons "SaslAborted" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SaslAccountDisabled" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SaslCredentialsExpired" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SaslEncryptionRequired" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SaslIncorrectEncoding" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "SaslInvalidAuthzid" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SaslInvalidMechanism" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SaslMalformedRequest" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "SaslMechanismTooWeak" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SaslNotAuthorized" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SaslTemporaryAuthFailure" 'PrefixI 'False) (U1 :: Type -> Type)))))

data SaslFailure Source #

Constructors

SaslFailure
Fields saslFailureCondition :: SaslError saslFailureText :: Maybe (Maybe LangTag, Text)

Instances

Instances details

Generic SaslFailure Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep SaslFailure :: Type -> Type # Methods from :: SaslFailure -> Rep SaslFailure x # to :: Rep SaslFailure x -> SaslFailure #
Show SaslFailure Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> SaslFailure -> ShowS # show :: SaslFailure -> String # showList :: [SaslFailure] -> ShowS #
Eq SaslFailure Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: SaslFailure -> SaslFailure -> Bool # (/=) :: SaslFailure -> SaslFailure -> Bool #
type Rep SaslFailure Source #
Instance details Defined in Network.Xmpp.Types type Rep SaslFailure = D1 ('MetaData "SaslFailure" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "SaslFailure" 'PrefixI 'True) (S1 ('MetaSel ('Just "saslFailureCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SaslError) :*: S1 ('MetaSel ('Just "saslFailureText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe LangTag, Text)))))

data StreamFeatures Source #

Constructors

StreamFeatures

Fields

streamFeaturesTls :: !(Maybe Bool)
streamFeaturesMechanisms :: ![Text]
streamFeaturesRosterVer :: !(Maybe Bool)
Nothing for no roster versioning, Just False for roster versioning and Just True when the server sends the non-standard "optional" element (observed with prosody).
streamFeaturesPreApproval :: !Bool
Does the server support pre-approval
streamFeaturesSession :: !(Maybe Bool)
Does this server allow the stream elelemt? (See https://tools.ietf.org/html/draft-cridland-xmpp-session-01)
streamFeaturesOther :: ![Element]

Instances

Instances details

Monoid StreamFeatures Source #
Instance details Defined in Network.Xmpp.Types Methods mempty :: StreamFeatures # mappend :: StreamFeatures -> StreamFeatures -> StreamFeatures # mconcat :: [StreamFeatures] -> StreamFeatures #
Semigroup StreamFeatures Source #
Instance details Defined in Network.Xmpp.Types Methods (<>) :: StreamFeatures -> StreamFeatures -> StreamFeatures # sconcat :: NonEmpty StreamFeatures -> StreamFeatures # stimes :: Integral b => b -> StreamFeatures -> StreamFeatures #
Show StreamFeatures Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> StreamFeatures -> ShowS # show :: StreamFeatures -> String # showList :: [StreamFeatures] -> ShowS #
Eq StreamFeatures Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: StreamFeatures -> StreamFeatures -> Bool # (/=) :: StreamFeatures -> StreamFeatures -> Bool #

data Stanza Source #

The Xmpp communication primitives (Message, Presence and Info/Query) are called stanzas.

Constructors

IQRequestS !IQRequest
IQResultS !IQResult
IQErrorS !IQError
MessageS !Message
MessageErrorS !MessageError
PresenceS !Presence
PresenceErrorS !PresenceError

Instances

Instances details

Generic Stanza Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep Stanza :: Type -> Type # Methods from :: Stanza -> Rep Stanza x # to :: Rep Stanza x -> Stanza #
Show Stanza Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> Stanza -> ShowS # show :: Stanza -> String # showList :: [Stanza] -> ShowS #
Eq Stanza Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: Stanza -> Stanza -> Bool # (/=) :: Stanza -> Stanza -> Bool #
IsStanza Stanza Source #
Instance details Defined in Network.Xmpp.Lens Methods from :: Lens Stanza (Maybe Jid) Source # to :: Lens Stanza (Maybe Jid) Source # lang :: Lens Stanza (Maybe LangTag) Source # sid :: Lens Stanza (Maybe Text) Source # payloadT :: Traversal Stanza Element Source #
type Rep Stanza Source #
Instance details Defined in Network.Xmpp.Types type Rep Stanza = D1 ('MetaData "Stanza" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) ((C1 ('MetaCons "IQRequestS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 IQRequest)) :+: (C1 ('MetaCons "IQResultS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 IQResult)) :+: C1 ('MetaCons "IQErrorS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 IQError)))) :+: ((C1 ('MetaCons "MessageS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Message)) :+: C1 ('MetaCons "MessageErrorS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MessageError))) :+: (C1 ('MetaCons "PresenceS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Presence)) :+: C1 ('MetaCons "PresenceErrorS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PresenceError)))))

data XmppElement Source #

Constructors

XmppStanza !Stanza
XmppNonza !Element

Instances

Instances details

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

messageS :: Stanza Source #

Empty message stanza

messageS = MessageS message

messageErrorS :: Stanza Source #

presenceS :: Stanza Source #

Empty presence stanza

data StanzaError Source #

All stanzas (IQ, message, presence) can cause errors, which in the Xmpp stream looks like <stanza-kind to='sender' type='error'> . These errors are wrapped in the StanzaError type. TODO: Sender XML is (optional and is) not yet included.

Constructors

StanzaError
Fields stanzaErrorType :: StanzaErrorType stanzaErrorCondition :: StanzaErrorCondition stanzaErrorText :: Maybe (Maybe LangTag, NonemptyText) stanzaErrorApplicationSpecificCondition :: Maybe Element

Instances

Instances details

Generic StanzaError Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep StanzaError :: Type -> Type # Methods from :: StanzaError -> Rep StanzaError x # to :: Rep StanzaError x -> StanzaError #
Show StanzaError Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> StanzaError -> ShowS # show :: StanzaError -> String # showList :: [StanzaError] -> ShowS #
Eq StanzaError Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: StanzaError -> StanzaError -> Bool # (/=) :: StanzaError -> StanzaError -> Bool #
type Rep StanzaError Source #
Instance details Defined in Network.Xmpp.Types type Rep StanzaError = D1 ('MetaData "StanzaError" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "StanzaError" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stanzaErrorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StanzaErrorType) :: S1 ('MetaSel ('Just "stanzaErrorCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StanzaErrorCondition)) :: (S1 ('MetaSel ('Just "stanzaErrorText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe LangTag, NonemptyText))) :*: S1 ('MetaSel ('Just "stanzaErrorApplicationSpecificCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Element)))))

data StanzaErrorCondition Source #

Stanza errors are accommodated with one of the error conditions listed below.

Constructors

BadRequest	Malformed XML.
Conflict	Resource or session with name already exists.
FeatureNotImplemented
Forbidden	Insufficient permissions.
Gone (Maybe NonemptyText)	Entity can no longer be contacted at this address.
InternalServerError
ItemNotFound
JidMalformed
NotAcceptable	Does not meet policy criteria.
NotAllowed	No entity may perform this action.
NotAuthorized	Must provide proper credentials.
PolicyViolation	The entity has violated some local service policy (e.g., a message contains words that are prohibited by the service)
RecipientUnavailable	Temporarily unavailable.
Redirect (Maybe NonemptyText)	Redirecting to other entity, usually temporarily.
RegistrationRequired
RemoteServerNotFound
RemoteServerTimeout
ResourceConstraint	Entity lacks the necessary system resources.
ServiceUnavailable
SubscriptionRequired
UndefinedCondition	Application-specific condition.
UnexpectedRequest	Badly timed request.

Instances

Instances details

Generic StanzaErrorCondition Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep StanzaErrorCondition :: Type -> Type # Methods from :: StanzaErrorCondition -> Rep StanzaErrorCondition x # to :: Rep StanzaErrorCondition x -> StanzaErrorCondition #
Read StanzaErrorCondition Source #
Instance details Defined in Network.Xmpp.Types Methods readsPrec :: Int -> ReadS StanzaErrorCondition # readList :: ReadS [StanzaErrorCondition] # readPrec :: ReadPrec StanzaErrorCondition # readListPrec :: ReadPrec [StanzaErrorCondition] #
Show StanzaErrorCondition Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> StanzaErrorCondition -> ShowS # show :: StanzaErrorCondition -> String # showList :: [StanzaErrorCondition] -> ShowS #
Eq StanzaErrorCondition Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: StanzaErrorCondition -> StanzaErrorCondition -> Bool # (/=) :: StanzaErrorCondition -> StanzaErrorCondition -> Bool #
type Rep StanzaErrorCondition Source #
Instance details Defined in Network.Xmpp.Types type Rep StanzaErrorCondition = D1 ('MetaData "StanzaErrorCondition" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) ((((C1 ('MetaCons "BadRequest" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Conflict" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "FeatureNotImplemented" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Forbidden" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Gone" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe NonemptyText)))))) :+: ((C1 ('MetaCons "InternalServerError" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ItemNotFound" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "JidMalformed" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "NotAcceptable" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NotAllowed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotAuthorized" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "PolicyViolation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RecipientUnavailable" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Redirect" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe NonemptyText))) :+: (C1 ('MetaCons "RegistrationRequired" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RemoteServerNotFound" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "RemoteServerTimeout" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ResourceConstraint" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ServiceUnavailable" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "SubscriptionRequired" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UndefinedCondition" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UnexpectedRequest" 'PrefixI 'False) (U1 :: Type -> Type))))))

data StanzaErrorType Source #

StanzaErrors always have one of these types.

Constructors

Cancel	Error is unrecoverable - do not retry
Continue	Conditition was a warning - proceed
Modify	Change the data and retry
Auth	Provide credentials and retry
Wait	Error is temporary - wait and retry

Instances

Instances details

Generic StanzaErrorType Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep StanzaErrorType :: Type -> Type # Methods from :: StanzaErrorType -> Rep StanzaErrorType x # to :: Rep StanzaErrorType x -> StanzaErrorType #
Read StanzaErrorType Source #
Instance details Defined in Network.Xmpp.Types Methods readsPrec :: Int -> ReadS StanzaErrorType # readList :: ReadS [StanzaErrorType] # readPrec :: ReadPrec StanzaErrorType # readListPrec :: ReadPrec [StanzaErrorType] #
Show StanzaErrorType Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> StanzaErrorType -> ShowS # show :: StanzaErrorType -> String # showList :: [StanzaErrorType] -> ShowS #
Eq StanzaErrorType Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: StanzaErrorType -> StanzaErrorType -> Bool # (/=) :: StanzaErrorType -> StanzaErrorType -> Bool #
type Rep StanzaErrorType Source #
Instance details Defined in Network.Xmpp.Types type Rep StanzaErrorType = D1 ('MetaData "StanzaErrorType" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) ((C1 ('MetaCons "Cancel" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Continue" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Modify" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Auth" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Wait" 'PrefixI 'False) (U1 :: Type -> Type))))

data XmppFailure Source #

Signals an XMPP stream error or another unpredicted stream-related situation. This error is fatal, and closes the XMPP stream.

Constructors

StreamErrorFailure StreamErrorInfo	An error XML stream element has been encountered.
StreamEndFailure	The stream has been closed. This exception is caught by the concurrent implementation, and will thus not be visible through use of `Session`.
StreamCloseError ([Element], XmppFailure)	When an XmppFailure is encountered in closeStreams, this constructor wraps the elements collected so far.
TcpConnectionFailure	All attempts to TCP connect to the server failed.
XmppIllegalTcpDetails	The TCP details provided did not validate.
TlsError XmppTlsError	An error occurred in the TLS layer
TlsNoServerSupport	The server does not support the use of TLS
XmppNoStream	An action that required an active stream were performed when the `StreamState` was `Closed`
XmppAuthFailure AuthFailure	Authentication with the server failed (unrecoverably)
TlsStreamSecured	Connection already secured
XmppOtherFailure	Undefined condition. More information should be available in the log.
XmppIOException IOException	An `IOException` occurred
XmppInvalidXml String	Received data is not valid XML

Instances

Instances details

Exception XmppFailure Source #
Instance details Defined in Network.Xmpp.Types Methods toException :: XmppFailure -> SomeException # fromException :: SomeException -> Maybe XmppFailure # displayException :: XmppFailure -> String #
Generic XmppFailure Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep XmppFailure :: Type -> Type # Methods from :: XmppFailure -> Rep XmppFailure x # to :: Rep XmppFailure x -> XmppFailure #
Show XmppFailure Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> XmppFailure -> ShowS # show :: XmppFailure -> String # showList :: [XmppFailure] -> ShowS #
Eq XmppFailure Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: XmppFailure -> XmppFailure -> Bool # (/=) :: XmppFailure -> XmppFailure -> Bool #
type Rep XmppFailure Source #
Instance details Defined in Network.Xmpp.Types type Rep XmppFailure = D1 ('MetaData "XmppFailure" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (((C1 ('MetaCons "StreamErrorFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StreamErrorInfo)) :+: (C1 ('MetaCons "StreamEndFailure" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StreamCloseError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ([Element], XmppFailure))))) :+: (C1 ('MetaCons "TcpConnectionFailure" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "XmppIllegalTcpDetails" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TlsError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 XmppTlsError))))) :+: ((C1 ('MetaCons "TlsNoServerSupport" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "XmppNoStream" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "XmppAuthFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthFailure)))) :+: ((C1 ('MetaCons "TlsStreamSecured" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "XmppOtherFailure" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "XmppIOException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IOException)) :+: C1 ('MetaCons "XmppInvalidXml" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))))

data XmppTlsError Source #

Constructors

XmppTlsError TLSError
XmppTlsException TLSException

Instances

Instances details

Generic XmppTlsError Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep XmppTlsError :: Type -> Type # Methods from :: XmppTlsError -> Rep XmppTlsError x # to :: Rep XmppTlsError x -> XmppTlsError #
Show XmppTlsError Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> XmppTlsError -> ShowS # show :: XmppTlsError -> String # showList :: [XmppTlsError] -> ShowS #
Eq XmppTlsError Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: XmppTlsError -> XmppTlsError -> Bool # (/=) :: XmppTlsError -> XmppTlsError -> Bool #
type Rep XmppTlsError Source #
Instance details Defined in Network.Xmpp.Types type Rep XmppTlsError = D1 ('MetaData "XmppTlsError" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "XmppTlsError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TLSError)) :+: C1 ('MetaCons "XmppTlsException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TLSException)))

data StreamErrorCondition Source #

Constructors

StreamBadFormat	The entity has sent XML that cannot be processed.
StreamBadNamespacePrefix	The entity has sent a namespace prefix that is unsupported, or has sent no namespace prefix on an element that needs such a prefix
StreamConflict	The server either (1) is closing the existing stream for this entity because a new stream has been initiated that conflicts with the existing stream, or (2) is refusing a new stream for this entity because allowing the new stream would conflict with an existing stream (e.g., because the server allows only a certain number of connections from the same IP address or allows only one server-to-server stream for a given domain pair as a way of helping to ensure in-order processing
StreamConnectionTimeout	One party is closing the stream because it has reason to believe that the other party has permanently lost the ability to communicate over the stream.
StreamHostGone	The value of the `to` attribute provided in the initial stream header corresponds to an FQDN that is no longer serviced by the receiving entity
StreamHostUnknown	The value of the `to` attribute provided in the initial stream header does not correspond to an FQDN that is serviced by the receiving entity.
StreamImproperAddressing	A stanza sent between two servers lacks a `to` or `from` attribute, the `from` or `to` attribute has no value, or the value violates the rules for XMPP addresses
StreamInternalServerError	The server has experienced a misconfiguration or other internal error that prevents it from servicing the stream.
StreamInvalidFrom	The data provided in a `from` attribute does not match an authorized JID or validated domain as negotiated (1) between two servers using SASL or Server Dialback, or (2) between a client and a server via SASL authentication and resource binding.
StreamInvalidNamespace	The stream namespace name is something other than "http:/etherx.jabber.orgstreams" (see Section 11.2) or the content namespace declared as the default namespace is not supported (e.g., something other than "jabber:client" or "jabber:server").
StreamInvalidXml	The entity has sent invalid XML over the stream to a server that performs validation
StreamNotAuthorized	The entity has attempted to send XML stanzas or other outbound data before the stream has been authenticated, or otherwise is not authorized to perform an action related to stream negotiation; the receiving entity MUST NOT process the offending data before sending the stream error.
StreamNotWellFormed	The initiating entity has sent XML that violates the well-formedness rules of [XML] or [XML‑NAMES].
StreamPolicyViolation	The entity has violated some local service policy (e.g., a stanza exceeds a configured size limit); the server MAY choose to specify the policy in the <text/> element or in an application-specific condition element.
StreamRemoteConnectionFailed	The server is unable to properly connect to a remote entity that is needed for authentication or authorization (e.g., in certain scenarios related to Server Dialback [XEP‑0220]); this condition is not to be used when the cause of the error is within the administrative domain of the XMPP service provider, in which case the <internal-server-error /> condition is more appropriate.
StreamReset	The server is closing the stream because it has new (typically security-critical) features to offer, because the keys or certificates used to establish a secure context for the stream have expired or have been revoked during the life of the stream , because the TLS sequence number has wrapped, etc. The reset applies to the stream and to any security context established for that stream (e.g., via TLS and SASL), which means that encryption and authentication need to be negotiated again for the new stream (e.g., TLS session resumption cannot be used)
StreamResourceConstraint	The server lacks the system resources necessary to service the stream.
StreamRestrictedXml	he entity has attempted to send restricted XML features such as a comment, processing instruction, DTD subset, or XML entity reference
StreamSeeOtherHost	The server will not provide service to the initiating entity but is redirecting traffic to another host under the administrative control of the same service provider.
StreamSystemShutdown	The server is being shut down and all active streams are being closed.
StreamUndefinedCondition	The error condition is not one of those defined by the other conditions in this list
StreamUnsupportedEncoding	The initiating entity has encoded the stream in an encoding that is not supported by the server or has otherwise improperly encoded the stream (e.g., by violating the rules of the [UTF‑8] encoding).
StreamUnsupportedFeature	The receiving entity has advertised a mandatory-to-negotiate stream feature that the initiating entity does not support, and has offered no other mandatory-to-negotiate feature alongside the unsupported feature.
StreamUnsupportedStanzaType	The initiating entity has sent a first-level child of the stream that is not supported by the server, either because the receiving entity does not understand the namespace or because the receiving entity does not understand the element name for the applicable namespace (which might be the content namespace declared as the default namespace)
StreamUnsupportedVersion	The `version` attribute provided by the initiating entity in the stream header specifies a version of XMPP that is not supported by the server.

Instances

Instances details

Generic StreamErrorCondition Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep StreamErrorCondition :: Type -> Type # Methods from :: StreamErrorCondition -> Rep StreamErrorCondition x # to :: Rep StreamErrorCondition x -> StreamErrorCondition #
Read StreamErrorCondition Source #
Instance details Defined in Network.Xmpp.Types Methods readsPrec :: Int -> ReadS StreamErrorCondition # readList :: ReadS [StreamErrorCondition] # readPrec :: ReadPrec StreamErrorCondition # readListPrec :: ReadPrec [StreamErrorCondition] #
Show StreamErrorCondition Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> StreamErrorCondition -> ShowS # show :: StreamErrorCondition -> String # showList :: [StreamErrorCondition] -> ShowS #
Eq StreamErrorCondition Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: StreamErrorCondition -> StreamErrorCondition -> Bool # (/=) :: StreamErrorCondition -> StreamErrorCondition -> Bool #
type Rep StreamErrorCondition Source #
Instance details Defined in Network.Xmpp.Types type Rep StreamErrorCondition = D1 ('MetaData "StreamErrorCondition" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) ((((C1 ('MetaCons "StreamBadFormat" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "StreamBadNamespacePrefix" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StreamConflict" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "StreamConnectionTimeout" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "StreamHostGone" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StreamHostUnknown" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "StreamImproperAddressing" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "StreamInternalServerError" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StreamInvalidFrom" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "StreamInvalidNamespace" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "StreamInvalidXml" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StreamNotAuthorized" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "StreamNotWellFormed" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "StreamPolicyViolation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StreamRemoteConnectionFailed" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "StreamReset" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "StreamResourceConstraint" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StreamRestrictedXml" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "StreamSeeOtherHost" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "StreamSystemShutdown" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StreamUndefinedCondition" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "StreamUnsupportedEncoding" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StreamUnsupportedFeature" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "StreamUnsupportedStanzaType" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StreamUnsupportedVersion" 'PrefixI 'False) (U1 :: Type -> Type))))))

data Version Source #

XMPP version number. Displayed as "<major>.<minor>". 2.4 is lesser than 2.13, which in turn is lesser than 12.3.

Constructors

Version
Fields majorVersion :: !Integer minorVersion :: !Integer

Instances

Instances details

Generic Version Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep Version :: Type -> Type # Methods from :: Version -> Rep Version x # to :: Rep Version x -> Version #
Read Version Source #
Instance details Defined in Network.Xmpp.Types Methods readsPrec :: Int -> ReadS Version # readList :: ReadS [Version] # readPrec :: ReadPrec Version # readListPrec :: ReadPrec [Version] #
Show Version Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
Eq Version Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Ord Version Source #
Instance details Defined in Network.Xmpp.Types Methods compare :: Version -> Version -> Ordering # (<) :: Version -> Version -> Bool # (<=) :: Version -> Version -> Bool # (>) :: Version -> Version -> Bool # (>=) :: Version -> Version -> Bool # max :: Version -> Version -> Version # min :: Version -> Version -> Version #
type Rep Version Source #
Instance details Defined in Network.Xmpp.Types type Rep Version = D1 ('MetaData "Version" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "Version" 'PrefixI 'True) (S1 ('MetaSel ('Just "majorVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "minorVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Integer)))

versionFromText :: Text -> Maybe Version Source #

data StreamHandle Source #

Defines operations for sending, receiving, flushing, and closing on a stream.

Constructors

StreamHandle
Fields streamSend :: ByteString -> IO (Either XmppFailure ()) Sends may not interleave streamReceive :: Int -> IO (Either XmppFailure ByteString) streamFlush :: IO () streamClose :: IO ()

newtype Stream Source #

Constructors

Stream
Fields unStream :: TMVar StreamState

data StreamState Source #

Constructors

StreamState

Fields

streamConnectionState :: !ConnectionState
State of the stream - Closed, Plain, or Secured
streamHandle :: StreamHandle
Functions to send, receive, flush, and close the stream
streamEventSource :: ConduitT () Event (ExceptT XmppFailure IO) ()
Event conduit source, and its associated finalizer
streamFeatures :: !StreamFeatures
Stream features advertised by the server
streamAddress :: !(Maybe Text)
The hostname or IP specified for the connection
streamFrom :: !(Maybe Jid)
The hostname specified in the server's stream element's from attribute
streamId :: !(Maybe Text)
The identifier specified in the server's stream element's id attribute
streamLang :: !(Maybe LangTag)
The language tag value specified in the server's stream element's langtag attribute; will be a Just value once connected to the server TODO: Verify
streamJid :: !(Maybe Jid)
Our JID as assigned by the server
streamConfiguration :: StreamConfiguration
Configuration settings for the stream

data ConnectionState Source #

Signals the state of the stream connection.

Constructors

Closed	Stream has not been established yet
Plain	Stream established, but not secured via TLS
Secured	Stream established and secured via TLS
Finished	Stream was closed

Instances

Instances details

Generic ConnectionState Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep ConnectionState :: Type -> Type # Methods from :: ConnectionState -> Rep ConnectionState x # to :: Rep ConnectionState x -> ConnectionState #
Show ConnectionState Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> ConnectionState -> ShowS # show :: ConnectionState -> String # showList :: [ConnectionState] -> ShowS #
Eq ConnectionState Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: ConnectionState -> ConnectionState -> Bool # (/=) :: ConnectionState -> ConnectionState -> Bool #
type Rep ConnectionState Source #
Instance details Defined in Network.Xmpp.Types type Rep ConnectionState = D1 ('MetaData "ConnectionState" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) ((C1 ('MetaCons "Closed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Plain" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Secured" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Finished" 'PrefixI 'False) (U1 :: Type -> Type)))

data StreamErrorInfo Source #

Encapsulates information about an XMPP stream error.

Constructors

StreamErrorInfo
Fields errorCondition :: !StreamErrorCondition errorText :: !(Maybe (Maybe LangTag, NonemptyText)) errorXml :: !(Maybe Element)

Instances

Instances details

Generic StreamErrorInfo Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep StreamErrorInfo :: Type -> Type # Methods from :: StreamErrorInfo -> Rep StreamErrorInfo x # to :: Rep StreamErrorInfo x -> StreamErrorInfo #
Show StreamErrorInfo Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> StreamErrorInfo -> ShowS # show :: StreamErrorInfo -> String # showList :: [StreamErrorInfo] -> ShowS #
Eq StreamErrorInfo Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: StreamErrorInfo -> StreamErrorInfo -> Bool # (/=) :: StreamErrorInfo -> StreamErrorInfo -> Bool #
type Rep StreamErrorInfo Source #
Instance details Defined in Network.Xmpp.Types type Rep StreamErrorInfo = D1 ('MetaData "StreamErrorInfo" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) (C1 ('MetaCons "StreamErrorInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCondition") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StreamErrorCondition) :: (S1 ('MetaSel ('Just "errorText") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (Maybe LangTag, NonemptyText))) :: S1 ('MetaSel ('Just "errorXml") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Element)))))

data ConnectionDetails Source #

Specify the method with which the connection is (re-)established

Constructors

UseRealm	Use realm to resolv host. This is the default.
UseSrv HostName	Use this hostname for a SRV lookup
UseHost HostName PortNumber	Use specified host
UseConnection (ExceptT XmppFailure IO StreamHandle)	Use a custom method to create a StreamHandle. This will also be used by reconnect. For example, to establish TLS before starting the stream as done by GCM, see `connectTls`. You can also return an already established connection. This method should also return a hostname that is used for TLS signature verification. If startTLS is not used it can be left empty

data StreamConfiguration Source #

Configuration settings related to the stream.

Constructors

StreamConfiguration

Fields

preferredLang :: !(Maybe LangTag)
Default language when no language tag is set
toJid :: !(Maybe (Jid, Bool))
JID to include in the stream element's to attribute when the connection is secured; if the boolean is set to True, then the JID is also included when the ConnectionState is Plain
connectionDetails :: ConnectionDetails
By settings this field, clients can specify the network interface to use, override the SRV lookup of the realm, as well as specify the use of a non-standard port when connecting by IP or connecting to a domain without SRV records.
resolvConf :: ResolvConf
DNS resolver configuration
tlsBehaviour :: TlsBehaviour
Whether or not to perform the legacy session bind as defined in the (outdated) RFC 3921 specification
tlsParams :: ClientParams
Settings to be used for TLS negotitation

Instances

Instances details

Default StreamConfiguration Source #
Instance details Defined in Network.Xmpp.Types Methods def :: StreamConfiguration #

xmppDefaultParams :: ClientParams Source #

Default parameters for TLS ciphersuite_all can be used to allow insecure ciphers

xmppDefaultParamsStrong :: ClientParams Source #

Default parameters for TLS restricted to strong ciphers

data Jid Source #

A JID is XMPP's native format for addressing entities in the network. It is somewhat similar to an e-mail address but contains three parts instead of two: localpart, domainpart, and resourcepart.

The localpart of a JID is an optional identifier placed before the domainpart and separated from the latter by a '@' character. Typically a localpart uniquely identifies the entity requesting and using network access provided by a server (i.e., a local account), although it can also represent other kinds of entities (e.g., a chat room associated with a multi-user chat service). The entity represented by an XMPP localpart is addressed within the context of a specific domain (i.e., localpart@domainpart).

The domainpart typically identifies the home server to which clients connect for XML routing and data management functionality. However, it is not necessary for an XMPP domainpart to identify an entity that provides core XMPP server functionality (e.g., a domainpart can identify an entity such as a multi-user chat service, a publish-subscribe service, or a user directory).

The resourcepart of a JID is an optional identifier placed after the domainpart and separated from the latter by the '/' character. A resourcepart can modify either a localpart@domainpart address or a mere domainpart address. Typically a resourcepart uniquely identifies a specific connection (e.g., a device or location) or object (e.g., an occupant in a multi-user chat room) belonging to the entity associated with an XMPP localpart at a domain (i.e., localpart@domainpart/resourcepart).

For more details see RFC 6122 http://xmpp.org/rfcs/rfc6122.html

Constructors

Jid
Fields localpart_ :: !(Maybe NonemptyText) domainpart_ :: !NonemptyText resourcepart_ :: !(Maybe NonemptyText)

Instances

Instances details

Read Jid Source #
Instance details Defined in Network.Xmpp.Types Methods readsPrec :: Int -> ReadS Jid # readList :: ReadS [Jid] # readPrec :: ReadPrec Jid # readListPrec :: ReadPrec [Jid] #
Show Jid Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> Jid -> ShowS # show :: Jid -> String # showList :: [Jid] -> ShowS #
Eq Jid Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: Jid -> Jid -> Bool # (/=) :: Jid -> Jid -> Bool #
Ord Jid Source #
Instance details Defined in Network.Xmpp.Types Methods compare :: Jid -> Jid -> Ordering # (<) :: Jid -> Jid -> Bool # (<=) :: Jid -> Jid -> Bool # (>) :: Jid -> Jid -> Bool # (>=) :: Jid -> Jid -> Bool # max :: Jid -> Jid -> Jid # min :: Jid -> Jid -> Jid #
Lift Jid Source #
Instance details Defined in Network.Xmpp.Types Methods lift :: Quote m => Jid -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Jid -> Code m Jid #

jidQ :: QuasiQuoter Source #

Synonym for jid

jid :: QuasiQuoter Source #

Constructs and validates a Jid at compile time.

Syntax: [jid|localpart@domainpart/resourcepart|]

>>> [jid|foo@bar/quux|]
parseJid "foo@bar/quux"

>>> Just [jid|foo@bar/quux|] == jidFromTexts (Just "foo") "bar" (Just "quux")
True

>>> Just [jid|foo@bar/quux|] == jidFromText "foo@bar/quux"
True

Instances

Instances details

Generic TlsBehaviour Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep TlsBehaviour :: Type -> Type # Methods from :: TlsBehaviour -> Rep TlsBehaviour x # to :: Rep TlsBehaviour x -> TlsBehaviour #
Show TlsBehaviour Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> TlsBehaviour -> ShowS # show :: TlsBehaviour -> String # showList :: [TlsBehaviour] -> ShowS #
Eq TlsBehaviour Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: TlsBehaviour -> TlsBehaviour -> Bool # (/=) :: TlsBehaviour -> TlsBehaviour -> Bool #
type Rep TlsBehaviour Source #
Instance details Defined in Network.Xmpp.Types type Rep TlsBehaviour = D1 ('MetaData "TlsBehaviour" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) ((C1 ('MetaCons "RequireTls" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PreferTls" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PreferPlain" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RefuseTls" 'PrefixI 'False) (U1 :: Type -> Type)))

data AuthFailure Source #

Signals a SASL authentication error condition.

Constructors

AuthNoAcceptableMechanism [Text]	No mechanism offered by the server was matched by the provided acceptable mechanisms; wraps the mechanisms offered by the server
AuthStreamFailure XmppFailure
AuthSaslFailure SaslFailure	A SASL failure element was encountered
AuthIllegalCredentials	The credentials provided did not conform to the SASLprep Stringprep profile
AuthOtherFailure	Other failure; more information is available in the log

Instances

Instances details

Generic AuthFailure Source #
Instance details Defined in Network.Xmpp.Types Associated Types type Rep AuthFailure :: Type -> Type # Methods from :: AuthFailure -> Rep AuthFailure x # to :: Rep AuthFailure x -> AuthFailure #
Show AuthFailure Source #
Instance details Defined in Network.Xmpp.Types Methods showsPrec :: Int -> AuthFailure -> ShowS # show :: AuthFailure -> String # showList :: [AuthFailure] -> ShowS #
Eq AuthFailure Source #
Instance details Defined in Network.Xmpp.Types Methods (==) :: AuthFailure -> AuthFailure -> Bool # (/=) :: AuthFailure -> AuthFailure -> Bool #
type Rep AuthFailure Source #
Instance details Defined in Network.Xmpp.Types type Rep AuthFailure = D1 ('MetaData "AuthFailure" "Network.Xmpp.Types" "pontarius-xmpp-0.5.6.8-E7Eo7yzJScdK4Fm8Il5mrG" 'False) ((C1 ('MetaCons "AuthNoAcceptableMechanism" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])) :+: C1 ('MetaCons "AuthStreamFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 XmppFailure))) :+: (C1 ('MetaCons "AuthSaslFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SaslFailure)) :+: (C1 ('MetaCons "AuthIllegalCredentials" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AuthOtherFailure" 'PrefixI 'False) (U1 :: Type -> Type))))

openElementToEvents :: Element -> [Event] Source #

renderOpenElement :: Element -> ByteString Source #

renderElement :: Element -> ByteString Source #

checkHostName :: Text -> Maybe Text Source #

Validates the hostname string in accordance with RFC 1123.

withTMVar :: TMVar a -> (a -> IO (c, a)) -> IO c Source #

Apply f with the content of tv as state, restoring the original value when an exception occurs

RequireTls	Require the use of TLS; disconnect if it's not offered.
PreferTls	Negotitate TLS if it's available.
PreferPlain	Negotitate TLS only if the server requires it
RefuseTls	Never secure the stream with TLS.