lightstreamer 0.11 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 712d0f7cae7367c26efde5f75b0481bb5a3d90a3
-  data.tar.gz: 77a6882d44273754bb5c85a7739bb614860b7b82
+  metadata.gz: 979c7fa279f1b55d71b9525b8a8f5b67aaf1c45e
+  data.tar.gz: 15a5a203a5012063ab4b795d60486bc7c9882cad
 SHA512:
-  metadata.gz: e6eec1efbbd9e79c891798f8833a820396caa40b0bbb275eee686b95cc93689651e7703495949953d66ea80e95278e0b3f2203e2ad032a1861981426d082473b
-  data.tar.gz: 6164a9f932129439f3870081d55962ebae8f35f44169269f366bd64d2222d66d6bbd14e25fd92b9d59bfe7d3bff8ec52f8f8a5af8ee44a4cd6c144ccd9635377
+  metadata.gz: 8af68aba835e410dd291393dc187a1ac2af83d9406dfb34278c0ec2d5ecbb24cbb41cea1cfbe198407a21e47e1229a9ded930ec3ed394539f7caa63caf2dbc64
+  data.tar.gz: 8246eea6cf6d897232791b5a225e5d75f97bf954ca5c0742c63f86ac75225c657ee119ea5c1ea0b6308b68ef801e4f1bfb517c172d5a85b5372ab479ef3d4021

data/CHANGELOG.md

@@ -1,12 +1,18 @@
 # Lightstreamer Changelog
 
+### 0.12 — August 20, 2016
+
+- Added `Lightstreamer::Session#remove_subscriptions`
+- Removed `Lightstreamer::Subscription#session`, subscriptions now hold a weak reference to their session in order to
+  prevent a circular reference
+
 ### 0.11 — August 20, 2016
 
 - Added `Lightstreamer::Session#stop_subscriptions` for stopping multiple subscriptions in one request
 - Renamed `Lightstreamer::Session#bulk_subscription_start` to `Lightstreamer::Session#start_subscriptions`
 - Added support for combining all subscription actions via `Lightstreamer::Session#perform_subscription_actions`
   which allows subscription start, unsilence and stop requests to be easily bundled together
-- Fixed `Subscription#id` only being callable on the main thread
+- Fixed `Lightstreamer::Subscription#id` only being callable on the main thread
 
 ### 0.10 — August 5, 2016
 

data/README.md

@@ -40,8 +40,8 @@ $ gem install lightstreamer
 
 The two primary classes that make up the public API are:
 
