Network.Xmpp.Internal

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.

Documentation

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

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 ()

Executes a function to update the event handlers.

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

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 ()

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

Run an event handler.

endSession :: Session -> IO ()

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 ()

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

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

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 ()

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

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

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

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

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

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

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

Send a stanza to the server, managed by plugins

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

Get the channel of incoming stanzas.

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

Get the next incoming stanza

dupSession :: Session -> IO Session

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)

Return the JID assigned to us by the server

getFeatures :: Session -> IO StreamFeatures

Return the stream features the server announced

waitForStream :: Session -> IO ()

Wait until the connection of the stream is re-established

streamState :: Session -> STM ConnectionState

type StanzaHandler

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

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

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

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

(Typeable f, Show f) => Annotation

Fields

• fromAnnotation :: f

Instances

Show Annotation

Methods

showsPrec :: Int -> Annotation -> ShowS

show :: Annotation -> String

showList :: [Annotation] -> ShowS

type Annotated a = (a, [Annotation])

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

Retrieve the first matching annotation

data Plugin'

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

Arguments

 = (XmppElement -> IO (Either XmppFailure ()))

pass stanza to next plugin

-> ErrorT XmppFailure IO Plugin'

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

data SessionConfiguration

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

Default SessionConfiguration

Methods

def :: SessionConfiguration

data EventHandlers

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

Constructors

EventHandlers

Fields

• connectionClosedHandler :: XmppFailure -> IO ()

data Interrupt

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

Show Interrupt

Methods

showsPrec :: Int -> Interrupt -> ShowS

show :: Interrupt -> String

showList :: [Interrupt] -> ShowS

Exception Interrupt

Methods

toException :: Interrupt -> SomeException

fromException :: SomeException -> Maybe Interrupt

displayException :: Interrupt -> String

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

data Session

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))))

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

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

Error that can occur during sendIQ'

Constructors

IQSendError XmppFailure

IQTimeOut

Instances

Eq IQSendError

Methods

(==) :: IQSendError -> IQSendError -> Bool

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

Show IQSendError

Methods

showsPrec :: Int -> IQSendError -> ShowS

show :: IQSendError -> String

showList :: [IQSendError] -> ShowS

Exception IQSendError

Methods

toException :: IQSendError -> SomeException

fromException :: SomeException -> Maybe IQSendError

displayException :: IQSendError -> String

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

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)

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)

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

getMessage :: Session -> IO Message

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

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

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

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)

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

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))

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)

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 ())

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

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

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)

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)

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

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 ())

Send a presence stanza.

sendIQ

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))

Like sendIQ, but waits for the answer IQ.

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

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

listenIQ

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

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 ()))

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

Minimal complete definition

pickleRequest, pickleResponse, requestType, requestNamespace

Associated Types

data IQResponseType a

Methods

pickleRequest :: PU Element a

pickleResponse :: PU [Element] (IQResponseType a)

requestType :: a -> IQRequestType

requestNamespace :: a -> Text

data IQRequestError

Constructors

IQRequestSendError XmppFailure

IQRequestTimeout

IQRequestUnpickleError UnpickleError

Instances

Show IQRequestError

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))

Send an IQ request. May throw IQSendError, UnpickleError,

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)

Creates and initializes a new Xmpp context.

session

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

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

reconnect

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'

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

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

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 ())

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

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

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

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

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

Send a stanza to the server, managed by plugins

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

Get the channel of incoming stanzas.

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

Get the next incoming stanza

dupSession :: Session -> IO Session

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)

Return the JID assigned to us by the server

getFeatures :: Session -> IO StreamFeatures

Return the stream features the server announced

waitForStream :: Session -> IO ()

Wait until the connection of the stream is re-established

streamState :: Session -> STM ConnectionState

sendIQ

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))

Like sendIQ, but waits for the answer IQ.

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

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

listenIQ

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

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 ()))

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

Minimal complete definition

pickleRequest, pickleResponse, requestType, requestNamespace

Associated Types

data IQResponseType a

Methods

pickleRequest :: PU Element a

pickleResponse :: PU [Element] (IQResponseType a)

requestType :: a -> IQRequestType

requestNamespace :: a -> Text

data IQRequestError

Constructors

IQRequestSendError XmppFailure

IQRequestTimeout

IQRequestUnpickleError UnpickleError

Instances

Show IQRequestError

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))

Send an IQ request. May throw IQSendError, UnpickleError,

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

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

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

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)

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)

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

getMessage :: Session -> IO Message

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

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

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

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)

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

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))

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)

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 ())

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

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

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 ()

