X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=examples%2Fcmd%2Fsimple-client%2Fsimple_client.go;h=08d4da6a4bfdf34d54cf9295333ff0be88dfdbae;hb=8ba70a7b13950593aab9863246f830eda450f06b;hp=7b7dbcd0ecde60b53c5f1c60ef0cdc9546d7de37;hpb=a679bbc78b98089f9b221bbe7de963f5274073bb;p=govpp.git diff --git a/examples/cmd/simple-client/simple_client.go b/examples/cmd/simple-client/simple_client.go index 7b7dbcd..08d4da6 100644 --- a/examples/cmd/simple-client/simple_client.go +++ b/examples/cmd/simple-client/simple_client.go @@ -12,23 +12,22 @@ // See the License for the specific language governing permissions and // limitations under the License. -// Binary simple-client is an example VPP management application that exercises the +// simple-client is an example VPP management application that exercises the // govpp API on real-world use-cases. package main -// Generates Go bindings for all VPP APIs located in the json directory. -//go:generate binapi-generator --input-dir=../../bin_api --output-dir=../../bin_api - import ( "fmt" + "log" "net" "os" + "strings" "git.fd.io/govpp.git" "git.fd.io/govpp.git/api" "git.fd.io/govpp.git/examples/bin_api/acl" "git.fd.io/govpp.git/examples/bin_api/interfaces" - "git.fd.io/govpp.git/examples/bin_api/tap" + "git.fd.io/govpp.git/examples/bin_api/ip" ) func main() { @@ -37,62 +36,49 @@ func main() { // connect to VPP conn, err := govpp.Connect("") if err != nil { - fmt.Println("Error:", err) - os.Exit(1) + log.Fatalln("ERROR:", err) } defer conn.Disconnect() // create an API channel that will be used in the examples ch, err := conn.NewAPIChannel() if err != nil { - fmt.Println("Error:", err) - os.Exit(1) + log.Fatalln("ERROR:", err) } defer ch.Close() - // check whether the VPP supports our version of some messages - compatibilityCheck(ch) - // individual examples aclVersion(ch) aclConfig(ch) aclDump(ch) - tapConnect(ch) - interfaceDump(ch) - interfaceNotifications(ch) -} + ipAddressDump(ch) -// compatibilityCheck shows how an management application can check whether generated API messages are -// compatible with the version of VPP which the library is connected to. -func compatibilityCheck(ch api.Channel) { - err := ch.CheckMessageCompatibility( - &interfaces.SwInterfaceDump{}, - &interfaces.SwInterfaceDetails{}, - ) - if err != nil { - fmt.Println(err) - os.Exit(1) - } + setIpUnnumbered(ch) + ipUnnumberedDump(ch) + + interfaceNotifications(ch) } // aclVersion is the simplest API example - one empty request message and one reply message. func aclVersion(ch api.Channel) { + fmt.Println("ACL getting version") + req := &acl.ACLPluginGetVersion{} reply := &acl.ACLPluginGetVersionReply{} - err := ch.SendRequest(req).ReceiveReply(reply) - - if err != nil { - fmt.Println("Error:", err) + if err := ch.SendRequest(req).ReceiveReply(reply); err != nil { + fmt.Println("ERROR:", err) } else { - fmt.Printf("%+v\n", reply) + fmt.Printf("ACL version reply: %+v\n", reply) } } // aclConfig is another simple API example - in this case, the request contains structured data. func aclConfig(ch api.Channel) { + fmt.Println("ACL adding replace") + req := &acl.ACLAddReplace{ ACLIndex: ^uint32(0), Tag: []byte("access list 1"), @@ -117,74 +103,111 @@ func aclConfig(ch api.Channel) { } reply := &acl.ACLAddReplaceReply{} - err := ch.SendRequest(req).ReceiveReply(reply) - - if err != nil { - fmt.Println("Error:", err) - } else { - fmt.Printf("%+v\n", reply) + if err := ch.SendRequest(req).ReceiveReply(reply); err != nil { + fmt.Println("ERROR:", err) + return } + if reply.Retval != 0 { + fmt.Println("Retval:", reply.Retval) + return + } + + fmt.Printf("ACL add replace reply: %+v\n", reply) + } // aclDump shows an example where SendRequest and ReceiveReply are not chained together. func aclDump(ch api.Channel) { + fmt.Println("Dumping ACL") + req := &acl.ACLDump{} reply := &acl.ACLDetails{} reqCtx := ch.SendRequest(req) - err := reqCtx.ReceiveReply(reply) - if err != nil { - fmt.Println("Error:", err) + if err := reqCtx.ReceiveReply(reply); err != nil { + fmt.Println("ERROR:", err) } else { - fmt.Printf("%+v\n", reply) + fmt.Printf("ACL details: %+v\n", reply) } } -// tapConnect example shows how the Go channels in the API channel can be accessed directly instead -// of using SendRequest and ReceiveReply wrappers. -func tapConnect(ch api.Channel) { - req := &tap.TapConnect{ - TapName: []byte("testtap"), - UseRandomMac: 1, +// interfaceDump shows an example of multipart request (multiple replies are expected). +func interfaceDump(ch api.Channel) { + fmt.Println("Dumping interfaces") + + reqCtx := ch.SendMultiRequest(&interfaces.SwInterfaceDump{}) + + for { + msg := &interfaces.SwInterfaceDetails{} + stop, err := reqCtx.ReceiveReply(msg) + if stop { + break + } + if err != nil { + fmt.Println("ERROR:", err) + } + ifaceName := strings.TrimFunc(string(msg.InterfaceName), func(r rune) bool { + return r == 0x00 + }) + fmt.Printf("Interface %q: %+v\n", ifaceName, msg) } +} - // send the request to the request go channel - ch.GetRequestChannel() <- &api.VppRequest{Message: req} +func ipAddressDump(ch api.Channel) { + fmt.Println("Dumping IP addresses") - // receive a reply from the reply go channel - vppReply := <-ch.GetReplyChannel() - if vppReply.Error != nil { - fmt.Println("Error:", vppReply.Error) - return + req := &ip.IPAddressDump{ + SwIfIndex: 1, //^uint32(0), } + reqCtx := ch.SendMultiRequest(req) - // decode the message - reply := &tap.TapConnectReply{} - err := ch.GetMessageDecoder().DecodeMsg(vppReply.Data, reply) + for { + msg := &ip.IPAddressDetails{} + stop, err := reqCtx.ReceiveReply(msg) + if stop { + break + } + if err != nil { + fmt.Println("ERROR:", err) + } + fmt.Printf("ip address details: %d %+v\n", msg.SwIfIndex, msg) + } +} - if err != nil { - fmt.Println("Error:", err) +// aclDump shows an example where SendRequest and ReceiveReply are not chained together. +func setIpUnnumbered(ch api.Channel) { + req := &interfaces.SwInterfaceSetUnnumbered{ + SwIfIndex: 1, + UnnumberedSwIfIndex: 2, + IsAdd: 1, + } + reply := &interfaces.SwInterfaceSetUnnumberedReply{} + + if err := ch.SendRequest(req).ReceiveReply(reply); err != nil { + fmt.Println("ERROR:", err) } else { fmt.Printf("%+v\n", reply) } } -// interfaceDump shows an example of multipart request (multiple replies are expected). -func interfaceDump(ch api.Channel) { - req := &interfaces.SwInterfaceDump{} - reqCtx := ch.SendMultiRequest(req) +func ipUnnumberedDump(ch api.Channel) { + fmt.Println("Dumping IP unnumbered") + + reqCtx := ch.SendMultiRequest(&ip.IPUnnumberedDump{ + SwIfIndex: ^uint32(0), + }) for { - msg := &interfaces.SwInterfaceDetails{} + msg := &ip.IPUnnumberedDetails{} stop, err := reqCtx.ReceiveReply(msg) if stop { - break // break out of the loop + break } if err != nil { - fmt.Println("Error:", err) + fmt.Println("ERROR:", err) } - fmt.Printf("%+v\n", msg) + fmt.Printf("IP unnumbered details: %+v\n", msg) } } @@ -192,30 +215,57 @@ func interfaceDump(ch api.Channel) { // you are supposed to create your own Go channel with your preferred buffer size. If the channel's // buffer is full, the notifications will not be delivered into it. func interfaceNotifications(ch api.Channel) { - // subscribe for specific notification message + fmt.Println("Subscribing to notificaiton events") + notifChan := make(chan api.Message, 100) - subs, _ := ch.SubscribeNotification(notifChan, interfaces.NewSwInterfaceSetFlags) + + // subscribe for specific notification message + sub, err := ch.SubscribeNotification(notifChan, &interfaces.SwInterfaceEvent{}) + if err != nil { + panic(err) + } // enable interface events in VPP - ch.SendRequest(&interfaces.WantInterfaceEvents{ - Pid: uint32(os.Getpid()), + err = ch.SendRequest(&interfaces.WantInterfaceEvents{ + PID: uint32(os.Getpid()), EnableDisable: 1, }).ReceiveReply(&interfaces.WantInterfaceEventsReply{}) + if err != nil { + panic(err) + } // generate some events in VPP - ch.SendRequest(&interfaces.SwInterfaceSetFlags{ + err = ch.SendRequest(&interfaces.SwInterfaceSetFlags{ SwIfIndex: 0, AdminUpDown: 0, }).ReceiveReply(&interfaces.SwInterfaceSetFlagsReply{}) - ch.SendRequest(&interfaces.SwInterfaceSetFlags{ + if err != nil { + panic(err) + } + err = ch.SendRequest(&interfaces.SwInterfaceSetFlags{ SwIfIndex: 0, AdminUpDown: 1, }).ReceiveReply(&interfaces.SwInterfaceSetFlagsReply{}) + if err != nil { + panic(err) + } // receive one notification - notif := (<-notifChan).(*interfaces.SwInterfaceSetFlags) - fmt.Printf("%+v\n", notif) + notif := (<-notifChan).(*interfaces.SwInterfaceEvent) + fmt.Printf("incoming event: %+v\n", notif) + + // disable interface events in VPP + err = ch.SendRequest(&interfaces.WantInterfaceEvents{ + PID: uint32(os.Getpid()), + EnableDisable: 0, + }).ReceiveReply(&interfaces.WantInterfaceEventsReply{}) + if err != nil { + panic(err) + } // unsubscribe from delivery of the notifications - ch.UnsubscribeNotification(subs) + err = sub.Unsubscribe() + if err != nil { + panic(err) + } }