StompActors

A suite of Celluloid actors to interact with Stomp protocol, using OnStomp gem.

Installation

Add this line to your application's Gemfile:

gem 'stomp_actors'

And then execute:

$ bundle

Or install it yourself as:

$ gem install stomp_actors

Usage

Consumers

Inherit from StompActors::Consumer then define #queue and #uri values, and #receive(msg) method.

Define #subscribe_opts to customize subscription options.

Use ack(msg) to acknowledge message, if needed.

Example:

class MyConsumer < StompActors::Consumer
  def uri
    "stomp://127.0.0.1:61613"
  end

  def queue
    "/queue/foo"
  end

  def subscribe_opts
    { ack: 'client' }
  end

  def receive(msg)
    # do something with msg
    ack(msg)
  end
end

MyConsumer.new # your actor is now subscribed and will receive messages.

Producers

Inherit from StompActors::Producer then define #queue and #uri values.

Use emit(msg) to send message to the defined queue.

Example:

class MyProducer < StompActors::Producer
  def uri
    "stomp://127.0.0.1:61613"
  end

  def queue
    "/queue/foo"
  end
end

p = MyProducer.new
p.emit("stuff") # message sent to queue

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request