Executes a function to update the event handlers.

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

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 ()

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

Run an event handler.

endSession :: Session -> IO ()

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 ()

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))

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)

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)

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

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 ())

Send a presence stanza.

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))

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 ()

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

type StanzaHandler

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

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

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

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

(Typeable f, Show f) => Annotation

Fields

• fromAnnotation :: f

Instances

Show Annotation

Methods

showsPrec :: Int -> Annotation -> ShowS

show :: Annotation -> String

showList :: [Annotation] -> ShowS

type Annotated a = (a, [Annotation])

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

Retrieve the first matching annotation

data Plugin'

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

Arguments

 = (XmppElement -> IO (Either XmppFailure ()))

pass stanza to next plugin

-> ErrorT XmppFailure IO Plugin'

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

data SessionConfiguration

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

Default SessionConfiguration

Methods

def :: SessionConfiguration

data EventHandlers

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

Constructors

EventHandlers

Fields

• connectionClosedHandler :: XmppFailure -> IO ()

data Interrupt

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

Show Interrupt

Methods

showsPrec :: Int -> Interrupt -> ShowS

show :: Interrupt -> String

showList :: [Interrupt] -> ShowS

Exception Interrupt

Methods

toException :: Interrupt -> SomeException

fromException :: SomeException -> Maybe Interrupt

displayException :: Interrupt -> String

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

data Session

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))))

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

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

Error that can occur during sendIQ'

Constructors

IQSendError XmppFailure

IQTimeOut

Instances

Eq IQSendError

Methods

(==) :: IQSendError -> IQSendError -> Bool

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

Show IQSendError

Methods

showsPrec :: Int -> IQSendError -> ShowS

show :: IQSendError -> String

showList :: [IQSendError] -> ShowS

Exception IQSendError

Methods

toException :: IQSendError -> SomeException

fromException :: SomeException -> Maybe IQSendError

displayException :: IQSendError -> String

data MessageBody

Constructors

MessageBody

Fields

• bodyLang :: Maybe LangTag
• bodyContent :: Text

data MessageThread

Constructors

MessageThread

Fields

• threadID :: Text
• threadParent :: Maybe Text

data MessageSubject

Constructors

MessageSubject

Fields

• subjectLang :: Maybe LangTag
• subjectContent :: Text

data InstantMessage

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

Constructors

InstantMessage

Fields

• imThread :: Maybe MessageThread
• imSubject :: [MessageSubject]
• imBody :: [MessageBody]

Instances

Default InstantMessage

Methods

def :: InstantMessage

instantMessage :: InstantMessage

Empty instant message.

getIM :: Message -> Maybe InstantMessage

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

sanitizeIM :: InstantMessage -> InstantMessage

withIM :: Message -> InstantMessage -> Message

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

imToElements :: InstantMessage -> [Element]

simpleIM

Arguments

:: Jid

recipient

-> Text

body

-> Message

Generate a simple message

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

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

xpMessageSubject :: PU [Element] [MessageSubject]

xpMessageBody :: PU [Element] [MessageBody]

xpMessageThread :: PU [Element] (Maybe MessageThread)

data ShowStatus

Constructors

StatusAway

StatusChat

StatusDnd

StatusXa

Instances

Eq ShowStatus

Methods

(==) :: ShowStatus -> ShowStatus -> Bool

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

Read ShowStatus

Methods

readsPrec :: Int -> ReadS ShowStatus

readList :: ReadS [ShowStatus]

readPrec :: ReadPrec ShowStatus

readListPrec :: ReadPrec [ShowStatus]

Show ShowStatus

Methods

showsPrec :: Int -> ShowStatus -> ShowS

show :: ShowStatus -> String

showList :: [ShowStatus] -> ShowS

data IMPresence

Constructors

IMP

Fields

• showStatus :: Maybe ShowStatus
• status :: Maybe Text
• priority :: Maybe Int

Instances

Eq IMPresence

Methods

(==) :: IMPresence -> IMPresence -> Bool

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

Show IMPresence

Methods

showsPrec :: Int -> IMPresence -> ShowS

show :: IMPresence -> String

showList :: [IMPresence] -> ShowS

Default IMPresence

Methods

def :: IMPresence

imPresence :: IMPresence

getIMPresence :: Presence -> Maybe IMPresence

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

withIMPresence :: IMPresence -> Presence -> Presence

xpIMPresence :: PU [Element] IMPresence

xpShow :: PU Text ShowStatus

timeout :: Maybe Integer

Timeout to use with IQ requests

rosterSet

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))

Synonym to rosterSet