-- [`Lightstreamer::Session`](http://www.rubydoc.info/github/rviney/lightstreamer/Lightstreamer/Session)
-- [`Lightstreamer::Subscription`](http://www.rubydoc.info/github/rviney/lightstreamer/Lightstreamer/Subscription)
+- [`Lightstreamer::Session`](http://www.rubydoc.info/github/rviney/lightstreamer/master/Lightstreamer/Session)
+- [`Lightstreamer::Subscription`](http://www.rubydoc.info/github/rviney/lightstreamer/master/Lightstreamer/Subscription)
 
 The following code demonstrates how to create a Lightstreamer session, build a subscription, then use a thread-safe
 queue to print streaming output as it arrives.

data/lib/lightstreamer.rb

@@ -1,4 +1,5 @@
 require 'thread'
+require 'weakref'
 
 require 'excon'
 require 'thor'

data/lib/lightstreamer/session.rb

@@ -92,7 +92,8 @@ module Lightstreamer
       @stream_connection && @stream_connection.session_id
     end
 
-    # Disconnects this Lightstreamer session and terminates the session on the server. All worker threads are exited.
+    # Disconnects this Lightstreamer session and terminates the session on the server. All worker threads are exited,
+    # and all subscriptions created during the connected session can no longer be used.
     def disconnect
       control_request LS_op: :destroy if @stream_connection
 
@@ -102,6 +103,7 @@ module Lightstreamer
       @processing_thread.exit if @processing_thread
 
       @subscriptions.each { |subscription| subscription.after_control_request :stop }
+      @subscriptions = []
 
       @processing_thread = @stream_connection = nil
     end
@@ -147,9 +149,29 @@ module Lightstreamer
     #
     # @param [Subscription] subscription The subscription to stop and remove from this session.
     def remove_subscription(subscription)
-      subscription.stop
+      errors = remove_subscriptions [subscription]
+
+      raise errors.first if errors.first
+    end
+
+    # Stops the specified subscriptions and removes them from this session. To just stop subscriptions with the option
+    # of restarting them at a later date use {#stop_subscriptions} or {Subscription#stop}. The return value is an array
+    # with one entry per subscription and indicates the error state returned by the server for that subscription's stop
+    # request, or `nil` if no error occurred.
+    #
+    # @param [Array<Subscription>] subscriptions The subscriptions to stop and remove from this session.
+    #
+    # @return [Array<LightstreamerError, nil>]
+    def remove_subscriptions(subscriptions)
+      errors = stop_subscriptions subscriptions
+
+      @mutex.synchronize do
+        subscriptions.reject(&:active).each do |subscription|
+          @subscriptions.delete subscription
+        end
+      end
 
-      @mutex.synchronize { @subscriptions.delete subscription }
+      errors
     end
 
     # This method performs {Subscription#start} on all the passed subscriptions. Calling {Subscription#start} on each

data/lib/lightstreamer/subscription.rb

@@ -4,11 +4,6 @@ module Lightstreamer
   # streaming subscription data can be consumed by registering an asynchronous data callback using {#on_data}, or by
   # polling using {#item_data}.
   class Subscription
-    # The session that this subscription is associated with.
-    #
-    # @return [Session]
-    attr_reader :session
-
     # The names of the items to subscribe to.
     #
     # @return [Array]
@@ -58,7 +53,7 @@ module Lightstreamer
     def initialize(session, options)
       @mutex = Mutex.new
 
-      @session = session
+      @session = WeakRef.new session
       @items = options.fetch(:items)
       @fields = options.fetch(:fields)
       @mode = options.fetch(:mode).to_sym
@@ -97,7 +92,7 @@ module Lightstreamer
     def start(options = {})
       return if @active
 
-      session.control_request control_request_options(:start, options)
+      @session.control_request control_request_options(:start, options)
       after_control_request :start
     end
 
@@ -105,14 +100,14 @@ module Lightstreamer
     # this subscription was not started in silent mode then this method has no effect. If an error occurs then a
     # {LightstreamerError} subclass will be raised.
     def unsilence
-      session.control_request control_request_options(:unsilence)
+      @session.control_request control_request_options(:unsilence)
       after_control_request :unsilence
     end
 
     # Stops streaming data for this Lightstreamer subscription. If an error occurs then a {LightstreamerError} subclass
     # will be raised.
     def stop
-      session.control_request control_request_options(:stop) if @active
+      @session.control_request control_request_options(:stop) if @active
       after_control_request :stop
     end
 
@@ -125,7 +120,7 @@ module Lightstreamer
     #        details.
     def maximum_update_frequency=(new_frequency)
       new_frequency = sanitize_frequency new_frequency
-      session.control_request LS_op: :reconf, LS_table: id, LS_requested_max_frequency: new_frequency if @active
+      @session.control_request LS_op: :reconf, LS_table: id, LS_requested_max_frequency: new_frequency if @active
       @maximum_update_frequency = new_frequency
     end
 
@@ -224,9 +219,9 @@ module Lightstreamer
       when :start
         start_control_request_options options
       when :unsilence
-        { LS_session: session.session_id, LS_op: :start, LS_table: id }
+        { LS_session: @session.session_id, LS_op: :start, LS_table: id }
       when :stop
-        { LS_session: session.session_id, LS_op: :delete, LS_table: id }
+        { LS_session: @session.session_id, LS_op: :delete, LS_table: id }
       end
     end
 
@@ -286,7 +281,7 @@ module Lightstreamer
 
       operation = options[:silent] ? :add_silent : :add
 
-      { LS_session: session.session_id, LS_op: operation, LS_table: id, LS_mode: mode.to_s.upcase, LS_id: items,
+      { LS_session: @session.session_id, LS_op: operation, LS_table: id, LS_mode: mode.to_s.upcase, LS_id: items,
         LS_schema: fields, LS_selector: selector, LS_snapshot: options.fetch(:snapshot, false),
         LS_requested_max_frequency: maximum_update_frequency, LS_data_adapter: data_adapter }
     end

data/lib/lightstreamer/version.rb

@@ -1,4 +1,4 @@
 module Lightstreamer
   # The version of this gem.
-  VERSION = '0.11'.freeze
+  VERSION = '0.12'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lightstreamer
 version: !ruby/object:Gem::Version
-  version: '0.11'
+  version: '0.12'
 platform: ruby
 authors:
 - Richard Viney