pulsar-client 2.4.1.pre.beta.1 → 2.4.1.pre.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e63f527c666d454aa9d86692fdf7ce62c5f0d8b9
-  data.tar.gz: f486f65c4a9b00e7dd7de8e5603a04976e93ef70
+  metadata.gz: bdac30fc88a91584ef35377492dbbb8dbde43cb1
+  data.tar.gz: f258ede389a3034b8f783f586489db1e15e8d781
 SHA512:
-  metadata.gz: bc954d9604c218777a5f7f3e22a7c23fd4457fafe9c5d6daeb33980d8cd45e549c6f6f32abf0e465ecedf07996a47bb34245c9b003133b27bfef00ceaec62227
-  data.tar.gz: e2d4d814048247c1d79061950767cafc9bc15793908a58c099d1ba4242cc889e38083fa4857f80cbe2a51cfa4155545d00d3e9587a7c78987cf662e547500a68
+  metadata.gz: 3dedd175bbbbe43ec40925cbbd55e738157272a89a4a0b27635b51adad5fef51e5faf284c0e683365c9d83a6b4904407673ccfe1670424a89b924fe74d97ff5c
+  data.tar.gz: 30cb9298ceca90c1178759d9b08f64951947e0c4c9464af6f1386dccb1402ca77aae900ba01a00e6f615b1bda8a2b20bdb6f8bb09f88a7e36e837600599a27bb

data/README.md

@@ -27,7 +27,7 @@ the `.pre` suffix in the Gemfile to install it via Bundler.
 
 ## Usage
 
-Example:
+Setup and basic `consumer.receive` example:
 
 ```ruby
 # have these in your shell with appropriate values
@@ -48,10 +48,35 @@ producer.send("Hello, world!")
 # named "hello-consumer"
 subscription = "hello-consumer"
 consumer = client.subscribe(topic, subscription)
-consumer.listen do |message|
-  puts message
-  break
+
+msg = consumer.receive
+message = msg.data
+puts "got #{message}"
+consumer.acknolwedge(msg)
+```
+
+Convenience method for listening to messages in a loop:
+
+```ruby
+consumer.listen do |message, _, done|
+  # process message here; call done to stop the loop.
+  # messages are auto-acknowledged.
+  puts "got #{message}"
+  done.call()
+end
+```
+
+Convenience method for listening on a separate thread:
+
+```ruby
+listenerThread = consumer.listen_in_thread do |message, _, done|
+  # process message here; call done to stop the loop.
+  # messages are auto-acknowledged.
+  puts "got #{message}"
+  done.call()
 end
+# ...
+listenerThread.join # wait for the thread to finish
 ```
 
 (more documentation coming; see TODO.md)

data/ext/bindings/bindings.cpp

@@ -4,6 +4,7 @@
 #include "producer.hpp"
 #include "consumer.hpp"
 #include "client.hpp"
+#include "util.hpp"
 
 using namespace Rice;
 