rosterRemove :: Jid -> Session -> IO Bool

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

Retrieve the current Roster state (STM version)

getRoster :: Session -> IO Roster

Retrieve the current Roster state

initRoster :: Session -> IO ()

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

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

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

Eq Subscription

Methods

(==) :: Subscription -> Subscription -> Bool

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

Read Subscription

Methods

readsPrec :: Int -> ReadS Subscription

readList :: ReadS [Subscription]

readPrec :: ReadPrec Subscription

readListPrec :: ReadPrec [Subscription]

Show Subscription

Methods

showsPrec :: Int -> Subscription -> ShowS

show :: Subscription -> String

showList :: [Subscription] -> ShowS

data Roster

Constructors

Roster

Fields

• ver :: Maybe Text
• items :: Map Jid Item

Instances

Show Roster

Methods

showsPrec :: Int -> Roster -> ShowS

show :: Roster -> String

showList :: [Roster] -> ShowS

data Item

Roster Items

Constructors

Item

Fields

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

Instances

Show Item

Methods

showsPrec :: Int -> Item -> ShowS

show :: Item -> String

showList :: [Item] -> ShowS

data RosterUpdate

Constructors

RosterUpdateRemove Jid

RosterUpdateAdd Item

New or updated item

Instances

Show RosterUpdate

Methods

showsPrec :: Int -> RosterUpdate -> ShowS

show :: RosterUpdate -> String

showList :: [RosterUpdate] -> ShowS

data QueryItem

Constructors

QueryItem

Fields

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

Instances

Show QueryItem

Methods

showsPrec :: Int -> QueryItem -> ShowS

show :: QueryItem -> String

showList :: [QueryItem] -> ShowS

data Query

Constructors

Query

Fields

• queryVer :: Maybe Text
• queryItems :: [QueryItem]

Instances

Show Query

Methods

showsPrec :: Int -> Query -> ShowS

show :: Query -> String

showList :: [Query] -> ShowS

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

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

Arguments

:: Username

Authentication identity (authcid or username)

-> Maybe AuthZID

Authorization identity (authzid)

-> Password

Password

-> SaslHandler

scramSha1

Arguments

:: Username

username

-> Maybe AuthZID

authorization ID

-> Password

password

-> SaslHandler

plain

Arguments

:: Username

authentication ID (username)

-> Maybe AuthZID

authorization ID

-> Password

password

-> SaslHandler

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

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

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

Pickler for SaslElement.

quote :: ByteString -> ByteString

Add quotationmarks around a byte string.

saslInit :: Text -> Maybe ByteString -> ErrorT AuthFailure (StateT StreamState IO) ()

pullSaslElement :: ErrorT AuthFailure (StateT StreamState IO) SaslElement

Pull the next element.

pullChallenge :: ErrorT AuthFailure (StateT StreamState IO) (Maybe ByteString)

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

saslFromJust :: Maybe a -> ErrorT AuthFailure (StateT StreamState IO) a

Extract value from Just, failing with AuthOtherFailure on Nothing.

pullSuccess :: ErrorT AuthFailure (StateT StreamState IO) (Maybe Text)

Pull the next element and check that it is success.

pullFinalMessage :: ErrorT AuthFailure (StateT StreamState IO) (Maybe ByteString)

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 -> ErrorT AuthFailure (StateT StreamState IO) Pairs

Extract p=q pairs from a challenge.

respond :: Maybe ByteString -> ErrorT AuthFailure (StateT StreamState IO) ()

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

prepCredentials :: Text -> Maybe Text -> Text -> ErrorT AuthFailure (StateT StreamState IO) (Text, Maybe Text, Text)

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

xorBS :: ByteString -> ByteString -> ByteString

Bit-wise xor of byte strings

merge :: [ByteString] -> ByteString

Join byte strings with ","

(+++) :: ByteString -> ByteString -> ByteString

Infix concatenation of byte strings

digestMd5

Arguments

:: Username

Authentication identity (authcid or username)

-> Maybe AuthZID

Authorization identity (authzid)

-> Password

Password

-> SaslHandler

scramSha1

Arguments

:: Username

username

-> Maybe AuthZID

authorization ID

-> Password

password

-> SaslHandler

plain

Arguments

:: Username

authentication ID (username)

-> Maybe AuthZID

authorization ID

-> Password

password

-> SaslHandler

digestMd5

Arguments

:: Username

Authentication identity (authcid or username)

-> Maybe AuthZID

Authorization identity (authzid)

-> Password

Password

-> SaslHandler

plain

Arguments

:: Username

authentication ID (username)

