Network.Stomp

A client library for Stomp serevers implementing stomp 1.1 specification. See http:stomp.github.com/stomp-specification-1.1.html

Example:

import Network.Stomp
import qualified Data.ByteString.Lazy.Char8 as B

main = do
  -- connect to a stomp broker
  con <- connect "stomp://guest:guest@127.0.0.1:61613" vers headers
  putStrLn $ "Accepted versions: " ++ show (versions con)
  
  -- start consumer and subscribe to the queue
  startConsumer con callback
  subscribe con "/queue/test" "0" []

  -- send the messages to the queue
  send con "/queue/test" [] (B.pack "message1")
  send con "/queue/test" [] (B.pack "message2")

  -- wait
  getLine
  
  -- unsubscribe and disconnect
  unsubscribe con "0" []
  disconnect con []
  where 
    vers = [(1,0),(1,1)]
    headers = []

callback :: Frame -> IO ()
callback (Frame (SC MESSAGE) hs body) = do
      putStrLn $ "received message: " ++ (B.unpack body) 
      putStrLn $ "headers: " ++ show hs
callback f = putStrLn $ "received frame: " ++ show f

Documentation

data Command

Stomp frame commands

Constructors

CC ClientCommand

SC ServerCommand

Instances

Eq Command

Read Command

Show Command

data ClientCommand

Client frame commands

Constructors

SEND

SUBSCRIBE

UNSUBSCRIBE

BEGIN

COMMIT

ABORT

ACK

NACK

DISCONNECT

CONNECT

STOMP

Instances

Eq ClientCommand

Read ClientCommand

Show ClientCommand

data ServerCommand

Broker frame commands

Constructors

CONNECTED

MESSAGE

RECEIPT

ERROR

Instances

Eq ServerCommand

Read ServerCommand

Show ServerCommand

data Frame

Stomp frame record

Constructors

Frame

Fields

command :: Command

headers :: [Header]

body :: ByteString

Instances

Show Frame

data Connection

A record used to communicate with Stomp brokers

type StompUri = String

type Host = String

type Destination = String

type MessageId = String

type Transaction = String

type Subscription = String

type Version = (Int, Int)

data StompException

Constructors

ConnectionError String

InvalidUri String

InvalidFrame String

BrokerError String

StompIOError IOException

Instances

Eq StompException

Show StompException

Typeable StompException

Exception StompException

connect :: StompUri -> [Version] -> [Header] -> IO Connection

connect to the stomp (1.0, 1.1) broker using uri

stomp :: StompUri -> [Header] -> IO Connection

connect to the stomp 1.1 broker using uri

connect' :: Host -> PortNumber -> [Version] -> [Header] -> IO Connection

connect to the stomp (1.0, 1.1) broker using hostname and port

stomp' :: Host -> PortNumber -> [Header] -> IO Connection

connect to the stomp 1.0 broker using hostname and port

disconnect :: Connection -> [Header] -> IO ()

closes stomp connection

send :: Connection -> Destination -> [Header] -> ByteString -> IO ()

subscribe :: Connection -> Destination -> Subscription -> [Header] -> IO ()

subscribe to the destination to receive stomp frames

unsubscribe :: Connection -> Subscription -> [Header] -> IO ()

unsubscribe from destination given the subscription id

ack :: Connection -> Subscription -> MessageId -> [Header] -> IO ()

acknowledge the consumption of a message from a subscription

nack :: Connection -> Subscription -> MessageId -> [Header] -> IO ()

acknowledge the rejection of a message from a subscription

begin :: Connection -> Transaction -> [Header] -> IO ()

start a transaction

commit :: Connection -> Transaction -> [Header] -> IO ()

commit a transaction

abort :: Connection -> Transaction -> [Header] -> IO ()

rollback a transaction

startConsumer :: Connection -> (Frame -> IO ()) -> IO ()

create consume frames thread

receiveFrame :: Connection -> IO Frame

reads incoming frame from handle

setExcpHandler :: Connection -> (StompException -> IO ()) -> IO ()

set exception handler callback to process the exception in the consumer/heartbeats threads

startSendBeat :: Connection -> IO ()

fork send heartbeat thread

startRecvBeat :: Connection -> IO ()

fork receive heartbeat thread

sendTimeout :: Connection -> Int

send heartbeat timeout

recvTimeout :: Connection -> Int

receive heaertbeat timeout

lastSend :: Connection -> MVar UTCTime

last frame sent time

lastRecv :: Connection -> MVar UTCTime

last frame received time

versions :: Connection -> [Version]

accepted stomp versions