@@ -11,6 +12,7 @@ extern "C"
 void Init_bindings()
 {
   Module rb_mPulsar = define_module("Pulsar");
+  bind_errors(rb_mPulsar);
   bind_message(rb_mPulsar);
   bind_producer(rb_mPulsar);
   bind_consumer(rb_mPulsar);

data/ext/bindings/consumer.cpp

@@ -11,25 +11,30 @@ namespace pulsar_rb {
 
 typedef struct {
   pulsar::Consumer& consumer;
+  unsigned int timeout_ms;
   pulsar::Message message;
   pulsar::Result result;
 } consumer_receive_job;
 
 void* consumer_receive_nogvl(void* jobPtr) {
   consumer_receive_job& job = *(consumer_receive_job*)jobPtr;
-  job.result = job.consumer.receive(job.message);
+  if (job.timeout_ms > 0) {
+    job.result = job.consumer.receive(job.message, job.timeout_ms);
+  } else {
+    job.result = job.consumer.receive(job.message);
+  }
   return nullptr;
 }
 
-pulsar::Message consumer_receive(pulsar::Consumer& consumer) {
-  consumer_receive_job job = { consumer };
+pulsar::Message consumer_receive(pulsar::Consumer& consumer, unsigned int timeout_ms) {
+  consumer_receive_job job = { consumer, timeout_ms };
   rb_thread_call_without_gvl(&consumer_receive_nogvl, &job, RUBY_UBF_IO, nullptr);
   CheckResult(job.result);
   return job.message;
 }
 
-Message::ptr Consumer::receive() {
-  pulsar::Message message = consumer_receive(_consumer);
+Message::ptr Consumer::receive(unsigned int timeout_ms) {
+  pulsar::Message message = consumer_receive(_consumer, timeout_ms);
   return Message::ptr(new Message(message));
 }
 
@@ -48,7 +53,7 @@ using namespace Rice;
 void bind_consumer(Module &module) {
   define_class_under<pulsar_rb::Consumer>(module, "Consumer")
     .define_constructor(Constructor<pulsar_rb::Consumer>())
-    .define_method("receive", &pulsar_rb::Consumer::receive)
+    .define_method("receive", &pulsar_rb::Consumer::receive, (Arg("timeout_ms") = 0))
     .define_method("acknowledge", &pulsar_rb::Consumer::acknowledge)
     .define_method("negative_acknowledge", &pulsar_rb::Consumer::negative_acknowledge)
     ;

data/ext/bindings/consumer.hpp

@@ -14,7 +14,7 @@ namespace pulsar_rb {
     Consumer() {};
     Consumer(const pulsar::Consumer& consumer) : _consumer(consumer) {}
 
-    Message::ptr receive();
+    Message::ptr receive(unsigned int timeout_ms=0);
     void acknowledge(const Message& message);
     void negative_acknowledge(const Message& message);
 

data/ext/bindings/util.cpp

@@ -1,11 +1,23 @@
 #include <pulsar/Client.h>
 
 #include "util.hpp"
+#include "rice/Exception.hpp"
 
-using namespace pulsar;
+using namespace Rice;
 
-void CheckResult(Result res) {
-  if (res != ResultOk) {
-    throw PulsarException(res);
+VALUE rb_ePulsarError = Qnil;
+VALUE rb_ePulsarError_Timeout = Qnil;
+
+void bind_errors(Module &module) {
+  rb_ePulsarError = rb_define_class_under(module.value(), "Error", rb_eStandardError);
+  rb_ePulsarError_Timeout = rb_define_class_under(rb_ePulsarError, "Timeout", rb_ePulsarError);
+}
+
+void CheckResult(pulsar::Result res) {
+  if (res == pulsar::ResultTimeout) {
+    throw Exception(rb_ePulsarError_Timeout, "pulsar timeout");
+  }
+  else if (res != ResultOk) {
+    throw Exception(rb_ePulsarError, "unexpected pulsar exception: %d", res);
   }
 }

data/ext/bindings/util.hpp

@@ -1,16 +1,13 @@
 #ifndef __PULSAR_RUBY_CLIENT_UTIL_HPP
 #define __PULSAR_RUBY_CLIENT_UTIL_HPP
 
+#include "rice/Module.hpp"
 #include <pulsar/Client.h>
 
 using namespace pulsar;
 
-struct PulsarException {
-    Result _result;
-    PulsarException(Result res) :
-            _result(res) {}
-};
-
 void CheckResult(Result res);
 
+void bind_errors(Rice::Module& module);
+
 #endif

data/lib/pulsar/client/version.rb

@@ -19,6 +19,6 @@
 
 module Pulsar
   class Client
-    VERSION = "2.4.1-beta.1"
+    VERSION = "2.4.1-beta.2"
   end
 end

data/lib/pulsar/client.rb

@@ -37,8 +37,10 @@ module Pulsar
         super(topic, config)
       end
 
-      def subscribe(topic, subscription_name, config=nil)
-        config ||= Pulsar::ConsumerConfiguration.new
+      def subscribe(topic, subscription_name, config={})
+        unless config.is_a?(Pulsar::ConsumerConfiguration)
+          config = Pulsar::ConsumerConfiguration.new(config)
+        end
         super(topic, subscription_name, config)
       end
     end

data/lib/pulsar/consumer.rb

@@ -45,7 +45,7 @@ module Pulsar
     end
 
     def listen_in_thread
-      Thread.new { listen }
+      Thread.new { listen {|*args| yield *args }}
     end
   end
 end

data/lib/pulsar/consumer_configuration.rb

@@ -34,6 +34,11 @@ module Pulsar
     }
 
     module RubySideTweaks
+      def initialize(config={})
+        super()
+        self.consumer_type = config.consumer_type if config.has?(:consumer_type)
+      end
+
       def consumer_type
         enum_value = super
         CONSUMER_TYPES.invert[enum_value]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pulsar-client
 version: !ruby/object:Gem::Version
-  version: 2.4.1.pre.beta.1
+  version: 2.4.1.pre.beta.2
 platform: ruby
 authors:
 - Jacob Fugal