====== OpenSRF release notes: 1.6.x ======

===== 1.6.3 (released 2011-03-18) =====

==== Bug fixes ====

  * (Perl) OpenSRF requests that include non-ASCII, non-Latin 1 characters (e.g., Cyrillic or Chinese) in the message body could get silently dropped under certain circumstances; this no longer happens.

===== 1.6.2 (released 2010-12-16) =====

  * Added Ubuntu Lucid (10.04) to the list of supported distributions

==== Bug fixes ====

  * (C) Do not try to read an invalid file handle
  * (Perl) Return if interrupted, rather than trying to continue to read
  * (Perl) Log message processing durations at INFO level instead of DEBUG

===== 1.6.1 (released 2010-09-16) =====

==== Bug fixes ====

  * (JavaScript) Store the session along with XHR responses on the queue

===== 1.6.0 (released 2010-09-16) =====

==== New features ====

=== Linux distribution support ===

== Added ==

  * Red Hat Enterprise Linux 5 (Makefile.install target = ''rhel5''). Thanks to Lee Dickens of Equinox Software for providing the necessary patches and testing.
  * Ubuntu 10.04 "Lucid Lynx" (Makefile.install target = ''ubuntu-lucid'').
  * [[http://fedoraproject.org|Fedora]] (Makefile.install target = ''fedora13'' or ''fedora14''). This distribution is not recommended for production servers due to the relatively short support period, but good for testing and development.
  * (Experimental) Debian Squeeze (Makefile.install target = ''debian-squeeze''). This distribution has not yet been officially released, so OpenSRF support is initial.

== Dropped ==
  * Debian Etch has been removed.
  * Ubuntu Karmic has been removed.

=== (C, Perl) Add response chunking support ===
  
Two new optional paramters to register_method are now supported:
  * max_chunk_size
  * max_chunk_count
	  
OpenSRF has always supported message bundling, but only respond_complete made use of this fact by sending the final result message and the completion status message in the same XMPP envelope. Now, on a per method basis, RESULT messages can be bundled (cached) until one of three conditions occurs:
  * The size of the JSON of the RESULT messages matches or exceeds max_chunk_size
  * The number of RESULT messages cached matches or exceeds max_chunk_count
  * respond_complete is called (which happens implicitly by returning from a method)
	  
Because the overhead of sending multiple XMPP messages far outweighs the caching and cache management costs of chunking, the default for max_chunk_size is set at 10240 bytes (10k). The default for max_chunk_count is 0. To turn off chunking completely, set the max_chunk_size register_method parameter to 0.

==== Infrastructure improvements ====

  * (C) Replace the old JSON parser with a new implementation, as well as offer an incremental JSON parser
  * (JavaScript) Added support for reading ContinueStatus OpenSRF messages

==== Bug fixes ====

  * Quote $VERSION value in OpenSRF.pm to avoid syntax errors
  * Fix typo in docgen.xsl to enable display of OpenSRF system methods