zhmcclient / python-zhmcclient / test-2561

82%

push

github

Used Queue for STOMP listener handover; Improved connection loss recovery

Details:

* Replaced the event-based handover of a single item from the notification
  listener thread to the caller's thread with a Python Queue, because that
  is more reliable.

* Added new methods 'connect()' and 'is_connected()' to the
  'NotificationReceiver' class.

* Added exceptions 'NotificationConnectionError' and
  'NotificationSubscriptionError'.

* The 'NotificationReceiver.notifications()' method now continues running
  when there are no notifications, and only ever returns when
  'NotificationReceiver.close()' is called (by some other thread).

* Added proper detection of STOMP connection loss if STOMP heartbeating is
  enabled. The connection loss is surfaced by raising
  'NotificationConnectionError' in 'NotificationReceiver.notifications()'.
  This allows users to retry 'NotificationReceiver.notifications()' upon
  connection loss.

* Added the missing event methods to the _NotificationListener class that
  are defined in stomp.ConnectionListener, in case they are ever invoked.
  The _NotificationListener class continues not to inherit from
  stomp.ConnectionListener in order to be continue to be able to lazy-import
  stomp.

* In the connected() event method in the _NotificationListener class, added
  a log message for the heartbeat parameters returned by the HMC.

* Changed the detection for connection loss to be in the notifications()
  method, and no longer in the disconnected() event method of the listener,
  since it turned out that that event method is called not on connection
  loss, but after the connection is re-established. This allowed for the
  first time to properly recover from connection loss.

* Added a new public constant 'STOMP_MIN_CONNECTION_CHECK_TIME' that defines
  the minimum time between checks for STOMP connection loss. The check time
  increases from this minimum with as the heartbeat receive time gets larger.

* Added more log mess... (continued)

78 of 154 new or added lines in 3 files covered. (50.65%)

8021 of 9992 relevant lines covered (80.27%)

11.74 hits per line