pubcontrol 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8535c6bdbb6bfd0abeb75b7dc08a4d561bb679b
-  data.tar.gz: 9f019cc934e4cebdd07d84b7f662503eb44d1661
+  metadata.gz: 36d18a43fb9eccdb7b0090e848c793d2e542832d
+  data.tar.gz: d7054ee29c3dc2c62042dae493d5de1ce96721ca
 SHA512:
-  metadata.gz: f159d79255a34f0969f4ad71a9e00ec29518ec7e743298e35023b4037e91782e613fea8fc2bada8ff90475b0306841f207c39565523c8a43e58feff2bfadff00
-  data.tar.gz: 6eef70a1cb4d6049218dc5d69347b74c85e200a9d563ca33a6cf7b44605d2db9f446d5b755dfca59767c675a94cfb0d30c1e6a785f864877ef43cfc275284adf
+  metadata.gz: 1c8fd3c684fde6b24183d29740f62ee5b91aebb27393a318caefd423615eef57f650b33a716a4e29dcc2de505e3db3760987b653b74dba7f88d22586dfc585ca
+  data.tar.gz: 51920a6f60f0e0686d7284704393c85d267fc9f11ff2dc8d1f80629e0d133b073037cfb3d9fad88208c0d166b9c5958c9660fab59247a07b0ec8c020f2e66e35

data/lib/pubcontrol.rb

@@ -10,20 +10,34 @@ require_relative 'item.rb'
 require_relative 'pubcontrolclient.rb'
 require_relative 'pcccbhandler.rb'
 
+# Register the close_pubcontrols method with at_exit to ensure that it is
+# called on exit.
+at_exit do
+  PubControl.close_pubcontrols
+end
+
 # The PubControl class allows a consumer to manage a set of publishing
 # endpoints and to publish to all of those endpoints via a single publish
 # or publish_async method call. A PubControl instance can be configured
 # either using a hash or array of hashes containing configuration information
 # or by manually adding PubControlClient instances.
 class PubControl
+  # The global list of PubControl instances used to ensure that each instance
+  # is properly closed on exit.
+  @@pubcontrols = Array.new
+  @@lock = Mutex.new
 
   # Initialize with or without a configuration. A configuration can be applied
   # after initialization via the apply_config method.
   def initialize(config=nil)
     @clients = Array.new
+    @closed = false
     if !config.nil?
       apply_config(config)
     end
+    @@lock.synchronize do
+      @@pubcontrols.push(self)
+    end
   end
 
   # Remove all of the configured PubControlClient instances.
@@ -54,15 +68,40 @@ class PubControl
     end
   end
 
-  # The finish method is a blocking method that ensures that all asynchronous
-  # publishing is complete for all of the configured PubControlClient
-  # instances prior to returning and allowing the consumer to proceed.
-  def finish
+  # The close method is a blocking call that closes all ZMQ sockets and
+  # ensures that all PubControlClient async publishing is completed prior
+  # to returning and allowing the consumer to proceed. Note that the
+  # PubControl instance cannot be used after calling this method.
+  def close
+    close_clients
+    unregister_pubcontrol
+  end
+
+  # Internal close method, used during shutdown while class lock is held.
+  def close_locked
+    close_clients
+    unregister_pubcontrol_locked
+  end
+
+  # This method is a blocking method that ensures that all asynchronous
+  # publishing is complete for all of the configured client instances prior
+  # to returning and allowing the consumer to proceed.
+  # NOTE: This only applies to PubControlClient and not ZmqPubControlClient
+  # since all ZMQ socket operations are non-blocking.
+  def wait_all_sent
+    verify_not_closed
     @clients.each do |pub|
-      pub.finish
+      pub.wait_all_sent
     end
   end
 
+  # DEPRECATED: The finish method is now deprecated in favor of the more
+  # descriptive wait_all_sent method.
+  def finish
+    verify_not_closed
+    wait_all_sent
+  end
+
   # The synchronous publish method for publishing the specified item to the
   # specified channels for all of the configured PubControlClient instances.
   def publish(channels, item)
