X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=CHANGELOG.md;h=2bffb4d0f7dfd58482358544823da2e1df99542d;hb=5de7f6b85458615fa592a335d45c546397f32c9a;hp=86e3edca5230127678d99f362a916e55bad34a72;hpb=280b1c6c83b676ef4e592f4ecf60cb5b54b6a753;p=govpp.git

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 86e3edc..2bffb4d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,21 +14,59 @@ This file lists changes for the GoVPP releases.
 ## 0.4.0 (in development)
 > _NOT RELEASED YET_
 
+### Binapi Generator
+- 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 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
+- 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
+- generated helper methods for `vpe_types.Timestamp`
+
 ### 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
+- `StatsAPI` has a new method `GetMemory()` retrieving values related to the statseg memory heap
 
 ### Fixes
-- `MsgCodec` will recover panic occurring during a message decoding  
-- calling `Unsubscibe` will close the notification channel 
+- `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
+- fixed crash caused by return value of uint kind
 
 ### 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)
+- added more code samples of working with unions in [binapi-types](examples/binapi-types)
 - added profiling mode to [perf bench](examples/perf-bench) example
 - improved [simple client](examples/simple-client) example to work properly even with multiple runs
+- added [multi-vpp](examples/multi-vpp) example displaying management of two VPP instances from single
+  application
+- added [stream-client](examples/stream-client) example showing usage of the new stream API
 
 #### Dependencies
 - updated `github.com/sirupsen/logrus` dep to `v1.6.0`