-> Maybe AuthZID

authorization ID

-> Password

password

-> SaslHandler

hashToken :: Hash ctx hash => hash

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

scram

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

-> ErrorT 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

Arguments

:: Username

username

-> Maybe AuthZID

authorization ID

-> Password

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

Constructors

SaslSuccess (Maybe Text)

SaslChallenge (Maybe Text)

type Pairs = [(ByteString, ByteString)]

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

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

Request subscription with an entity.

presenceSubscribed :: Jid -> Presence

Approve a subscripton of an entity.

presenceUnsubscribe :: Jid -> Presence

End a subscription with an entity.

presenceUnsubscribed :: Jid -> Presence

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

presenceOnline :: Presence

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

presenceOffline :: Presence

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

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

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

Add a recipient to a presence notification.

mkStanzaError

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

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

Create an IQ Result matching an IQ request

associatedErrorType :: StanzaErrorCondition -> StanzaErrorType

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)

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

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

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

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

type StreamSink a = ConduitM Event Void (ErrorT XmppFailure IO) 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 :: Source (ErrorT XmppFailure IO) o -> IO (ConduitM i o (ErrorT 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)

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

closeStreams :: Stream -> IO ()

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 ()

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 ())

Encode and send stanza

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

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

runEventsSink :: Sink Event (ErrorT 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)

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

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

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

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

zeroHandle :: StreamHandle

xmppNoStream :: StreamState

zeroSource :: Source (ErrorT XmppFailure IO) a

handleToStreamHandle :: Handle -> StreamHandle

createStream :: HostName -> StreamConfiguration -> ErrorT XmppFailure IO Stream

connect :: HostName -> StreamConfiguration -> ErrorT XmppFailure IO (Maybe StreamHandle)

connectSrv :: ResolvConf -> String -> ErrorT XmppFailure IO (Maybe Handle)

showPort :: PortID -> String

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 -> ErrorT XmppFailure IO (Maybe [(Domain, Int)])

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

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))

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

elements :: MonadError XmppFailure m => Conduit Event m Element

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 ())

Checks for TLS support and run starttls procedure if applicable

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

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

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

connectTls

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)

-> ErrorT 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)

newtype NonemptyText

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

Constructors

Nonempty

Fields

• fromNonempty :: Text

Instances

Eq NonemptyText

Methods

(==) :: NonemptyText -> NonemptyText -> Bool

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

Ord NonemptyText

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

Read NonemptyText

Methods

readsPrec :: Int -> ReadS NonemptyText

readList :: ReadS [NonemptyText]

readPrec :: ReadPrec NonemptyText

readListPrec :: ReadPrec [NonemptyText]

Show NonemptyText

Methods

showsPrec :: Int -> NonemptyText -> ShowS

show :: NonemptyText -> String

showList :: [NonemptyText] -> ShowS

IsString NonemptyText

Methods

fromString :: String -> NonemptyText

nonEmpty :: Text -> Maybe NonemptyText

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

text :: NonemptyText -> Text

Same as fromNonempty

data IQError

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

Eq IQError

Methods

(==) :: IQError -> IQError -> Bool

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

Show IQError

Methods

showsPrec :: Int -> IQError -> ShowS

show :: IQError -> String

showList :: [IQError] -> ShowS

IsErrorStanza IQError

Methods

stanzaError :: Lens IQError StanzaError

IsStanza IQError

Methods

from :: Lens IQError (Maybe Jid)

to :: Lens IQError (Maybe Jid)

lang :: Lens IQError (Maybe LangTag)

sid :: Lens IQError (Maybe Text)

payloadT :: Traversal IQError Element

HasStanzaPayload IQError (Maybe Element)

Methods

payload :: Lens IQError (Maybe Element)

data IQRequest

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

Eq IQRequest

Methods

(==) :: IQRequest -> IQRequest -> Bool

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

Show IQRequest

Methods

showsPrec :: Int -> IQRequest -> ShowS

show :: IQRequest -> String

showList :: [IQRequest] -> ShowS

IsStanza IQRequest

Methods

from :: Lens IQRequest (Maybe Jid)

to :: Lens IQRequest (Maybe Jid)

lang :: Lens IQRequest (Maybe LangTag)

sid :: Lens IQRequest (Maybe Text)

payloadT :: Traversal IQRequest Element

HasStanzaPayload IQRequest Element

Methods

payload :: Lens IQRequest Element

data IQRequestType

The type of IQ request that is made.

Constructors

Get

Set

Instances

Eq IQRequestType

Methods

(==) :: IQRequestType -> IQRequestType -> Bool

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

