Optimize socketclient adapter and add various code improvements
[govpp.git] / CHANGELOG.md
1 # Changelog
2
3 This file lists changes for the GoVPP releases.
4
5 <!-- TEMPLATE
6 ### Fixes
7 -
8 ### Features
9 -
10 ### Other
11 -
12 -->
13
14 ## 0.4.0 (in development)
15 > _NOT RELEASED YET_
16
17 ### Features
18 - optimized [socketclient](adapter/socketclient) adapter and add method to set client name
19 - added list of compatible messages to `CompatibilityError`
20
21 ### Fixes
22 - `MsgCodec` will recover panic occurring during a message decoding  
23 - calling `Unsubscibe` will close the notification channel 
24
25 ### Other
26 - improved log messages to provide more relevant info
27
28 #### Examples
29 - added more code samples of working with unions in [union example](examples/union-example)
30 - added profiling mode to [perf bench](examples/perf-bench) example
31 - improved [simple client](examples/simple-client) example to work properly even with multiple runs
32
33 #### Dependencies
34 - updated `github.com/sirupsen/logrus` dep to `v1.6.0`
35 - updated `github.com/lunixbochs/struc` dep to `v0.0.0-20200521075829-a4cb8d33dbbe`
36
37 ## 0.3.5
38 > _18 May 2020_
39
40 ### Fixes
41 - statsclient: Fix stats data errors and panic for VPP 20.05
42
43 ## 0.3.4
44 > _17 April 2020_
45
46 ### Features
47 - binapi-generator: Format generated Go source code in-process
48
49 ## 0.3.3
50 > _9 April 2020_
51
52 ### Fixes
53 - proxy: Unexport methods that do not satisfy rpc to remove warning
54
55 ## 0.3.2
56 > _20 March 2020_
57
58 ### Fixes
59 - statsclient: Fix panic occurring with VPP 20.05-rc0 (master)
60
61 ## 0.3.1
62 > _18 March 2020_
63
64 ### Fixes
65 - Fix import path in examples/binapi
66
67 ## 0.3.0
68 > _18 March 2020_
69
70 ### Fixes
71 - binapi-generator: Fix parsing default meta parameter
72
73 ### Features
74 - api: Improve compatibility checking with new error types:
75   `adapter.UnknownMsgError` and `api.CompatibilityError`
76 - api: Added exported function `api.GetRegisteredMessageTypes()`
77   for getting list of all registered message types
78 - binapi-generator: Support imports of common types from other packages
79 - binapi-generator: Generate `Reset()` method for messages
80 - binapi-generator: Compact generated methods
81
82 ### Other
83 - deps: Update `github.com/bennyscetbun/jsongo` to `v1.1.0`
84 - regenerate examples/binapi for latest VPP from stable/2001
85
86 ## 0.2.0
87 > _04 November 2019_
88
89 ### Fixes
90 - fixed socketclient for 19.08
91 - fixed binapi compatibility with master (20.01-rc0)
92 - fixed panic during stat data conversion
93
94 ### Features
95 - introduce proxy for remote access to stats and binapi
96 - optimizations for statclient
97
98 ### Other
99 - migrate to Go modules
100 - print info for users when sockets are missing
101
102 ## 0.1.0
103 > _03 July 2019_
104
105 The first release that introduces versioning for GoVPP.