Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update README.

  • Loading branch information...
commit e37982bfdf9219c56c7b221fc82e9dbef68ca2af 1 parent aefe185
@twittner authored
Showing with 33 additions and 30 deletions.
  1. +31 −28 README → README.md
  2. +2 −2 zeromq-haskell.cabal
View
59 README → README.md
@@ -1,58 +1,61 @@
This library provides Haskell bindings to zeromq (http://zeromq.org).
+Current status
+--------------
-· Current status
-
-Version 0.4 - This software currently has *beta* status, i.e. it had
+Version 0.4.1 - This software currently has *beta* status, i.e. it had
seen limited testing. Changes to its API may still happen.
This software was developed and tested on Linux 2.6.35 with GHC-6.12.3
-using zeromq-2.0.8.
-
+using zeromq-2.0.9.
-· Installation
+Installation
+------------
As usual for Haskell packages this software is installed best via Cabal
(http://www.haskell.org/cabal). In addition to GHC it depends on 0MQ of course.
-
-· Usage
+Usage
+-----
The API mostly follows 0MQ's. Public functions are:
-- init
-- term
-- socket
-- close
-- setOption
-- subscribe
-- unsubscribe
-- bind
-- connect
-- send
-- send'
-- receive
-- poll
+- `init`
+- `term`
+- `socket`
+- `close`
+- `setOption`
+- `getOption`
+- `subscribe`
+- `unsubscribe`
+- `bind`
+- `connect`
+- `send`
+- `send'`
+- `receive`
+- `moreToReceive`
+- `poll`
One difference to 0MQ's API is that sockets are parameterized types, i.e. there
is not one socket type but when creating a socket the desired socket type has
-to be specified, e.g. 'Pair' and the resulting socket is of type 'Socket Pair'.
+to be specified, e.g. `Pair` and the resulting socket is of type `Socket Pair`.
This additional type information is used to ensure that only options applicable
-to the socket type can be set, hence ZMQ_SUBSCRIBE and ZMQ_UNSUBSCRIBE which
-only apply to ZMQ_SUB sockets have their own functions ('subscribe' and
-'unsubscribe') which can only be used with sockets of type 'Socket Sub'.
+to the socket type can be set, hence `ZMQ_SUBSCRIBE` and `ZMQ_UNSUBSCRIBE` which
+only apply to `ZMQ_SUB` sockets have their own functions (`subscribe` and
+`unsubscribe`) which can only be used with sockets of type `Socket Sub`.
Other differences are mostly for convenience. Also one does not deal directly
with 0MQ messages, instead these are created internally as needed.
-
-· Examples
+Examples
+--------
The test folder contains some simple tests mostly mimicking the ones that come
with 0MQ.
-· Bugs
+Bugs
+----
If you find any bugs or other shortcomings I would greatly appreciate a bug
report, preferably via http://github.com/twittner/zeromq-haskell/issues or e-mail
View
4 zeromq-haskell.cabal
@@ -1,5 +1,5 @@
name: zeromq-haskell
-version: 0.4
+version: 0.4.1
synopsis: bindings to zeromq
description: Bindings to zeromq (http://zeromq.org)
category: System, FFI
@@ -13,7 +13,7 @@ stability: experimental
tested-With: GHC == 6.12.3
cabal-version: >= 1.6.0
build-type: Simple
-extra-source-files: README, AUTHORS, test/*.hs, test/perf/*.hs
+extra-source-files: README.md, AUTHORS, test/*.hs, test/perf/*.hs
library
exposed-modules: System.ZMQ
Please sign in to comment.
Something went wrong with that request. Please try again.