Ord IQRequestType

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

Read IQRequestType

Methods

readsPrec :: Int -> ReadS IQRequestType

readList :: ReadS [IQRequestType]

readPrec :: ReadPrec IQRequestType

readListPrec :: ReadPrec [IQRequestType]

Show IQRequestType

Methods

showsPrec :: Int -> IQRequestType -> ShowS

show :: IQRequestType -> String

showList :: [IQRequestType] -> ShowS

data IQResponse

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

Constructors

IQResponseError IQError

IQResponseResult IQResult

Instances

Eq IQResponse

Methods

(==) :: IQResponse -> IQResponse -> Bool

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

Show IQResponse

Methods

showsPrec :: Int -> IQResponse -> ShowS

show :: IQResponse -> String

showList :: [IQResponse] -> ShowS

data IQResult

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

Eq IQResult

Methods

(==) :: IQResult -> IQResult -> Bool

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

Show IQResult

Methods

showsPrec :: Int -> IQResult -> ShowS

show :: IQResult -> String

showList :: [IQResult] -> ShowS

IsStanza IQResult

Methods

from :: Lens IQResult (Maybe Jid)

to :: Lens IQResult (Maybe Jid)

lang :: Lens IQResult (Maybe LangTag)

sid :: Lens IQResult (Maybe Text)

payloadT :: Traversal IQResult Element

HasStanzaPayload IQResult (Maybe Element)

Methods

payload :: Lens IQResult (Maybe Element)

data LangTag

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

Eq LangTag

Methods

(==) :: LangTag -> LangTag -> Bool

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

Read LangTag

Methods

readsPrec :: Int -> ReadS LangTag

readList :: ReadS [LangTag]

readPrec :: ReadPrec LangTag

readListPrec :: ReadPrec [LangTag]

Show LangTag

Methods

showsPrec :: Int -> LangTag -> ShowS

show :: LangTag -> String

showList :: [LangTag] -> ShowS

langTagQ :: QuasiQuoter

langTagFromText :: Text -> Maybe LangTag

Parses, validates, and possibly constructs a LangTag object.

langTagToText :: LangTag -> Text

parseLangTag :: String -> LangTag

type ExtendedAttribute = (Name, Text)

data Message

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

Eq Message

Methods

(==) :: Message -> Message -> Bool

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

Show Message

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

Default Message

Methods

def :: Message

IsStanza Message

Methods

from :: Lens Message (Maybe Jid)

to :: Lens Message (Maybe Jid)

lang :: Lens Message (Maybe LangTag)

sid :: Lens Message (Maybe Text)

payloadT :: Traversal Message Element

HasStanzaPayload Message [Element]

Methods

payload :: Lens Message [Element]

message :: Message

An empty message

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

data MessageError

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

Eq MessageError

Methods

(==) :: MessageError -> MessageError -> Bool

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

Show MessageError

Methods

showsPrec :: Int -> MessageError -> ShowS

show :: MessageError -> String

showList :: [MessageError] -> ShowS

Default MessageError

Methods

def :: MessageError

IsErrorStanza MessageError

Methods

stanzaError :: Lens MessageError StanzaError

IsStanza MessageError

Methods

from :: Lens MessageError (Maybe Jid)

to :: Lens MessageError (Maybe Jid)

lang :: Lens MessageError (Maybe LangTag)

sid :: Lens MessageError (Maybe Text)

payloadT :: Traversal MessageError Element

HasStanzaPayload MessageError [Element]

Methods

payload :: Lens MessageError [Element]

messageError :: MessageError

data MessageType

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

Eq MessageType

Methods

(==) :: MessageType -> MessageType -> Bool

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

Read MessageType

Methods

readsPrec :: Int -> ReadS MessageType

readList :: ReadS [MessageType]

readPrec :: ReadPrec MessageType

readListPrec :: ReadPrec [MessageType]

Show MessageType

Methods

showsPrec :: Int -> MessageType -> ShowS

show :: MessageType -> String

showList :: [MessageType] -> ShowS

data Presence

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

Eq Presence

Methods

(==) :: Presence -> Presence -> Bool

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

Show Presence

Methods

showsPrec :: Int -> Presence -> ShowS

show :: Presence -> String

showList :: [Presence] -> ShowS

Default Presence

Methods

def :: Presence

IsStanza Presence

Methods

from :: Lens Presence (Maybe Jid)

to :: Lens Presence (Maybe Jid)

lang :: Lens Presence (Maybe LangTag)

sid :: Lens Presence (Maybe Text)

