diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,20 +1,202 @@ -Copyright (c) 2014 Jon Sterling -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -The above copyright notice and this permission notice shall be included -in all copies or substantial portions of the Software. + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/src/Control/Concurrent/STM/BoundedQueue.hs b/src/Control/Concurrent/STM/BoundedQueue.hs new file mode 100644 --- /dev/null +++ b/src/Control/Concurrent/STM/BoundedQueue.hs @@ -0,0 +1,52 @@ +-- Copyright (c) 2013-2014 PivotCloud, Inc. +-- +-- Control.Concurrent.STM.BoundedQueue +-- +-- Please feel free to contact us at licensing@pivotmail.com with any +-- contributions, additions, or other feedback; we would love to hear from +-- you. +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); you may +-- not use this file except in compliance with the License. You may obtain a +-- copy of the License at http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +-- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +-- License for the specific language governing permissions and limitations +-- under the License. +-- + +{-# LANGUAGE Safe #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE UnicodeSyntax #-} + +module Control.Concurrent.STM.BoundedQueue +( BoundedQueue(..) +) where + +import Control.Applicative +import Control.Concurrent.STM +import Control.Concurrent.STM.TBMQueue +import Control.Concurrent.STM.Queue + +class Queue q ⇒ BoundedQueue q where + tryWriteQueue + ∷ q α + → α + → STM (QueueValue q Bool) + + isFullQueue + ∷ q α + → STM Bool + +instance BoundedQueue TBQueue where + tryWriteQueue q x = do + True <$ writeTBQueue q x + <|> pure False + + isFullQueue = isFullTBQueue + +instance BoundedQueue TBMQueue where + tryWriteQueue = tryWriteTBMQueue + isFullQueue = isFullTBMQueue diff --git a/src/Control/Concurrent/STM/CloseableQueue.hs b/src/Control/Concurrent/STM/CloseableQueue.hs new file mode 100644 --- /dev/null +++ b/src/Control/Concurrent/STM/CloseableQueue.hs @@ -0,0 +1,48 @@ +-- Copyright (c) 2013-2014 PivotCloud, Inc. +-- +-- Control.Concurrent.STM.CloseableQueue +-- +-- Please feel free to contact us at licensing@pivotmail.com with any +-- contributions, additions, or other feedback; we would love to hear from +-- you. +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); you may +-- not use this file except in compliance with the License. You may obtain a +-- copy of the License at http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +-- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +-- License for the specific language governing permissions and limitations +-- under the License. +-- + +{-# LANGUAGE Safe #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE UnicodeSyntax #-} + +module Control.Concurrent.STM.CloseableQueue +( CloseableQueue(..) +) where + +import Control.Concurrent.STM +import Control.Concurrent.STM.TBMQueue +import Control.Concurrent.STM.TMQueue +import Control.Concurrent.STM.Queue + +class Queue q ⇒ CloseableQueue q where + closeQueue + ∷ q α + → STM () + + isClosedQueue + ∷ q α + → STM Bool + +instance CloseableQueue TMQueue where + closeQueue = closeTMQueue + isClosedQueue = isClosedTMQueue + +instance CloseableQueue TBMQueue where + closeQueue = closeTBMQueue + isClosedQueue = isClosedTBMQueue diff --git a/src/Control/Concurrent/STM/ETQueue.hs b/src/Control/Concurrent/STM/ETQueue.hs deleted file mode 100644 --- a/src/Control/Concurrent/STM/ETQueue.hs +++ /dev/null @@ -1,103 +0,0 @@ -{-# LANGUAGE RecordWildCards #-} -{-# LANGUAGE UnicodeSyntax #-} - --- | --- Module: Control.Concurrent.STM.ETQueue --- Copyright: Copyright © 2014 AlephCloud Systems, Inc. --- License: MIT --- Maintainer: Jon Sterling --- Stability: experimental --- -module Control.Concurrent.STM.ETQueue -( ETQueue -, newETQueue -, newETQueueIO -, readETQueue -, tryReadETQueue -, peekETQueue -, tryPeekETQueue -, writeETQueue -, unGetETQueue -, isEmptyETQueue -, awaitEmpty -) where - -import Control.Applicative -import Control.Concurrent.STM -import Control.Monad - --- | A variant of 'TQueue' such that you can await its emptiness. -data ETQueue α - = ETQueue - { etqQueue ∷ TQueue α - , etqVar ∷ TMVar () - } - -newETQueue ∷ STM (ETQueue α) -newETQueue = do - etqQueue ← newTQueue - etqVar ← newTMVar () - return ETQueue {..} - -newETQueueIO ∷ IO (ETQueue α) -newETQueueIO = do - etqQueue ← newTQueueIO - etqVar ← newTMVarIO () - return ETQueue {..} - -readETQueue - ∷ ETQueue α - → STM α -readETQueue ETQueue{..} = do - a ← readTQueue etqQueue - isEmpty ← isEmptyTQueue etqQueue - when isEmpty $ - () <$ tryPutTMVar etqVar () - return a - -tryReadETQueue - ∷ ETQueue α - → STM (Maybe α) -tryReadETQueue q = - (Just <$> readETQueue q) - `orElse` return Nothing - -peekETQueue - ∷ ETQueue α - → STM α -peekETQueue ETQueue{..} = - peekTQueue etqQueue - -tryPeekETQueue - ∷ ETQueue α - → STM (Maybe α) -tryPeekETQueue ETQueue{..} = - tryPeekTQueue etqQueue - -writeETQueue - ∷ ETQueue α - → α - → STM () -writeETQueue ETQueue{..} a = do - writeTQueue etqQueue a - () <$ tryTakeTMVar etqVar - -unGetETQueue - ∷ ETQueue α - → α - → STM () -unGetETQueue ETQueue{..} a = do - unGetTQueue etqQueue a - () <$ tryTakeTMVar etqVar - -isEmptyETQueue - ∷ ETQueue α - → STM Bool -isEmptyETQueue ETQueue{..} = - isEmptyTQueue etqQueue - -awaitEmpty - ∷ ETQueue α - → STM () -awaitEmpty ETQueue{..} = - readTMVar etqVar diff --git a/src/Control/Concurrent/STM/Queue.hs b/src/Control/Concurrent/STM/Queue.hs new file mode 100644 --- /dev/null +++ b/src/Control/Concurrent/STM/Queue.hs @@ -0,0 +1,114 @@ +-- Copyright (c) 2013-2014 PivotCloud, Inc. +-- +-- Control.Concurrent.STM.Queue +-- +-- Please feel free to contact us at licensing@pivotmail.com with any +-- contributions, additions, or other feedback; we would love to hear from +-- you. +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); you may +-- not use this file except in compliance with the License. You may obtain a +-- copy of the License at http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +-- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +-- License for the specific language governing permissions and limitations +-- under the License. +-- + +{-# LANGUAGE Safe #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE UnicodeSyntax #-} + +module Control.Concurrent.STM.Queue +( Queue(..) +, awaitQueueEmpty +) where + +import Control.Concurrent.STM +import Control.Concurrent.STM.TBMQueue +import Control.Concurrent.STM.TMQueue +import Control.Monad + +class Queue q where + type QueueValue q α + + readQueue + ∷ q α + → STM (QueueValue q α) + + tryReadQueue + ∷ q α + → STM (Maybe (QueueValue q α)) + + peekQueue + ∷ q α + → STM (QueueValue q α) + + tryPeekQueue + ∷ q α + → STM (Maybe (QueueValue q α)) + + writeQueue + ∷ q α + → α + → STM () + + unGetQueue + ∷ q α + → α + → STM () + + isEmptyQueue + ∷ q α + → STM Bool + +instance Queue TQueue where + type QueueValue TQueue α = α + readQueue = readTQueue + tryReadQueue = tryReadTQueue + peekQueue = peekTQueue + tryPeekQueue = tryPeekTQueue + writeQueue = writeTQueue + unGetQueue = unGetTQueue + isEmptyQueue = isEmptyTQueue + +instance Queue TBQueue where + type QueueValue TBQueue α = α + readQueue = readTBQueue + tryReadQueue = tryReadTBQueue + peekQueue = peekTBQueue + tryPeekQueue = tryPeekTBQueue + writeQueue = writeTBQueue + unGetQueue = unGetTBQueue + isEmptyQueue = isEmptyTBQueue + +instance Queue TMQueue where + type QueueValue TMQueue α = Maybe α + readQueue = readTMQueue + tryReadQueue = tryReadTMQueue + peekQueue = peekTMQueue + tryPeekQueue = tryPeekTMQueue + writeQueue = writeTMQueue + unGetQueue = unGetTMQueue + isEmptyQueue = isEmptyTMQueue + +instance Queue TBMQueue where + type QueueValue TBMQueue α = Maybe α + readQueue = readTBMQueue + tryReadQueue = tryReadTBMQueue + peekQueue = peekTBMQueue + tryPeekQueue = tryPeekTBMQueue + writeQueue = writeTBMQueue + unGetQueue = unGetTBMQueue + isEmptyQueue = isEmptyTBMQueue + +-- | Block until a queue is empty. +awaitQueueEmpty + ∷ Queue q + ⇒ q α + → STM () +awaitQueueEmpty = + isEmptyQueue >=> check + diff --git a/stm-queue-extras.cabal b/stm-queue-extras.cabal --- a/stm-queue-extras.cabal +++ b/stm-queue-extras.cabal @@ -7,60 +7,32 @@ -- PVP summary: +-+------- breaking API changes -- | | +----- non-breaking API additions -- | | | +--- code changes with no API change -version: 0.1.0.0 +version: 0.2.0.0 +x-revision: 1 -- A short (one-line) description of the package. synopsis: Extra queue utilities for STM - --- A longer description of the package. --- description: - --- The license under which the package is released. -license: MIT - --- The file containing the license text. +license: Apache-2.0 license-file: LICENSE - --- The package author(s). author: Jon Sterling - --- An email address to which users can send suggestions, bug reports, and --- patches. maintainer: jon@jonmsterling.com - --- A copyright notice. --- copyright: - +copyright: Copyright (c) 2014 PivotCloud, Inc. category: Concurrency - build-type: Simple - --- Extra files to be distributed with the package, such as examples or a --- README. --- extra-source-files: - --- Constraint on the version of Cabal needed to build this package. cabal-version: >=1.10 +source-repository head + type: git + location: https://github.com/alephcloud/hs-stm-queue-extras.git library - -- Modules exported by the library. - exposed-modules: Control.Concurrent.STM.ETQueue - - - -- Modules included in this library but not exported. - -- other-modules: - - -- LANGUAGE extensions used by modules in this package. - -- other-extensions: - - -- Other library packages from which modules are imported. + exposed-modules: Control.Concurrent.STM.Queue, + Control.Concurrent.STM.BoundedQueue + Control.Concurrent.STM.CloseableQueue build-depends: base >=4.7 && <4.8, - stm >= 2.4.3 - - -- Directories containing source files. + stm >= 2.4.3, + stm-chans >= 3.0.0.2 hs-source-dirs: src - - -- Base language which the package is written in. default-language: Haskell2010 +