Network.XMPP.Stream

An XMPP stream: means to create and use one

Documentation

class XmppSendable t a where

Sends message into Stream

Methods

xmppSend :: Monad t => a -> t ()

Instances

MonadIO m => XmppSendable (XmppMonad m) Node

Defined in Network.XMPP.Stream

Methods

xmppSend :: Node -> XmppMonad m ()

MonadIO m => XmppSendable (XmppMonad m) (Content Posn)

Defined in Network.XMPP.Stream

Methods

xmppSend :: Content Posn -> XmppMonad m ()

MonadIO m => XmppSendable (XmppMonad m) (Stanza t 'Outgoing e)

Defined in Network.XMPP.Stream

Methods

xmppSend :: Stanza t 'Outgoing e -> XmppMonad m ()

MonadIO m => XmppSendable (ReaderT (Thread e) m) (Stanza t 'Outgoing ())

Defined in Network.XMPP.Concurrent

Methods

xmppSend :: Stanza t 'Outgoing () -> ReaderT (Thread e) m ()

data Plugin

Constructors

Plugin

Fields

• trigger :: String
• body :: Content Posn -> XmppMonad IO ()

data XmppError

Constructors

StreamClosedError

MessageParseError Text Text

NonSupportedAuthMechanisms [Text] Text

AuthError Text

RanOutOfInput

UnknownVersion Text

UnknownError Text

Instances

Eq XmppError

Defined in Network.XMPP.Stream

Methods

(==) :: XmppError -> XmppError -> Bool

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

Show XmppError

Defined in Network.XMPP.Stream

Methods

showsPrec :: Int -> XmppError -> ShowS

show :: XmppError -> String

showList :: [XmppError] -> ShowS

startM :: MonadIO m => XmppMonad m (Either XmppError [Attribute])

startM is a special accessor case, since it has to retrieve only opening tag of the 'stream' message, which encloses the whole XMPP stream. That's why it does it's own parsing, and does not rely on nextM

nextM :: MonadIO m => XmppMonad m (Either XmppError (Content Posn))

Selects next messages from stream

withNextM :: MonadIO m => (Content Posn -> b) -> XmppMonad m (Either XmppError b)

selectM :: MonadIO m => (Content Posn -> Bool) -> XmppMonad m (Either XmppError (Content Posn))

Selects next message matching predicate

xtractM :: MonadIO m => Text -> XmppMonad m [Content Posn]

Pass in xtract query, return query result from the first message where it returns non-empty results

textractM :: MonadIO m => Text -> XmppMonad m Text

withSelectM :: MonadIO m => (Content Posn -> Bool) -> (Content Posn -> b) -> XmppMonad m (Either XmppError b)

resetStreamHandle :: (MonadIO m, MonadState Stream m) => Handle -> m ()

Replaces contents of the Stream with the contents coming from given handle.

getText :: Content i -> Text

getText_ :: [Content i] -> Text

loopWithPlugins :: [Plugin] -> XmppMonad IO (Either Text ())

getNextId :: MonadIO m => XmppMonad m Int

parse :: forall l e. (Alternative l, FromXML e) => Content Posn -> l (SomeStanza e)

Parses XML element producing Stanza

parseM :: (FromXML e, MonadIO m) => XmppMonad m (Either XmppError (SomeStanza e))

Gets next message from stream and parses it | We shall skip over unknown messages, rather than crashing

waitAndProcess :: (FromXML e, MonadIO m) => (SomeStanza e -> Maybe a) -> XmppMonad m (Either XmppError a)

Skips all messages, that will return result Nothing from computation | In other words - waits for appropriate message, defined by predicate

withUUID :: MonadIO m => (UUID -> Stanza t p e) -> m (Stanza t p e)