payloadT :: Traversal Presence Element

HasStanzaPayload Presence [Element]

Methods

payload :: Lens Presence [Element]

presence :: Presence

An empty presence.

data PresenceError

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

Eq PresenceError

Methods

(==) :: PresenceError -> PresenceError -> Bool

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

Show PresenceError

Methods

showsPrec :: Int -> PresenceError -> ShowS

show :: PresenceError -> String

showList :: [PresenceError] -> ShowS

IsErrorStanza PresenceError

Methods

stanzaError :: Lens PresenceError StanzaError

IsStanza PresenceError

Methods

from :: Lens PresenceError (Maybe Jid)

to :: Lens PresenceError (Maybe Jid)

lang :: Lens PresenceError (Maybe LangTag)

sid :: Lens PresenceError (Maybe Text)

payloadT :: Traversal PresenceError Element

HasStanzaPayload PresenceError [Element]

Methods

payload :: Lens PresenceError [Element]

data PresenceType

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

Eq PresenceType

Methods

(==) :: PresenceType -> PresenceType -> Bool

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

Read PresenceType

Methods

readsPrec :: Int -> ReadS PresenceType

readList :: ReadS [PresenceType]

readPrec :: ReadPrec PresenceType

readListPrec :: ReadPrec [PresenceType]

Show PresenceType

Methods

showsPrec :: Int -> PresenceType -> ShowS

show :: PresenceType -> String

showList :: [PresenceType] -> ShowS

data SaslError

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

Eq SaslError

Methods

(==) :: SaslError -> SaslError -> Bool

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

Read SaslError

Methods

readsPrec :: Int -> ReadS SaslError

readList :: ReadS [SaslError]

readPrec :: ReadPrec SaslError

readListPrec :: ReadPrec [SaslError]

Show SaslError

Methods

showsPrec :: Int -> SaslError -> ShowS

show :: SaslError -> String

showList :: [SaslError] -> ShowS

data SaslFailure

Constructors

SaslFailure

Fields

• saslFailureCondition :: SaslError
• saslFailureText :: Maybe (Maybe LangTag, Text)

Instances

Eq SaslFailure

Methods

(==) :: SaslFailure -> SaslFailure -> Bool

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

Show SaslFailure

Methods

showsPrec :: Int -> SaslFailure -> ShowS

show :: SaslFailure -> String

showList :: [SaslFailure] -> ShowS

data StreamFeatures

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

Eq StreamFeatures

Methods

(==) :: StreamFeatures -> StreamFeatures -> Bool

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

Show StreamFeatures

Methods

showsPrec :: Int -> StreamFeatures -> ShowS

show :: StreamFeatures -> String

showList :: [StreamFeatures] -> ShowS

Monoid StreamFeatures

Methods

mempty :: StreamFeatures

mappend :: StreamFeatures -> StreamFeatures -> StreamFeatures

mconcat :: [StreamFeatures] -> StreamFeatures

data Stanza

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

Eq Stanza

Methods

(==) :: Stanza -> Stanza -> Bool

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

Show Stanza

Methods

showsPrec :: Int -> Stanza -> ShowS

show :: Stanza -> String

showList :: [Stanza] -> ShowS

IsStanza Stanza

Methods

from :: Lens Stanza (Maybe Jid)

to :: Lens Stanza (Maybe Jid)

lang :: Lens Stanza (Maybe LangTag)

sid :: Lens Stanza (Maybe Text)

payloadT :: Traversal Stanza Element

data XmppElement

Constructors

XmppStanza !Stanza

XmppNonza !Element

Instances

Eq XmppElement

Methods

(==) :: XmppElement -> XmppElement -> Bool

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

Show XmppElement

Methods

showsPrec :: Int -> XmppElement -> ShowS

show :: XmppElement -> String

showList :: [XmppElement] -> ShowS

messageS :: Stanza

Empty message stanza

messageS = MessageS message

messageErrorS :: Stanza

presenceS :: Stanza

Empty presence stanza

data StanzaError

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

Eq StanzaError

Methods

(==) :: StanzaError -> StanzaError -> Bool

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

Show StanzaError

Methods

showsPrec :: Int -> StanzaError -> ShowS

show :: StanzaError -> String

showList :: [StanzaError] -> ShowS

data StanzaErrorCondition

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

Eq StanzaErrorCondition

Methods

(==) :: StanzaErrorCondition -> StanzaErrorCondition -> Bool

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

Read StanzaErrorCondition

Methods

readsPrec :: Int -> ReadS StanzaErrorCondition

readList :: ReadS [StanzaErrorCondition]

