From 030ea4d02bb4209e14392f76688764912881de51 Mon Sep 17 00:00:00 2001 From: Philipp Balzarek Date: Thu, 31 Oct 2013 13:43:42 +0100 Subject: [PATCH] correct some documentation errors --- source/Network/Xmpp/Concurrent/Types.hs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/Network/Xmpp/Concurrent/Types.hs b/source/Network/Xmpp/Concurrent/Types.hs index 976bcca..4fad6be 100644 --- a/source/Network/Xmpp/Concurrent/Types.hs +++ b/source/Network/Xmpp/Concurrent/Types.hs @@ -23,7 +23,7 @@ import Network.Xmpp.Sasl.Types data SessionConfiguration = SessionConfiguration { -- | Configuration for the @Stream@ object. sessionStreamConfiguration :: StreamConfiguration - -- | Handler to be run when the session ends (for whatever reason). + -- | Handler to be run when the conection to the XMPP server is closed. , onConnectionClosed :: Session -> XmppFailure -> IO () -- | Function to generate the stream of stanza identifiers. , sessionStanzaIDs :: IO (IO Text) @@ -58,7 +58,8 @@ instance Ex.Exception Interrupt type WriteSemaphore = TMVar (BS.ByteString -> IO Bool) --- | A concurrent interface to Pontarius XMPP. +-- | The Session object represents a single session with an XMPP server. You can +-- use 'session' to establish a session data Session = Session { stanzaCh :: TChan Stanza -- All stanzas , iqHandlers :: TVar IQHandlers @@ -83,13 +84,12 @@ data Session = Session -- | 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. -type IQHandlers = (Map.Map (IQRequestType, Text) (TChan IQRequestTicket) +type IQHandlers = ( Map.Map (IQRequestType, Text) (TChan IQRequestTicket) , Map.Map Text (TMVar IQResponse) ) -- | Contains whether or not a reply has been sent, and the IQ request body to -- reply to. - data IQRequestTicket = IQRequestTicket { answerTicket :: Either StanzaError (Maybe Element) -> IO (Maybe Bool) -- ^ Return Nothing when the IQ request was already