.. _news: ====== News ====== |project| 0.15 ============== .. edit-on-version-bump: remove this and issue tracker note if the downloads are no longer available This |project| release is available in the following forms: * Source archives * Pre-compiled self-installing archives or executable binaries * Debian packages for different |ubuntu| versions (currently C++ and Common Lisp implementations only) * Pypi packages for the |python| implementation * Maven package for the Java implementation These can be downloaded from the `0.15 jobs continuous integration server `_ or `repository server`_ respectively. :ref:`Installation instructions ` and links for downloading can be found in the |project| :ref:`manual `. As always, bugs, feature requests and enhancement proposals can be reported in the `issue tracker`_. Changes * All implementations * A new :term:`filter` which discriminates :term:`events ` based on :term:`causal vectors ` has been added. * :ref:`Configuration debugging ` using :envvar:`RSB_CONFIG_DEBUG` is now supported in all implementations. * The environment variable :envvar:`RSB_CONFIG_FILES` can be used to make |project| attempt to load :ref:`a non-default cascade of configuration files `. * :term:`Converters ` for the :term:`scope` :term:`data type` are now available in all implementations. * C++ * :term:`Converters ` for integer values are now provided by the generic :cpp:class:`rsb::converter::IntegerConverter`. * A few C++11 incompatibilities have been resolved. * Common Lisp Tools * The :term:`scope` monitor :term:`event` formatting style now collapses chains of :term:`scopes ` with exactly one :term:`subscope` into a single line to save vertical space. * The :ref:`web tool ` now provides a web interface for basic :term:`introspection` queries. .. note:: For a more detailed list of fixed bugs, added features and other enhancements, see https://code.cor-lab.org/versions/56. |project| 0.14 ============== .. edit-on-version-bump: remove this and issue tracker note if the downloads are no longer available This |project| release is available in the following forms: * Source archives * Pre-compiled self-installing archives or executable binaries * Debian packages for different |ubuntu| versions (currently C++ and Common Lisp implementations only) * Pypi packages for the |python| implementation * Maven package for the Java implementation These can be downloaded from the `0.14 jobs continuous integration server `_ or `repository server`_ respectively. :ref:`Installation instructions ` and links for downloading can be found in the |project| :ref:`manual `. As always, bugs, feature requests and enhancement proposals can be reported in the `issue tracker`_. Changes * C++ * :term:`Converters ` for ``float`` and ``double`` values have been added and are registered by default. * Setting the environment variable ``__CONFIG_DEBUG`` to an arbitrary value enables :ref:`configuration debugging `. Debug output is written to ``stderr``. * Java * `Spread`_ connections can now be shared between :term:`listeners ` (for :term:`informers `, this has been possible since |project| 0.12), which reduces the number of open connections to the :term:`Spread daemon`. * A :term:`converter ` for ``Float`` values has been added and is registered by default. * Timestamps are now generated with millisecond accuracy and precision on Linux and Mac by using native system calls if possible. Other platforms should not be broken by this and fall back to millisecond precision. Due to this change, the Java implementation has new dependencies now. * Common Lisp * :ref:`Filters ` are now more efficient. * Common Lisp Tools * All :ref:`tools` can now load :term:`data type` definitions on demand, lessening the pain of having to up-front specify and load all required definitions (See :option:`--on-demand-idl-loading `). * The :ref:`bridge ` tool now :term:`converts ` :term:`payloads ` iff required by a :term:`filter` or :term:`transform`, limiting the need to load :term:`data type` definitions to situations in which they are actually needed. * The :ref:`logger ` tool now accepts the :option:`--stop-after ` option, causing it to terminate after processing a specified number of :term:`events `. * An :term:`event` formatting style ``multiple-files`` for writing output into an individual file for each :term:`event ` has been added. * The new :ref:`server ` tool can act as a standalone |project| :ref:`socket ` :term:`transport` server. .. note:: For a more detailed list of fixed bugs, added features and other enhancements, see https://code.cor-lab.org/versions/51. |project| 0.13 ============== .. note:: This |project| release is only available in source code form from the `repository server`_. We no longer accept bug reports against this |project| version. Changes * |project| now has an official logo. * All languages * The APIs of the different language implementations have been unified. Please refer to the different language-specific sections and `issue 2222 `_ for details. * Manual * The API documentation links have been moved from the sidebar to a new item on the :ref:`start page ` of the manual along with the direct inclusion of the |python| API documentation in this manual. * C++ * The API has been adapted to match other implementations: * ``Event::{get,set}EventId`` has been renamed to ``{get,set}Id``. The previously existing and long time deprecated method ``getId`` has been removed during this process. * ``Event::getSequenceNumber`` has been deprecated in favor of the respective method on an ``EventId`` instance. * ``MetaData::{get,set}SenderId`` have been deprecated in favor of using the ``getParticipantId`` method on an ``EventId`` instance. * |project| C++ will now throw an exception in case a requested :term:`plugin` cannot be found (`issue #2487 `_). * The options ``plugins.cpp.path`` and ``plugins.cpp.load`` behave more consistently and allow inheriting values from the next more generic configuration source. * Python * The :ref:`API documentation ` is now included in this manual. * Java * The `Maven`_ repository server |project| java is deployed to has moved. You need to update your downstream projects accordingly to receive new versions of this project. Instructions can be found at :ref:`the installation instructions `. * The `ant `_ build system of |project| java has been dropped and the project has been converted to a proper `Maven`_ project using the standard file system layout conventions etc. `Ant `_ users can still use the project by including the `Maven`_-generated jar files. Also, the convenient zip archive containing the |project| java jar as well as the required upstream dependencies still exists. Please refer to the :ref:`installation instructions ` for further information and updated URLs resulting from this change. * The filter API has been refactored to match the API of the other language implementations. While ``AbstractFilter`` still provides the old API for client code, it has been deprecated in favor of directly implementing the much simplified ``Filter`` interface. Client code has to be updated. * ``InterruptedException``\ s are now handled correctly (i.e. not swallowed) and properly exposed to callers, who are the ones who need to handle them. This changes the API slightly. * ``RemoteServer`` exposes the standard ``java.util.concurrent.Future`` interface instead of a custom implementation class. This ensures compatibility with standard interfaces, prevents accidental exception hiding (as happened with ``InterruptedException``) and prevents clients from illegally completing a ``Future`` instance. As a consequence, the ``get`` method with just a ``long`` value as a timeout in milliseconds is not available anymore (that signature is not part of the standard ``Future`` interface). Always supplying an explicit ``TimeUnit`` makes things much clearer, anyway. This changes the API in an incompatible way and client code needs to be updated. * ``InvalidStateException`` has been removed and replaced with ``IllegalStateException``. The documented behavior was to throw ``IllegalStateException`` anyway in ``Activatable``. Please update your exception handlers in case you previously handled ``InvalidStateException``. * The RPC ``Callback`` API has been changed to only allow throwing ``Exception`` instances and not every ``Throwable``. This ensures that important things like out of memory errors are not caught uncontrollably by the framework. You probably only have to change the callback ``invoke`` method declarations to ``throws Exception``. * The ``Informer#send`` methods have been renamed to ``publish`` to match other implementations. The old names still exist for some time with a deprecation warning before they will be removed. * Common Lisp * The ``rsb.patterns`` package now provides a protocol for creating and managing child :term:`participants ` in composite :term:`participants `. * When acting as server, the :ref:`socket ` :term:`transport` can now :ref:`choose an unused port automatically ` if port number 0 is specified. The obtained port can be written to output streams or a file:: socket://localhost:0?server=1&portfile=- * Common Lisp Tools * Symbolic-link-based invocation and selection of sub-commands is no longer supported. * The default formatting style of the :ref:`logger ` is now "monitor" instead of "compact". * :term:`Scope` :term:`payloads ` are now printed properly as well as accepted by the :ref:`call ` and :ref:`send ` :ref:`tools `. * The :ref:`logger ` and :ref:`introspect ` tools use a human-readable, compact format similar to UNIX tools for numeric output like counts, sizes and durations. * The :term:`scope`\ -based monitor :term:`event` formatting style of the :ref:`logger ` now arranges :term:`scopes ` in a tree of adjustable maximum depth by default, allowing more compact display and therefore handling of larger systems. * An :term:`event` formatting style that outputs JSON data has been added. * A :ref:`bridge tool ` for forwarding of :term:`events ` between |project| buses has been implemented. * The :ref:`tool-send` and :ref:`tool-call` tools can now read :term:`payloads ` specifications in the `Google protocol buffers`_ debug text format from files. .. note:: For a more detailed list of fixed bugs, added features and other enhancements, see https://code.cor-lab.org/versions/47. |project| 0.12 ============== .. note:: This |project| release is only available in source code form from the `repository server`_. We no longer accept bug reports against this |project| version. Changes * Specification * A "display name" field has been added to the :term:`introspection` protocol and a corresponding :ref:`configuration option ` ``introspection.displayname`` has been added. Users can specify this configuration property for individual processes (e.g. via environment variables) to provide a custom name for the process, which is then e.g. shown by the :ref:`introspection tool `. * All languages * `Spread`_ connections are now shared between :term:`informers `, which reduces the number of open connections to the :term:`Spread daemon`. * C++ * The implementation now uses `Boost.Signals2 `_ instead of the deprecated version 1. This changes the external API for :term:`participant` hooks, which is rarely used externally. In case you have used these hooks, you need to migrate to the new signals namespaces and type names. * ``LocalServer::Callback`` implementations to reuse existing functions or methods have been added. * Several methods and types that have long been deprecated have been removed, including the method :cpp:func:`Factory::getInstance`. * Java * Several minor issues in the socket :term:`transport` implementation have been fixed. * Common Lisp * The ``rsb:with-listener``, ``rsb:with-reader``, ``rsb:with-informer``, ``rsb.patterns.request-reply:with-local-server`` and ``rsb.patterns.request-reply:with-remote-server`` macros have been replaced by ``rsb:with-active-participant`` and ``rsb:with-participant``. * Similarly, the ``rsb:make-listener``, ``rsb:make-reader``, ``rsb:make-informer``, ``rsb.patterns.request-reply:make-local-server`` and ``rsb.patterns.request-reply:make-remote-server`` functions have been replaced by ``rsb:make-participant``. * Common Lisp Tools * All tools now use a sub-command-based commandline syntax like :program:`git`, :program:`svn` and other modern commandline tools. The previous symbolic-link-based invocation will continue to work for a transition period. Example of the new syntax: .. code-block:: sh rsb-toolscl0.12 logger --style monitor socket: * The :ref:`tool-send` and :ref:`tool-call` tools now accept :term:`payloads ` specified using the `Google protocol buffers`_ debug text format. * A new experimental :ref:`tool-web` tool which serves information about an |project| system via HTTP has been added. .. warning:: Experimental - use with care. .. note:: For a more detailed list of fixed bugs, added features and other enhancements, see https://code.cor-lab.org/versions/42. |project| 0.11 ============== .. note:: This |project| release is only available in source code form from the `repository server`_. We no longer accept bug reports against this |project| version. .. note:: Starting with this release, the :ref:`request-reply communication pattern ` uses a new protocol. As a result, request-reply communication is not be possible between earlier versions and this version of |project|. .. note:: Although never "officially" supported, the |python| implementation previously allowed constructing :term:`participants ` by using the constructors of the respective classes. This is now explicitly unsupported. :py:func:`rsb.createListener` etc. have to be used instead. Changes * :term:`Introspection` |project| now supports inspecting the :term:`participants `, processes and hosts comprising a running system. * Specification * :term:`subscopes ` of ``/__rsb/`` are now :ref:`reserved ` for implementation purposes. The :ref:`tool-logger` will not display :term:`events ` on these :term:`scopes ` by default. * An :ref:`introspection protocol ` which works in terms of ordinary |project| :term:`events ` has been added. * :ref:`Request-reply communication pattern ` * The ``request`` and ``reply`` components have been removed from the :term:`scopes ` of :term:`participants ` implementing the communication protocol. * C++ * Support for sending :term:`introspection` information has been added as a :term:`plugin`. * The build system now provides the `CMake`_ variable ``RSB_SYSTEM_PLUGIN_DIRECTORY`` for downstream projects. * New :term:`filter` class :cpp:class:`rsb::filter::MethodFilter` * New :term:`filter` class :cpp:class:`rsb::filter::TypeFilter` * Tools based on and examples for the C++ implementation now use the RSC functions :cpp:func:`rsc::misc::waitForSignal` and :cpp:func:`rsc::misc::lastArrivedSignal` to terminate with proper cleanup of |project| objects. * The entry names for the enum `rsb::transport::Directions` have been prefixed with `DIRECTION_` in order to prevent clashes with preprocessor symbols. * It is now safe to maintain participants in static variables since all transports have been rewritten so that the unknown order of static destruction is not a problem anymore. * Java * Support for sending :term:`introspection` information has been added as a package. * Python * Support for sending :term:`introspection` information has been added as a package. * New :term:`filter` class :py:class:`rsb.filter.MethodFilter` * :py:func:`rsb.createServer` has been renamed to :py:func:`rsb.createLocalServer`. For backward compatibility, the former function has been retained as a deprecated alias for the latter. * Common Lisp * Support for sending :term:`introspection` information has been added as part of the ``rsb-introspection`` system. * Support for receiving and aggregating :term:`introspection` information has been added as part of the ``rsb-introspection`` system. * :term:`Participants ` can be created generically using the generic function ``make-participant`` which is backed by a service-provider protocol for registering, instantiating and inspecting kinds of :term:`participants `. * Creation and state changes of :term:`participants ` can now be monitored via ``*make-participant-hook*`` and ``*participant-state-change-hook*``. * The implementation of the :ref:`Request-reply pattern ` has moved from package ``rsb.patterns`` to package ``rsb.patterns.request-reply``. * Common Lisp Tools * The new :ref:`tool-introspect` tool collects and displays :term:`introspection` information. * Some problems (e.g. starting the :ref:`tool-logger` with a :term:`scope` option or without URI scheme) in the :ref:`URI ` handling of the Common Lisp tools have been solved. * All column-based :term:`event` formatting styles now compute (mostly) optimal column widths dynamically instead of choosing from a set of predefined layouts. * The timeline view of the :ref:`tool-logger` can now handle :term:`events ` whose timestamps lie in the past or future. * The timestamp used to construct the timeline view of the :ref:`tool-logger` is now configurable. * A new :term:`event` formatting style ``monitor/timeline`` has been added. * Monitor and timeline views of the :ref:`tool-logger` now accept :samp:`:sort-column {COLUMN}` and :samp:`:sort-reverse? {BOOLEAN}` arguments. * Monitor and timeline views of the :ref:`tool-logger` can now remove entries after a configurable time of inactivity. * The :ref:`tool-logger` now accepts multiple URIs .. note:: For a more detailed list of fixed bugs, added features and other enhancements, see https://code.cor-lab.org/versions/41. |project| 0.10 ============== .. note:: Starting with this release, |ubuntu| lucid is no longer officially supported. At least for C++, the `CMake`_ scripts will most likely not work. .. note:: This |project| release is only available in source code form from the `repository server`_. We no longer accept bug reports against this |project| version. Changes * C++ * Special `CMake`_ -level support for finding custom installations of the Boost.UUID library has been dropped as this library is a standard part of Boost since some time now. * Incompatible API change: Moved ``EventQueuePushHandler`` and ``QueuePushHandler`` to ``util`` namespace * Improved logging, error messages and API for :term:`converter` selection, configuration and registration * :term:`Converter` registration is no longer necessary for the inprocess :term:`transport` * Zip archive for Windows * Java * Added inprocess :term:`transport` * Fixed implementation of :term:`sequence number` generation * Some thread-safety and shutdown issues in the socket :term:`transport` have been fixed * Default :term:`participant` configuration is now available via ``getDefaulParticipantConfig`` * Updated internal :term:`Spread` Java implementation to version 4.3. This still allows communication with all 4.x :term:`Spread` daemons. * Python * :term:`Participants ` now support the context manager protocol (``with`` statements) * The :ref:`configuration ` file at :samp:`{PREFIX}/etc/rsb.conf` is now processed * Common Lisp * Socket :term:`transport` now listens on all interfaces in server mode * Socket :term:`transport` now handles disconnected clients better while under load * Logging is now implemented using a more robust and more efficient implementation. The user-visible interface remains unchanged. * Tools * The Common Lisp implementation of the tools now comes with scripts for analyzing some timing-related aspects of system. These scripts can be used by the :ref:`tool-logger` as well as the RSBag tools. .. note:: For a more detailed list of fixed bugs, added features and other enhancements, see https://code.cor-lab.org/versions/11. |project| 0.9 ============= .. note:: In the C++ implementation, the :term:`Spread` :term:`transport` is now implemented as a :term:`plugin`. In case of problems, see :ref:`troubleshooting-spread-does-not-work`. .. note:: This |project| release is only available in source code form from the `repository server`_. We no longer accept bug reports against this |project| version. Changes * Integration of the new RSC :term:`plugin` mechanism in the C++ implementation for :term:`transports ` and :term:`converters ` * Encapsulation of the :term:`spread` :term:`transport` into a separate :term:`plugin` * Complete overhaul of the Java implementation to be in line with the remaining implementations * As a consequence, the public API has slightly changed, especially with respect to thrown exceptions * Implementation of the :ref:`socket ` :term:`transport` * Fixes in all implementations of the :ref:`socket ` :term:`transport` * The :ref:`RPC API ` now supports some method signatures that did not work previously * Fixes for Windows compatibility * Documentation improvements .. note:: For a more detailed list of fixed bugs, added features and other enhancements, see https://code.cor-lab.org/versions/12. |project| 0.7 ============= .. note:: * Only the :ref:`TCP-socket transport ` is now enabled by default. For :term:`transport` configuration issues see :ref:`troubleshooting`. * |project| and related projects are now maintained in a `git`_ repository. See https://code.cor-lab.org/news/21 for more information. The git URL is |repository|. To obtain |project| with all submodules, use the following command: .. code-block:: sh $ git clone --recursive https://code.cor-lab.org/git/rsb.git .. note:: This |project| release is only available in source code form from the `repository server`_. We no longer accept bug reports against this |project| version. Changes * The :ref:`TCP-socket transport ` is now fully implemented in C++, Python and Common Lisp and used by default there. * Error recovery, robustness and features of |project| * End-user documentation * Packaging and deployment * :ref:`send ` tool .. note:: For a more detailed list of fixed bugs, added features and other enhancements, see https://code.cor-lab.org/versions/22. |project| 0.6 ============= .. note:: |project| clients using the 0.6 version cannot generally communicate with clients using a previous |project| version. .. note:: This |project| release is only available in source code form from the `repository server`_. We no longer accept bug reports against this |project| version. General Changes * All core components have been relicensed to `LGPLv3`_. * Sub-projects have been cleaned up. * Manuals have been created and can be accessed at |documentation_root|/rsb-manual/0.6/html. For a list of all documentation, see |documentation_root|. * |project| programs now process |system_config_file| if such a file exists. Tools * The C++ :ref:`logger ` now has a "monitor mode" * The C++ :ref:`logger ` can now print :term:`event` collections * The Common Lisp :ref:`logger ` adjusts its display to the width of the containing terminal * The Common Lisp :ref:`logger ` can now print :term:`event` collections .. note:: For a more detailed list of fixed bugs, added features and other enhancements, see https://code.cor-lab.org/projects/rsb/versions/25. |project| 0.5 ============= .. note:: * |project| clients using the 0.5 version of |project| cannot generally communicate with clients using a previous |project| version. * The :term:`Spread` :term:`transport` is no longer active by default (see below). * The API is in some parts not backwards-compatible. .. note:: This |project| release is only available in source code form from the `repository server`_. We no longer accept bug reports against this |project| version. The development activities in this cycle focused primarily on API improvements and the integration of :term:`causal vectors `. Moreover, complete compatibility for MSVC 2010 is now ensured and MacOS compatibility has been improved. In the process, about 60 issues have been created and subsequently resolved. General Changes * A tutorial is now included in the |project| source tree: "0.5" branch of |repository_tutorials| * Several introductory talks are now included in the |project| source tree: "0.5" branch of |repository_talks| * "RSB-related build jobs":https://ci.cor-lab.de/view/rsb-0.5 on the continuous integration sever have been reorganized. * Simple benchmarking tools are available in the ``rsbench`` project. * The ``#rsb`` IRC channel on the freenode network can now be used for additional support and discussion. * :ref:`Installation instructions ` have been improved. Network Protocol and Configuration * :term:`Causal vectors ` have been added to the network protocol. They allow to tag which :term:`event` or :term:`events ` caused a given :term:`event`. * The default :term:`transport` configuration has been changed: * The inprocess :term:`transport` is now enabled by default * The :term:`Spread` :term:`transport` is now disabled by default and has to be enabled explicitly when network communication is desired. This can e.g. be done by adding the user configuration file :file:`~/.config/rsb.conf` with the following content: .. code-block:: ini [transport.spread] enabled = 1 [transport.inprocess] enabled = 0 Tools * The C++ :ref:`logger ` now displays :term:`causal vectors `. * The Common Lisp :ref:`logger ` now displays :term:`causal vectors `. * The Common Lisp :ref:`logger ` now displays configurable statistics. * The Common Lisp :ref:`logger ` now allows configuring the columns in the "compact" formatting style. * The :ref:`call ` tool for performing RPCs from the commandline has been added. C++ * Support for :term:`causal vectors ` has been added. * The client API for creation and configuration of :term:`participants ` and :term:`events ` has been simplified. * Convenience functions for participant creation without the factory have been added. (Suggested by: Robert Haschke) * ``OriginFilter`` has been added. * Compilation time has been reduced. (Suggested by: Matthias Rolf) * A name-clash with a Qt macro has been resolved (Reported by: Matthias Rolf) * :term:`Event` dispatching now allows multiple threading strategies. * Performance Improvements * Caching of :term:`Spread` group names * ``<``-comparison of ``EventId`` s Java * Support for :term:`causal vectors ` has been added. * ``OriginFilter`` has been added. Python * Support for :term:`causal vectors ` has been added. * ``OriginFilter`` has been added. Common Lisp * Support for :term:`causal vectors ` has been added. .. note:: For a more detailed list of fixed bugs, added features and other enhancements, see https://code.cor-lab.org/projects/rsb/versions/21. |project| 0.4 ============= .. note:: |project| clients using the 0.4 version of |project| cannot communicate with clients using a previous |project| version. .. note:: This |project| release is only available in source code form from the `repository server`_. We no longer accept bug reports against this |project| version. The development activities in this cycle focused primarily on extending and optimizing the wire format and improving the usability of and support for protocol buffer message objects as event payloads. In the process, more than 30 issues have been created and subsequently resolved. Network Protocol for :term:`Spread`-based Communication * The eagerly computed, mandatory unique id field of :term:`events ` is now lazily computed from a static id and a :term:`sequence number`. :term:`Events ` can be transmitted without computing the id. This change saves 12 bytes in each :term:`notification` sent over the wire. (Thanks: Stefan Herbrechtsmeier) * Incompatible wire format versions can now be detected by means of a trick which does not incur any runtime overhead in space or time. This enabled removal of the ``version`` field in :term:`notifications `, saving four bytes in each notification sent over the wire. * The method field of :term:`events ` is now fully specified and used in request/reply communication. C++ * In addition to blocking request/reply invocation, a future-based asynchronous interface is now available. * Several performance problems related to :term:`scope` and :term:`event` construction have been fixed. (Thanks: Matthias Rolf, Arne Nordmann) Java * Request/reply communication with blocking and asynchronous invocation modes has been implemented. * A :term:`converter` registration and selection mechanism and a generic :term:`converter` for `Google protocol buffers`_ data holder classes have been added. Python * Request/reply communication with blocking and asynchronous invocation modes has been implemented. * A :term:`converter` for `Google protocol buffers`_ data holder classes has been added. Common Lisp * Request/reply communication with blocking and asynchronous invocation modes has been implemented. .. note:: For a more detailed list of fixed bugs, added features and other enhancements, see https://code.cor-lab.org/projects/rsb/versions/17.