readPrec :: ReadPrec StanzaErrorCondition

readListPrec :: ReadPrec [StanzaErrorCondition]

Show StanzaErrorCondition

Methods

showsPrec :: Int -> StanzaErrorCondition -> ShowS

show :: StanzaErrorCondition -> String

showList :: [StanzaErrorCondition] -> ShowS

data StanzaErrorType

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

Eq StanzaErrorType

Methods

(==) :: StanzaErrorType -> StanzaErrorType -> Bool

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

Read StanzaErrorType

Methods

readsPrec :: Int -> ReadS StanzaErrorType

readList :: ReadS [StanzaErrorType]

readPrec :: ReadPrec StanzaErrorType

readListPrec :: ReadPrec [StanzaErrorType]

Show StanzaErrorType

Methods

showsPrec :: Int -> StanzaErrorType -> ShowS

show :: StanzaErrorType -> String

showList :: [StanzaErrorType] -> ShowS

data XmppFailure

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

Eq XmppFailure

Methods

(==) :: XmppFailure -> XmppFailure -> Bool

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

Show XmppFailure

Methods

showsPrec :: Int -> XmppFailure -> ShowS

show :: XmppFailure -> String

showList :: [XmppFailure] -> ShowS

Exception XmppFailure

Methods

toException :: XmppFailure -> SomeException

fromException :: SomeException -> Maybe XmppFailure

displayException :: XmppFailure -> String

Error XmppFailure

Methods

noMsg :: XmppFailure

strMsg :: String -> XmppFailure

data XmppTlsError

Constructors

XmppTlsError TLSError

XmppTlsException TLSException

Instances

Eq XmppTlsError

Methods

(==) :: XmppTlsError -> XmppTlsError -> Bool

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

Show XmppTlsError

Methods

showsPrec :: Int -> XmppTlsError -> ShowS

show :: XmppTlsError -> String

showList :: [XmppTlsError] -> ShowS

data StreamErrorCondition

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

Eq StreamErrorCondition

Methods

(==) :: StreamErrorCondition -> StreamErrorCondition -> Bool

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

Read StreamErrorCondition

Methods

readsPrec :: Int -> ReadS StreamErrorCondition

readList :: ReadS [StreamErrorCondition]

readPrec :: ReadPrec StreamErrorCondition

readListPrec :: ReadPrec [StreamErrorCondition]

Show StreamErrorCondition

Methods

showsPrec :: Int -> StreamErrorCondition -> ShowS

show :: StreamErrorCondition -> String

showList :: [StreamErrorCondition] -> ShowS

data Version

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

Eq Version

Methods

(==) :: Version -> Version -> Bool

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

Ord Version

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

Read Version

Methods

readsPrec :: Int -> ReadS Version

readList :: ReadS [Version]

readPrec :: ReadPrec Version

readListPrec :: ReadPrec [Version]

Show Version

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

versionFromText :: Text -> Maybe Version

data StreamHandle

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

Constructors

Stream

Fields

• unStream :: TMVar StreamState

data StreamState

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 :: Source (ErrorT XmppFailure IO) Event

  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

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

Eq ConnectionState

Methods

(==) :: ConnectionState -> ConnectionState -> Bool

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

Show ConnectionState

Methods

showsPrec :: Int -> ConnectionState -> ShowS

show :: ConnectionState -> String

showList :: [ConnectionState] -> ShowS

data StreamErrorInfo

Encapsulates information about an XMPP stream error.

Constructors

StreamErrorInfo

Fields

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

Instances

Eq StreamErrorInfo

Methods

(==) :: StreamErrorInfo -> StreamErrorInfo -> Bool

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

Show StreamErrorInfo

Methods

showsPrec :: Int -> StreamErrorInfo -> ShowS

show :: StreamErrorInfo -> String

showList :: [StreamErrorInfo] -> ShowS

