support for shm prefixes
[govpp.git] / govpp.go
index f0ced41..ff45b78 100644 (file)
--- a/govpp.go
+++ b/govpp.go
 package govpp
 
 import (
-       "gerrit.fd.io/r/govpp/adapter"
-       "gerrit.fd.io/r/govpp/adapter/vppapiclient"
-       "gerrit.fd.io/r/govpp/core"
+       "git.fd.io/govpp.git/adapter"
+       "git.fd.io/govpp.git/adapter/vppapiclient"
+       "git.fd.io/govpp.git/core"
 )
 
 var vppAdapter adapter.VppAdapter // VPP Adapter that will be used in the subsequent Connect calls
 
 // Connect connects the govpp core to VPP either using the default VPP Adapter, or using the adapter previously
 // set by SetAdapter (useful mostly just for unit/integration tests with mocked VPP adapter).
-func Connect() (*core.Connection, error) {
+// This call blocks until VPP is connected, or an error occurs. Only one connection attempt will be performed.
+func Connect(shm string) (*core.Connection, error) {
        if vppAdapter == nil {
-               vppAdapter = vppapiclient.NewVppAdapter()
+               vppAdapter = vppapiclient.NewVppAdapter(shm)
        }
        return core.Connect(vppAdapter)
 }
 
+// AsyncConnect asynchronously connects the govpp core to VPP either using the default VPP Adapter,
+// or using the adapter previously set by SetAdapter.
+// This call does not block until connection is established, it returns immediately. The caller is
+// supposed to watch the returned ConnectionState channel for Connected/Disconnected events.
+// In case of disconnect, the library will asynchronously try to reconnect.
+func AsyncConnect(shm string) (*core.Connection, chan core.ConnectionEvent, error) {
+       if vppAdapter == nil {
+               vppAdapter = vppapiclient.NewVppAdapter(shm)
+       }
+       return core.AsyncConnect(vppAdapter)
+}
+
 // SetAdapter sets the adapter that will be used for connections to VPP in the subsequent `Connect` calls.
 func SetAdapter(ad adapter.VppAdapter) {
        vppAdapter = ad
-}
+}
\ No newline at end of file