diff options
| author |   Rastislav Szabo <raszabo@cisco.com> | 2017-05-22 13:59:34 +0200 |
|---|---|---|
| committer | Rastislav Szabo <raszabo@cisco.com> | 2017-05-22 14:00:46 +0200 |
| commit | c38cb25d746736f062ee16e87f553c8a4ec5fced (patch) | |
| tree | 231a1befaff3b83b020461e584e9de27a39d06a4 /api/ifcounters/doc.go | |
| parent | c60a4ee4e6114ff0dc3cbc9fd9a58321ca2a8abc (diff) | |
binapi-generator renamed & moved, finished documentation
Change-Id: I7d3b53fa238e822b36a6a82c61ffb792da3898bf
Signed-off-by: Rastislav Szabo <raszabo@cisco.com>
Diffstat (limited to 'api/ifcounters/doc.go')
| -rw-r--r-- | api/ifcounters/doc.go | 27 |
1 files changed, 26 insertions, 1 deletions
diff --git a/api/ifcounters/doc.go b/api/ifcounters/doc.go index c918941..35c7f7b 100644 --- a/api/ifcounters/doc.go +++ b/api/ifcounters/doc.go @@ -1,4 +1,29 @@ // Package ifcounters provides the helper API for decoding VnetInterfaceCounters binary API message // that contains binary-encoded statistics data into the Go structs that are better consumable by the Go code. -// TODO: example usage - currently in the example_client.go +// +// VPP provides two types of interface counters that can be encoded inside of a single VnetInterfaceCounters +// message: simple and combined. For both of them, ifcounters API provides a separate decode function: +// DecodeCounters or DecodeCombinedCounters. The functions return a slice of simple or combined counters respectively: +// +// notifMsg := <-notifChan: +// notif := notifMsg.(*interfaces.VnetInterfaceCounters) +// +// if notif.IsCombined == 0 { +// // simple counter +// counters, err := ifcounters.DecodeCounters(ifcounters.VnetInterfaceCounters(*notif)) +// if err != nil { +// fmt.Println("Error:", err) +// } else { +// fmt.Printf("%+v\n", counters) +// } +// } else { +// // combined counter +// counters, err := ifcounters.DecodeCombinedCounters(ifcounters.VnetInterfaceCounters(*notif)) +// if err != nil { +// fmt.Println("Error:", err) +// } else { +// fmt.Printf("%+v\n", counters) +// } +// } +// package ifcounters |