data ConnectionDetails

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 (ErrorT 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

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

Default StreamConfiguration

Methods

def :: StreamConfiguration

xmppDefaultParams :: ClientParams

Default parameters for TLS

xmppDefaultParamsStrong :: ClientParams

Default parameters for TLS restricted to strong ciphers

data Jid

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

Eq Jid

Methods

(==) :: Jid -> Jid -> Bool

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

Ord Jid

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

Read Jid

Methods

readsPrec :: Int -> ReadS Jid

readList :: ReadS [Jid]

readPrec :: ReadPrec Jid

readListPrec :: ReadPrec [Jid]

Show Jid

Methods

showsPrec :: Int -> Jid -> ShowS

show :: Jid -> String

showList :: [Jid] -> ShowS

Lift Jid

Methods

lift :: Jid -> Q Exp

jidQ :: QuasiQuoter

Synonym for jid

jid :: QuasiQuoter

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

See also jidFromText

isBare :: Jid -> Bool

Returns True if the JID is bare, that is, it doesn't have a resource part, and False otherwise.

>>> isBare [jid|foo@bar|]
True

>>> isBare [jid|foo@bar/quux|]
False

isFull :: Jid -> Bool

Returns True if the JID is full, and False otherwise.

isFull = not . isBare

>>> isBare [jid|foo@bar|]
True

>>> isBare [jid|foo@bar/quux|]
False

jidFromText :: Text -> Maybe Jid

Parse a JID

>>> localpart <$> jidFromText "foo@bar/quux"
Just (Just "foo")

>>> domainpart <$> jidFromText "foo@bar/quux"
Just "bar"

>>> resourcepart <$> jidFromText "foo@bar/quux"
Just (Just "quux")

@ and / can occur in the domain part

>>> jidFromText "foo/bar@quux/foo"
Just parseJid "foo/bar@quux/foo"

• Counterexamples

A JID must only have one '@':

>>> jidFromText "foo@bar@quux"
Nothing

The domain part can't be empty:

>>> jidFromText "foo@/quux"
Nothing

Both the local part and the resource part can be omitted (but the '@' and '/', must also be removed):

>>> jidToTexts <$> jidFromText "bar"
Just (Nothing,"bar",Nothing)

>>> jidToTexts <$> jidFromText "@bar"
Nothing

>>> jidToTexts <$> jidFromText "bar/"
Nothing

jidFromTexts :: Maybe Text -> Text -> Maybe Text -> Maybe Jid

Convert localpart, domainpart, and resourcepart to a JID. Runs the appropriate stringprep profiles and validates the parts.

>>> jidFromTexts (Just "foo") "bar" (Just "baz") == jidFromText "foo@bar/baz"
True

\j -> jidFromTexts (localpart j) (domainpart j) (resourcepart j) == Just j

(<~) :: Jid -> Jid -> Bool

The partial order of "definiteness". JID1 is less than or equal JID2 iff the domain parts are equal and JID1's local part and resource part each are either Nothing or equal to Jid2's

nodeprepProfile :: StringPrepProfile

The nodeprep StringPrep profile.

resourceprepProfile :: StringPrepProfile

The resourceprep StringPrep profile.

jidToText :: Jid -> Text

Converts a JID to a Text.

jidToTexts :: Jid -> (Maybe Text, Text, Maybe Text)

Converts a JID to up to three Text values: (the optional) localpart, the domainpart, and (the optional) resourcepart.

>>> jidToTexts [jid|foo@bar/quux|]
(Just "foo","bar",Just "quux")

>>> jidToTexts [jid|bar/quux|]
(Nothing,"bar",Just "quux")

>>> jidToTexts [jid|foo@bar|]
(Just "foo","bar",Nothing)

jidToTexts j == (localpart j, domainpart j, resourcepart j)

toBare :: Jid -> Jid

Returns the Jid without the resourcepart (if any).

>>> toBare [jid|foo@bar/quux|] == [jid|foo@bar|]
True

localpart :: Jid -> Maybe Text

Returns the localpart of the Jid (if any).

>>> localpart [jid|foo@bar/quux|]
Just "foo"

domainpart :: Jid -> Text

Returns the domainpart of the Jid.

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

resourcepart :: Jid -> Maybe Text

Returns the resourcepart of the Jid (if any).

>>> resourcepart [jid|foo@bar/quux|]
Just "quux"

parseJid :: String -> Jid

Parses a JID string.

Note: This function is only meant to be used to reverse Jid Show operations; it will produce an undefined value if the JID does not validate; please refer to jidFromText for a safe equivalent.

data TlsBehaviour

How the client should behave in regards to TLS.

Constructors

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.

data AuthFailure

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

Eq AuthFailure

Methods

(==) :: AuthFailure -> AuthFailure -> Bool

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

Show AuthFailure

Methods

showsPrec :: Int -> AuthFailure -> ShowS

show :: AuthFailure -> String

showList :: [AuthFailure] -> ShowS

Error AuthFailure

Methods

noMsg :: AuthFailure

strMsg :: String -> AuthFailure

openElementToEvents :: Element -> [Event]

renderOpenElement :: Element -> ByteString

renderElement :: Element -> ByteString

checkHostName :: Text -> Maybe Text

Validates the hostname string in accordance with RFC 1123.

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

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