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/socketclient"
  21         "git.fd.io/govpp.git/core"
  22 )
  23
  24 // Connect connects the govpp core to VPP either using the default VPP Adapter, or using the adapter previously
  25 // set by SetAdapter (useful mostly just for unit/integration tests with mocked VPP adapter).
  26 // This call blocks until VPP is connected, or an error occurs. Only one connection attempt will be performed.
  27 func Connect(shm string) (*core.Connection, error) {
  28         return core.Connect(socketclient.NewVppClient(shm))
  29 }
  30
  31 // AsyncConnect asynchronously connects the govpp core to VPP either using the default VPP Adapter,
  32 // or using the adapter previously set by SetAdapter.
  33 // This call does not block until the connection is established, it returns immediately. The caller is
  34 // supposed to watch the returned ConnectionState channel for Connected/Disconnected events.
  35 // In case of a disconnect, the library will asynchronously try to reconnect.
  36 func AsyncConnect(shm string, attempts int, interval time.Duration) (*core.Connection, chan core.ConnectionEvent, error) {
  37         return core.AsyncConnect(socketclient.NewVppClient(shm), attempts, interval)
  38 }