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         "git.fd.io/govpp.git/adapter"
  19         "git.fd.io/govpp.git/adapter/vppapiclient"
  20         "git.fd.io/govpp.git/core"
  21 )
  22
  23 var (
  24         // VPP binary API adapter that will be used in the subsequent Connect calls
  25         vppAdapter adapter.VppAPI
  26 )
  27
  28 func getVppAdapter(shm string) adapter.VppAPI {
  29         if vppAdapter == nil {
  30                 vppAdapter = vppapiclient.NewVppClient(shm)
  31         }
  32         return vppAdapter
  33 }
  34
  35 // SetVppAdapter sets the adapter that will be used for connections to VPP in the subsequent `Connect` calls.
  36 func SetVppAdapter(a adapter.VppAPI) {
  37         vppAdapter = a
  38 }
  39
  40 // Connect connects the govpp core to VPP either using the default VPP Adapter, or using the adapter previously
  41 // set by SetAdapter (useful mostly just for unit/integration tests with mocked VPP adapter).
  42 // This call blocks until VPP is connected, or an error occurs. Only one connection attempt will be performed.
  43 func Connect(shm string) (*core.Connection, error) {
  44         return core.Connect(getVppAdapter(shm))
  45 }
  46
  47 // AsyncConnect asynchronously connects the govpp core to VPP either using the default VPP Adapter,
  48 // or using the adapter previously set by SetAdapter.
  49 // This call does not block until connection is established, it returns immediately. The caller is
  50 // supposed to watch the returned ConnectionState channel for Connected/Disconnected events.
  51 // In case of disconnect, the library will asynchronously try to reconnect.
  52 func AsyncConnect(shm string) (*core.Connection, chan core.ConnectionEvent, error) {
  53         return core.AsyncConnect(getVppAdapter(shm))
  54 }