Rocketmq Client For Ruby

A Ruby FFI binding to librocketmq.

Notice 1: This client is still in dev version. Use it cautiously in production.

Notice 2: This SDK is now only support macOS and Linux and only test on Ubuntu.

Prerequisites

Install librocketmq

rocketmq-client-python is a lightweight wrapper around rocketmq-client-cpp, so you need install librocketmq first.

Download by binary release.

download specific release according you OS: rocketmq-client-cpp-2.0.0

• centos

  take centos7 as example, you can install the library in centos6 by the same method.

      wget https://github.com/apache/rocketmq-client-cpp/releases/download/2.0.0/rocketmq-client-cpp-2.0.0-centos7.x86_64.rpm
      sudo rpm -ivh rocketmq-client-cpp-2.0.0-centos7.x86_64.rpm

• debian

      wget https://github.com/apache/rocketmq-client-cpp/releases/download/2.0.0/rocketmq-client-cpp-2.0.0.amd64.deb
      sudo dpkg -i rocketmq-client-cpp-2.0.0.amd64.deb

• macOS

      wget https://github.com/apache/rocketmq-client-cpp/releases/download/2.0.0/rocketmq-client-cpp-2.0.0-bin-release.darwin.tar.gz
      tar -xzf rocketmq-client-cpp-2.0.0-bin-release.darwin.tar.gz
      cd rocketmq-client-cpp
      mkdir /usr/local/include/rocketmq
      cp include/* /usr/local/include/rocketmq
      cp lib/* /usr/local/lib
      install_name_tool -id "@rpath/librocketmq.dylib" /usr/local/lib/librocketmq.dylib

Build from source

you can also build it manually from source according to Build and Install

Installation

Add this line to your application's Gemfile:

gem 'rocketmq-client-ruby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rocketmq-client-ruby

Usage

Producer

require 'rocketmq-client-ruby'
producer = Client::Producer.new('PID-XXX')
producer.set_name_server_address('0.0.0.0:9876')
producer.start()

msg = Client::Message.new('YOUR-TOPIC')
msg.set_keys('key')
msg.set_tags('tag')
msg.set_body('hello, world')
ret = producer.send_sync(msg)
producer.shutdown()

PushConsumer

require 'rocketmq-client-ruby'
consumer = Client::PushConsumer.new('CID-XXX')
consumer.set_name_server_address('0.0.0.0:9876')
callback = -> (msg) {
    puts "received #{msg.id} #{msg.body}"
    return Rocketmq::C::ConsumeStatus[:consume_success]
}
consumer.subscribe('YOUR-TOPIC', callback)
consumer.start()

while true
 sleep(60)
end

consumer.shutdown()

Demo

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/edmondfrank/rocketmq-client-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Community Guidelines code of conduct.

License

• License::Apache License, Version 2.0