3 This file lists changes for the GoVPP releases.
26 - the generator code has been split into multiple packages:
27 - [vppapi](binapigen/vppapi) - parses VPP API (`.api.json`) files
28 - [binapigen](binapigen) - processes parsed VPP API files and handles code generation
29 - added support for VPP enumflags type
30 - previously required manual patches for generated code should no longer be needed
31 - many generated aliases were removed and referenced to `*_types` files for simpler reading
32 - any types imported from other VPP API (`*_types.api`) files are now automatically resolved for generated Go code
33 - marshal/unmarshal methods for memory client messages are now generated
34 - generated new helper methods for more convenient IP and MAC address conversion
35 - RPC service code is now generated into a separated file (`*_rpc.ba.go`) in the same directory and uses a new low level
37 - added option to generate HTTP handlers for RPC services
38 - generated code now contains comments with information about versions of VPP and binapi-generator
39 - in addition to the file name, the binapi generator now accepts full path (including extension,
40 e.g. `/usr/share/vpp/api/core/vpe.api.json`)
41 - dependency on `github.com/lunixbochs/struc` was removed
42 - generated helper methods for `vpe_types.Timestamp`
43 - generated API messages comment may contain additional information about the given API development state (in progress,
45 - type `[]bool` is now known to the generator
46 - enhanced VPP version resolution - the generator is more reliable to evaluate installed VPP version
50 - [socketclient](adapter/socketclient) was optimized and received a new method to add client name
51 - added new API [stream](api/api.go) for low-level access to VPP API
52 - the `Stream` API uses the same default values as the `Channel` API
53 - it supports the same functional options (request size, reply size, reply timeout)
54 - [statsclient](adapter/statsclient) supports additional options (retry period, retry timeout)
55 - the compatibility check error now contains a list of compatible and incompatible messages wrapped
56 as `CompatibilityError`
57 - removed global binary API adapter. This change allows GoVPP to manage multiple VPP connections with different sockets
59 - added support for the stats v2. The `statsclient` adapter recognizes the version automatically so the `StatsAPI`
60 remains unchanged. In relation to this change, the legacy support (i.e. stat segment v0) for VPP <=19.04 was dropped.
61 - GoVPP now recognizes VPP state `NotResponding` which can be used to prevent disconnecting in case the VPP hangs or is
63 - added method `SetLogger()` for setting the global logger
64 - `StatsAPI` has a new method `GetMemory()` retrieving values related to the statseg memory heap
65 - the stats socket allows an option to connect asynchronously in the same manner as the API socket connection.
66 Use `AsyncConnectStats()` to receive `ConnectionEvent` notifications
67 - Instead of a cumulative value, the `statsclient` error counter now provides a value per worker
68 - `ListStats(patterns ...string)` returns `StatIdentifier` containing the message name and the ID (instead of the name
70 - added support for VPP stat symlinks
71 - GoVPP received its own [API trace](api/trace.go). See the [example](examples/api-trace) for more details.
75 - `MsgCodec` will recover panic occurring during a message decoding
76 - calling `Unsubscibe` will close the notification channel
77 - GoVPP omits to send `sockclnt_delete` while cleaning up socket clients in order to remove VPP duplicated close
78 complaints - VPP handles it itself
79 - fixed major bug causing GoVPP to not receive stats updates after VPP restart
80 - fixed name conflict in generated union field constructors
81 - the size of unions composed of other unions is now calculated correctly
82 - fixed race condition in the VPP adapter mock
83 - fixed crash caused by the return value of uint kind
84 - fixed encoding/decoding of float64
85 - fixed the stats reconnect procedure which occasionally failed re-enable the connection.
86 - fixed occasional panic during disconnect
87 - `statsclient` wait for socket procedure works properly
88 - fixed memory leak in health check
92 - improved log messages to provide more relevant info
93 - updated extras/libmemif to be compatible with the latest VPP changes
94 - default health check parameter was increased to 250 milliseconds (up from 100 milliseconds), and the default threshold
95 was increased to 2 (up from 1)
96 - improved decoding of message context (message evaluation uses also the package path, not just the message ID)
97 - `statsclient` now recognizes between empty stat directories and does not treat them as unknown
98 - proxy client was updated to VPP 20.05
102 - added more code samples of working with unions in [binapi-types](examples/binapi-types)
103 - added profiling mode to [perf bench](examples/perf-bench) example
104 - improved [simple client](examples/simple-client) example to work properly even with multiple runs
105 - added [multi-vpp](examples/multi-vpp) example displaying management of two VPP instances from single application
106 - added [stream-client](examples/stream-client) example showing usage of the new stream API
107 - [simple client](examples/simple-client) and [binapi-types](examples/binapi-types) examples show usage of
108 the `vpe_types.Timestamp`
109 - added [API trace example](examples/api-trace)
113 - updated `github.com/sirupsen/logrus` dep to `v1.6.0`
114 - updated `github.com/lunixbochs/struc` dep to `v0.0.0-20200521075829-a4cb8d33dbbe`
122 - statsclient: Fix stats data errors and panic for VPP 20.05
130 - binapi-generator: Format generated Go source code in-process
138 - proxy: Unexport methods that do not satisfy rpc to remove warning
146 - statsclient: Fix panic occurring with VPP 20.05-rc0 (master)
154 - Fix import path in examples/binapi
162 - binapi-generator: Fix parsing default meta parameter
166 - api: Improve compatibility checking with new error types:
167 `adapter.UnknownMsgError` and `api.CompatibilityError`
168 - api: Added exported function `api.GetRegisteredMessageTypes()`
169 for getting list of all registered message types
170 - binapi-generator: Support imports of common types from other packages
171 - binapi-generator: Generate `Reset()` method for messages
172 - binapi-generator: Compact generated methods
176 - deps: Update `github.com/bennyscetbun/jsongo` to `v1.1.0`
177 - regenerate examples/binapi for latest VPP from stable/2001
185 - fixed socketclient for 19.08
186 - fixed binapi compatibility with master (20.01-rc0)
187 - fixed panic during stat data conversion
191 - introduce proxy for remote access to stats and binapi
192 - optimizations for statclient
196 - migrate to Go modules
197 - print info for users when sockets are missing
203 The first release that introduces versioning for GoVPP.