govpp.go

   1 // Copyright (c) 2017 Cisco and/or its affiliates.
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at:
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 package govpp
  16
  17 import (
  18         "time"
  19
  20         "git.fd.io/govpp.git/adapter"
  21         "git.fd.io/govpp.git/adapter/socketclient"
  22         "git.fd.io/govpp.git/core"
  23 )
  24
  25 var (
  26         // VPP binary API adapter that will be used in the subsequent Connect calls
  27         vppAdapter adapter.VppAPI
  28 )
  29
  30 func getVppAdapter(addr string) adapter.VppAPI {
  31         if vppAdapter == nil {
  32                 vppAdapter = socketclient.NewVppClient(addr)
  33         }
  34         return vppAdapter
  35 }
  36
  37 // SetVppAdapter sets the adapter that will be used for connections to VPP in the subsequent `Connect` calls.
  38 func SetVppAdapter(a adapter.VppAPI) {
  39         vppAdapter = a
  40 }
  41
  42 // Connect connects the govpp core to VPP either using the default VPP Adapter, or using the adapter previously
  43 // set by SetAdapter (useful mostly just for unit/integration tests with mocked VPP adapter).
  44 // This call blocks until VPP is connected, or an error occurs. Only one connection attempt will be performed.
  45 func Connect(shm string) (*core.Connection, error) {
  46         return core.Connect(getVppAdapter(shm))
  47 }
  48
  49 // AsyncConnect asynchronously connects the govpp core to VPP either using the default VPP Adapter,
  50 // or using the adapter previously set by SetAdapter.
  51 // This call does not block until connection is established, it returns immediately. The caller is
  52 // supposed to watch the returned ConnectionState channel for Connected/Disconnected events.
  53 // In case of disconnect, the library will asynchronously try to reconnect.
  54 func AsyncConnect(shm string, attempts int, interval time.Duration) (*core.Connection, chan core.ConnectionEvent, error) {
  55         return core.AsyncConnect(getVppAdapter(shm), attempts, interval)
  56 }