core/doc.go

   1 // Package core provides connectivity to VPP via the adapter: sends and receives the messages to/from VPP,
   2 // marshalls/unmarshalls them and forwards them between the client Go channels and the VPP.
   3 //
   4 // The interface_plugin APIs the core exposes is tied to a connection: Connect provides a connection, that cane be
   5 // later used to request an API channel via NewAPIChannel / NewAPIChannelBuffered functions:
   6 //
   7 //      conn, err := govpp.Connect()
   8 //      if err != nil {
   9 //              // handle error!
  10 //      }
  11 //      defer conn.Disconnect()
  12 //
  13 //      ch, err := conn.NewAPIChannel()
  14 //      if err != nil {
  15 //              // handle error!
  16 //      }
  17 //      defer ch.Close()
  18 //
  19 // Note that one application can open only one connection, that can serve multiple API channels.
  20 package core