@@ -87,4 +126,47 @@ class PubControl
       pub.publish_async(channels, item, cb)
     end
   end
+
+  # An internal method used for closing all existing PubControl instances.
+  def self.close_pubcontrols
+    @@lock.synchronize do
+      pubcontrols = Array.new(@@pubcontrols)
+      pubcontrols.each do |pub|
+        pub.close_locked
+      end
+    end
+  end
+
+  private
+
+  # An internal method for verifying that the PubControl instance has
+  # not been closed via the close() method. If it has then an error
+  # is raised.
+  def verify_not_closed
+    if @closed
+      raise 'pubcontrol instance is closed'
+    end
+  end
+
+  # Internal method to close clients.
+  def close_clients
+    verify_not_closed
+    @clients.each do |pub|
+      pub.close()
+    end
+    @closed = true
+  end
+
+  # Internal method to unregister from the list of pubcontrols.
+  def unregister_pubcontrol
+    @@lock.synchronize do
+      @@pubcontrols.delete(self)
+    end
+  end
+
+  # Internal method to unregister from the list of pubcontrols, used during
+  # shutdown while class lock is held.
+  def unregister_pubcontrol_locked
+    @@pubcontrols.delete(self)
+  end
 end

data/lib/pubcontrolclient.rb

@@ -10,7 +10,7 @@ require 'thread'
 require 'base64'
 require 'jwt'
 require 'json'
-require 'net/http'
+require 'net/http/persistent'
 require_relative 'item.rb'
 
 # The PubControlClient class allows consumers to publish either synchronously 
@@ -34,6 +34,7 @@ class PubControlClient
     @auth_basic_pass = nil
     @auth_jwt_claim = nil
     @auth_jwt_key = nil
+    @http = Net::HTTP::Persistent.new @object_id.to_s
   end
 
   # Call this method and pass a username and password to use basic
@@ -91,10 +92,10 @@ class PubControlClient
     queue_req(['pub', uri, auth, exports, callback])
   end
 
-  # The finish method is a blocking method that ensures that all asynchronous
+  # This method is a blocking method that ensures that all asynchronous
   # publishing is complete prior to returning and allowing the consumer to 
   # proceed.
-  def finish
+  def wait_all_sent
     @lock.synchronize do
       if !@thread.nil?
         queue_req(['stop'])
@@ -104,6 +105,19 @@ class PubControlClient
     end
   end
 
+  # DEPRECATED: The finish method is now deprecated in favor of the more
+  # descriptive wait_all_sent method.
+  def finish
+    wait_all_sent
+  end
+
+  # This method closes the PubControlClient instance by ensuring all pending
+  # data is sent and any open connections are closed.
+  def close
+    wait_all_sent
+    @http.shutdown
+  end
+
   # A helper method for returning the current UNIX UTC timestamp.
   def self.timestamp_utcnow
     return Time.now.utc.to_i
@@ -124,8 +138,7 @@ class PubControlClient
       request['Authorization'] = auth_header
     end
     request['Content-Type'] = 'application/json'
-    use_ssl = uri.scheme == 'https'
-    response = make_http_request(uri, use_ssl, request)
+    response = make_http_request(uri, request)
     if !response.kind_of? Net::HTTPSuccess
       raise 'failed to publish: ' + response.class.to_s + ' ' +
           response.message
@@ -133,12 +146,9 @@ class PubControlClient
   end
 
   # An internal method for making the specified HTTP request to the
-  # specified URI with an option that determines whether to use
-  # SSL.
-  def make_http_request(uri, use_ssl, request)
-    response = Net::HTTP.start(uri.host, uri.port, use_ssl: use_ssl) do |http|
-      http.request(request)
-    end
+  # specified URI.
+  def make_http_request(uri, request)
+    response = @http.request uri, request
     return response
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pubcontrol
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Konstantin Bokarius
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
 description: A Ruby convenience library for publishing messages using the EPCP protocol
 email: bokarius@comcast.net
 executables: []
@@ -69,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby EPCP library