Browse Source

fix documentation error

pull* functions don't create on-the-fly copies of channels any more
master
Philipp Balzarek 13 years ago
parent
commit
14eba3f16c
  1. 2
      source/Network/Xmpp.hs
  2. 4
      source/Network/Xmpp/Concurrent/Message.hs
  3. 4
      source/Network/Xmpp/Concurrent/Presence.hs

2
source/Network/Xmpp.hs

@ -29,6 +29,8 @@ module Network.Xmpp
, session , session
-- TODO: Close session, etc. -- TODO: Close session, etc.
-- ** Authentication handlers -- ** Authentication handlers
-- | The use of 'scramSha1' is /recommended/, but 'digestMd5' might be
-- useful for interaction with older implementation
, scramSha1 , scramSha1
, plain , plain
, digestMd5 , digestMd5

4
source/Network/Xmpp/Concurrent/Message.hs

@ -8,8 +8,8 @@ import Network.Xmpp.Types
import Network.Xmpp.Concurrent.Types import Network.Xmpp.Concurrent.Types
import Network.Xmpp.Concurrent.Basic import Network.Xmpp.Concurrent.Basic
-- | Read an element from the inbound stanza channel, acquiring a copy of the -- | Read an element from the inbound stanza channel, discardes any
-- channel as necessary. -- non-Message stanzas from the channel
pullMessage :: Session -> IO (Either MessageError Message) pullMessage :: Session -> IO (Either MessageError Message)
pullMessage session = do pullMessage session = do
stanza <- atomically . readTChan $ stanzaCh session stanza <- atomically . readTChan $ stanzaCh session

4
source/Network/Xmpp/Concurrent/Presence.hs

@ -7,8 +7,8 @@ import Network.Xmpp.Types
import Network.Xmpp.Concurrent.Types import Network.Xmpp.Concurrent.Types
import Network.Xmpp.Concurrent.Basic import Network.Xmpp.Concurrent.Basic
-- | Read an element from the inbound stanza channel, acquiring a copy of the -- | Read an element from the inbound stanza channel, discardes any non-Presence
-- channel as necessary. -- stanzas from the channel
pullPresence :: Session -> IO (Either PresenceError Presence) pullPresence :: Session -> IO (Either PresenceError Presence)
pullPresence session = do pullPresence session = do
stanza <- atomically . readTChan $ stanzaCh session stanza <- atomically . readTChan $ stanzaCh session

Loading…
Cancel
Save