Updated changelog for v0.4.0 05/29105/3
authorVladimir Lavor <vlavor@cisco.com>
Mon, 28 Sep 2020 12:09:35 +0000 (14:09 +0200)
committerVladimir Lavor <vlavor@cisco.com>
Thu, 1 Oct 2020 08:44:07 +0000 (10:44 +0200)
Change-Id: I3290bbc8cbdfb634533ceb4606e4708b1a386dce
Signed-off-by: Vladimir Lavor <vlavor@cisco.com>
CHANGELOG.md

index 44a8c2d..e35ad0f 100644 (file)
@@ -18,26 +18,44 @@ This file lists changes for the GoVPP releases.
 - generator code has been split into multiple packages:
   - [vppapi](binapigen/vppapi) - parses VPP API (`.api.json`) files
   - [binapigen](binapigen) - processes parsed VPP API and handles code generation
-- previously required manual patches for generated code should not longer be needed
+- previously required manual patches for generated code should no longer be needed
+- many generated aliases were removed and referenced to `*_types` files for simpler reading
 - any types imported from other VPP API (`*_types.api`) files are now automatically resolved for generated Go code
-- dependency on `github.com/lunixbochs/struc` was removed and message un/marshaling is now part of generated code
-- generated code now contains comment with information about versions of VPP and binapi-generator
-- RPC service code is now generated into a separated file (`*_rpc.ba.go`) in same directory
-- many generated aliases were removed and referenced to `*_types` files for simpler reading 
+- marshal/unmarshal methods for memory client messages are now generated
 - generated new helper methods for more convenient IP and MAC address conversion
+- added option to generate HTTP handlers for RPC services
+- RPC service code is now generated into a separated file (`*_rpc.ba.go`) in the same directory and uses low level
+  stream API
+- generated code now contains comment with information about versions of VPP and binapi-generator
+- in addition to the file name, the binapi generator now accepts full path (including extension, e.g. `/usr/share/vpp/api/core/vpe.api.json`)
+- dependency on `github.com/lunixbochs/struc` was removed
 
 ### Features
-- optimized [socketclient](adapter/socketclient) adapter and add method to set client name
+- [socketclient](adapter/socketclient) received a new method to add client name
 - added list of compatible messages to `CompatibilityError`
 - removed global binary API adapter - this change allows GoVPP to manage multiple VPP connections with different 
   sockets simultaneously
+- added support for the stats v2. The statsclient adapter recognized the version automatically so the `StatsAPI`
+  remained unchanged. In relation to this change, the legacy support (i.e. stat segment v0) for VPP <=19.04 was dropped.
+- GoVPP now recognizes VPP state `NotResponding` which can be used to prevent disconnecting in case the VPP hangs
+  or is overloaded
+- added method `SetLogger` for setting the global logger
 
 ### Fixes
 - `MsgCodec` will recover panic occurring during a message decoding
 - calling `Unsubscibe` will close the notification channel
+- GoVPP omits sending `sockclnt_delete` while cleaning up socket clients in order to remove VPP duplicate close
+  complaints - VPP handles it itself
+- fixed major bug causing GoVPP to not receive stats updates after VPP restart
+- fixed name conflict in generated union field constructors
+- size of unions composed of another unions is now calculated correctly
+- fixed race condition in the VPP adapter mock
 
 ### Other
 - improved log messages to provide more relevant info
+- updated extras/libmemif to be compatible again
+- default health check parameter was increased to 250 milliseconds (up from 100 milliseconds), and the default
+  threshold was increased to 2 (up from 1)
 
 #### Examples
 - added more code samples of working with unions in [union example](examples/union-example)