stomp-conduit (empty) → 0.0.1
raw patch · 4 files changed
+346/−0 lines, 4 filesdep +basedep +conduitdep +mimesetup-changed
Dependencies added: base, conduit, mime, mtl, stomp-queue, stompl
Files
- Network/Mom/Stompl/Client/Conduit.hs +118/−0
- Setup.hs +2/−0
- license/lgpl-3.0.txt +165/−0
- stomp-conduit.cabal +61/−0
+ Network/Mom/Stompl/Client/Conduit.hs view
@@ -0,0 +1,118 @@+-------------------------------------------------------------------------------+-- |+-- Module : Network/Mom/Stompl/Client/Conduit.hs+-- Copyright : (c) Tobias Schoofs+-- License : LGPL +-- Stability : experimental+-- Portability: portable+--+-- This module provides Conduit interfaces+-- for the stomp-queue library.+-- The interfaces create or receive+-- streams of messages instead of single messages.+-- This approach aims to simplify the integration+-- of messaging into applications by means of well-defined+-- streaming interfaces. +-------------------------------------------------------------------------------+module Network.Mom.Stompl.Client.Conduit (+ -- * Plain message streams+ qSource, qSink, + -- * Multipart messages as streams+ qMultiSource, qMultiSink)+where++ import qualified Data.Conduit as C+ import Codec.MIME.Type (Type)+ import Control.Monad.Trans (liftIO)+ import System.Timeout++ import Network.Mom.Stompl.Client.Queue+ import Network.Mom.Stompl.Frame++ ------------------------------------------------------------------------+ -- | Reads from a 'Reader' queue with timeout + -- and returns a 'C.Producer' of type 'Message' i.+ --+ -- The function ends iff the timeout expires + -- and loops infinitely otherwise.+ --+ -- Parameters:+ --+ -- * 'Reader' i: The input interface, a Stomp 'Reader'. + --+ -- * Int: Timeout in microseconds+ ------------------------------------------------------------------------+ qSource :: C.MonadResource m => + Reader i -> Int -> C.Producer m (Message i)+ qSource r tmo = go+ where go = liftIO (timeout tmo $ readQ r) >>= mbYield+ mbYield mbX = case mbX of+ Nothing -> return ()+ Just x -> C.yield x >> go++ ------------------------------------------------------------------------+ -- | Writes a stream of messages to a 'Writer' queue+ -- and returns a 'C.Consumer' of type o.+ -- The function terminates, when the stream ends.+ --+ -- Parameters:+ --+ -- * 'Writer' o: The output interface, a Stomp 'Writer'.+ --+ -- * 'Type': The mime type of the message content.+ --+ -- * ['Header']: Headers to add to each message.+ ------------------------------------------------------------------------+ qSink :: C.MonadResource m => + Writer o -> Type -> [Header] -> C.Consumer o m ()+ qSink w t hs = C.awaitForever $ \x -> liftIO (writeQ w t hs x)++ -- header to mark the last segment of a multipart message -------------+ lastMHdr :: Header+ lastMHdr = ("__last__", "true")++ ------------------------------------------------------------------------+ -- | Reads from a 'Reader' queue with timeout + -- and returns a 'C.Producer' of type 'Message' i.+ -- The function ends when the timeout expires + -- or after having received a segment that is marked as the last one.+ -- Note that multipart messages are not foreseen by the standard.+ -- 'qMultiSink' and 'qMultiSource' use a header named \"__last__\"+ -- to label the last segment of a multipart message.+ --+ -- For parameters, please refer to 'qSource'. + ------------------------------------------------------------------------+ qMultiSource :: C.MonadResource m =>+ Reader i -> Int -> C.Producer m (Message i)+ qMultiSource r tmo = loop+ where loop = do+ mbX <- liftIO (timeout tmo $ readQ r)+ case mbX of+ Nothing -> return ()+ Just x -> case lookup (fst lastMHdr) $ msgHdrs x of+ Just "true" -> C.yield x+ _ -> C.yield x >> loop+ ++ ------------------------------------------------------------------------+ -- | Writes a multipart message to a 'Writer' queue+ -- and returns a 'C.Consumer' of type o.+ -- The function terminates, when the stream ends.+ -- The last segment is sent with the header (\"__last__\", \"true\").+ -- Note that multipart messages are not foreseen by the standard.+ --+ -- For parameters, please refer to 'qSink'. + ------------------------------------------------------------------------+ qMultiSink :: C.MonadResource m =>+ Writer o -> Type -> [Header] -> C.Consumer o m ()+ qMultiSink w t hs = do+ mbX <- C.await+ case mbX of+ Nothing -> return ()+ Just x -> go x+ where hs' = lastMHdr:hs+ go x = do+ mbY <- C.await+ case mbY of+ Nothing -> liftIO (writeQ w t hs' x) + Just y -> liftIO (writeQ w t hs x) >> go y
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ license/lgpl-3.0.txt view
@@ -0,0 +1,165 @@+ GNU LESSER GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.+++ This version of the GNU Lesser General Public License incorporates+the terms and conditions of version 3 of the GNU General Public+License, supplemented by the additional permissions listed below.++ 0. Additional Definitions.++ As used herein, "this License" refers to version 3 of the GNU Lesser+General Public License, and the "GNU GPL" refers to version 3 of the GNU+General Public License.++ "The Library" refers to a covered work governed by this License,+other than an Application or a Combined Work as defined below.++ An "Application" is any work that makes use of an interface provided+by the Library, but which is not otherwise based on the Library.+Defining a subclass of a class defined by the Library is deemed a mode+of using an interface provided by the Library.++ A "Combined Work" is a work produced by combining or linking an+Application with the Library. The particular version of the Library+with which the Combined Work was made is also called the "Linked+Version".++ The "Minimal Corresponding Source" for a Combined Work means the+Corresponding Source for the Combined Work, excluding any source code+for portions of the Combined Work that, considered in isolation, are+based on the Application, and not on the Linked Version.++ The "Corresponding Application Code" for a Combined Work means the+object code and/or source code for the Application, including any data+and utility programs needed for reproducing the Combined Work from the+Application, but excluding the System Libraries of the Combined Work.++ 1. Exception to Section 3 of the GNU GPL.++ You may convey a covered work under sections 3 and 4 of this License+without being bound by section 3 of the GNU GPL.++ 2. Conveying Modified Versions.++ If you modify a copy of the Library, and, in your modifications, a+facility refers to a function or data to be supplied by an Application+that uses the facility (other than as an argument passed when the+facility is invoked), then you may convey a copy of the modified+version:++ a) under this License, provided that you make a good faith effort to+ ensure that, in the event an Application does not supply the+ function or data, the facility still operates, and performs+ whatever part of its purpose remains meaningful, or++ b) under the GNU GPL, with none of the additional permissions of+ this License applicable to that copy.++ 3. Object Code Incorporating Material from Library Header Files.++ The object code form of an Application may incorporate material from+a header file that is part of the Library. You may convey such object+code under terms of your choice, provided that, if the incorporated+material is not limited to numerical parameters, data structure+layouts and accessors, or small macros, inline functions and templates+(ten or fewer lines in length), you do both of the following:++ a) Give prominent notice with each copy of the object code that the+ Library is used in it and that the Library and its use are+ covered by this License.++ b) Accompany the object code with a copy of the GNU GPL and this license+ document.++ 4. Combined Works.++ You may convey a Combined Work under terms of your choice that,+taken together, effectively do not restrict modification of the+portions of the Library contained in the Combined Work and reverse+engineering for debugging such modifications, if you also do each of+the following:++ a) Give prominent notice with each copy of the Combined Work that+ the Library is used in it and that the Library and its use are+ covered by this License.++ b) Accompany the Combined Work with a copy of the GNU GPL and this license+ document.++ c) For a Combined Work that displays copyright notices during+ execution, include the copyright notice for the Library among+ these notices, as well as a reference directing the user to the+ copies of the GNU GPL and this license document.++ d) Do one of the following:++ 0) Convey the Minimal Corresponding Source under the terms of this+ License, and the Corresponding Application Code in a form+ suitable for, and under terms that permit, the user to+ recombine or relink the Application with a modified version of+ the Linked Version to produce a modified Combined Work, in the+ manner specified by section 6 of the GNU GPL for conveying+ Corresponding Source.++ 1) Use a suitable shared library mechanism for linking with the+ Library. A suitable mechanism is one that (a) uses at run time+ a copy of the Library already present on the user's computer+ system, and (b) will operate properly with a modified version+ of the Library that is interface-compatible with the Linked+ Version.++ e) Provide Installation Information, but only if you would otherwise+ be required to provide such information under section 6 of the+ GNU GPL, and only to the extent that such information is+ necessary to install and execute a modified version of the+ Combined Work produced by recombining or relinking the+ Application with a modified version of the Linked Version. (If+ you use option 4d0, the Installation Information must accompany+ the Minimal Corresponding Source and Corresponding Application+ Code. If you use option 4d1, you must provide the Installation+ Information in the manner specified by section 6 of the GNU GPL+ for conveying Corresponding Source.)++ 5. Combined Libraries.++ You may place library facilities that are a work based on the+Library side by side in a single library together with other library+facilities that are not Applications and are not covered by this+License, and convey such a combined library under terms of your+choice, if you do both of the following:++ a) Accompany the combined library with a copy of the same work based+ on the Library, uncombined with any other library facilities,+ conveyed under the terms of this License.++ b) Give prominent notice with the combined library that part of it+ is a work based on the Library, and explaining where to find the+ accompanying uncombined form of the same work.++ 6. Revised Versions of the GNU Lesser General Public License.++ The Free Software Foundation may publish revised and/or new versions+of the GNU Lesser General Public License from time to time. Such new+versions will be similar in spirit to the present version, but may+differ in detail to address new problems or concerns.++ Each version is given a distinguishing version number. If the+Library as you received it specifies that a certain numbered version+of the GNU Lesser General Public License "or any later version"+applies to it, you have the option of following the terms and+conditions either of that published version or of any later version+published by the Free Software Foundation. If the Library as you+received it does not specify a version number of the GNU Lesser+General Public License, you may choose any version of the GNU Lesser+General Public License ever published by the Free Software Foundation.++ If the Library as you received it specifies that a proxy can decide+whether future versions of the GNU Lesser General Public License shall+apply, that proxy's public statement of acceptance of any version is+permanent authorization for you to choose that version for the+Library.
+ stomp-conduit.cabal view
@@ -0,0 +1,61 @@+Name: stomp-conduit+Version: 0.0.1+Cabal-Version: >= 1.8+Copyright: Copyright (c) Tobias Schoofs, 2013+License: LGPL+license-file: license/lgpl-3.0.txt+Author: Tobias Schoofs+Maintainer: tobias dot schoofs at gmx dot net+Homepage: http://github.com/toschoo/mom+Category: Network, Message-oriented Middleware, Stomp, Client, Conduit+Build-Type: Simple+Synopsis: Stompl Conduit Client+Description:+ The Stomp Protocol specifies message-oriented interoperability.+ Applications connect to a message broker to send (publish)+ or receive (subscribe) messages through queues. + Interoperating applications do not know + the location or internal structure of each other.+ They see only each other's interfaces, /i.e./ the messages+ published and subscribed through a broker.++ .+ + The Stomp Queue library provides + a Stomp client, using abstractions like 'Reader' and 'Writer' Queues.+ The Stomp Conduit library provides an abstraction level+ on top of queues, where not single messages are in the focus+ of the API, but streams of messages,+ either infinite streams or+ multipart messages with an explicit last message segment.+ The latter concept is+ and extension of the Stomp specification.++ .++ More information, examples and a test suite are available + on <http://github.com/toschoo/mom>.+ The Stomp specification can be found at+ <http://stomp.github.com>.++ .++ Release History:++ .++ [0.0.1] Initial release+++Library+ Build-Depends: base >= 4.0 && <= 5.0,+ stomp-queue >= 0.0.7,+ stompl >= 0.0.3,+ conduit >= 1.0.8,+ mtl >= 2.1.2,+ mime >= 0.3.3++ hs-source-dirs: Network/Mom/Stompl/Client, .+ + Exposed-Modules: Network.Mom.Stompl.Client.Conduit+