3 This file lists changes for the GoVPP releases.
14 ## 0.4.0 (in development)
18 - generator code has been split into multiple packages:
19 - [vppapi](binapigen/vppapi) - parses VPP API (`.api.json`) files
20 - [binapigen](binapigen) - processes parsed VPP API and handles code generation
21 - previously required manual patches for generated code should no longer be needed
22 - many generated aliases were removed and referenced to `*_types` files for simpler reading
23 - any types imported from other VPP API (`*_types.api`) files are now automatically resolved for generated Go code
24 - marshal/unmarshal methods for memory client messages are now generated
25 - generated new helper methods for more convenient IP and MAC address conversion
26 - added option to generate HTTP handlers for RPC services
27 - RPC service code is now generated into a separated file (`*_rpc.ba.go`) in the same directory and uses low level
29 - generated code now contains comment with information about versions of VPP and binapi-generator
30 - 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`)
31 - dependency on `github.com/lunixbochs/struc` was removed
32 - generated helper methods for `vpe_types.Timestamp`
35 - [socketclient](adapter/socketclient) received a new method to add client name
36 - added list of compatible messages to `CompatibilityError`
37 - removed global binary API adapter - this change allows GoVPP to manage multiple VPP connections with different
38 sockets simultaneously
39 - added support for the stats v2. The statsclient adapter recognized the version automatically so the `StatsAPI`
40 remained unchanged. In relation to this change, the legacy support (i.e. stat segment v0) for VPP <=19.04 was dropped.
41 - GoVPP now recognizes VPP state `NotResponding` which can be used to prevent disconnecting in case the VPP hangs
43 - added method `SetLogger()` for setting the global logger
44 - `StatsAPI` has a new method `GetMemory()` retrieving values related to the statseg memory heap
47 - `MsgCodec` will recover panic occurring during a message decoding
48 - calling `Unsubscibe` will close the notification channel
49 - GoVPP omits sending `sockclnt_delete` while cleaning up socket clients in order to remove VPP duplicate close
50 complaints - VPP handles it itself
51 - fixed major bug causing GoVPP to not receive stats updates after VPP restart
52 - fixed name conflict in generated union field constructors
53 - size of unions composed of another unions is now calculated correctly
54 - fixed race condition in the VPP adapter mock
55 - fixed crash caused by return value of uint kind
58 - improved log messages to provide more relevant info
59 - updated extras/libmemif to be compatible again
60 - default health check parameter was increased to 250 milliseconds (up from 100 milliseconds), and the default
61 threshold was increased to 2 (up from 1)
64 - added more code samples of working with unions in [binapi-types](examples/binapi-types)
65 - added profiling mode to [perf bench](examples/perf-bench) example
66 - improved [simple client](examples/simple-client) example to work properly even with multiple runs
67 - added [multi-vpp](examples/multi-vpp) example displaying management of two VPP instances from single
69 - added [stream-client](examples/stream-client) example showing usage of the new stream API
72 - updated `github.com/sirupsen/logrus` dep to `v1.6.0`
73 - updated `github.com/lunixbochs/struc` dep to `v0.0.0-20200521075829-a4cb8d33dbbe`
79 - statsclient: Fix stats data errors and panic for VPP 20.05
85 - binapi-generator: Format generated Go source code in-process
91 - proxy: Unexport methods that do not satisfy rpc to remove warning
97 - statsclient: Fix panic occurring with VPP 20.05-rc0 (master)
103 - Fix import path in examples/binapi
109 - binapi-generator: Fix parsing default meta parameter
112 - api: Improve compatibility checking with new error types:
113 `adapter.UnknownMsgError` and `api.CompatibilityError`
114 - api: Added exported function `api.GetRegisteredMessageTypes()`
115 for getting list of all registered message types
116 - binapi-generator: Support imports of common types from other packages
117 - binapi-generator: Generate `Reset()` method for messages
118 - binapi-generator: Compact generated methods
121 - deps: Update `github.com/bennyscetbun/jsongo` to `v1.1.0`
122 - regenerate examples/binapi for latest VPP from stable/2001
128 - fixed socketclient for 19.08
129 - fixed binapi compatibility with master (20.01-rc0)
130 - fixed panic during stat data conversion
133 - introduce proxy for remote access to stats and binapi
134 - optimizations for statclient
137 - migrate to Go modules
138 - print info for users when sockets are missing
143 The first release that introduces versioning for GoVPP.