1 // Copyright (c) 2017 Cisco and/or its affiliates.
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:
7 // http://www.apache.org/licenses/LICENSE-2.0
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.
18 "git.fd.io/govpp.git/adapter"
19 "git.fd.io/govpp.git/adapter/vppapiclient"
20 "git.fd.io/govpp.git/core"
23 var vppAdapter adapter.VppAdapter // VPP Adapter that will be used in the subsequent Connect calls
25 // Connect connects the govpp core to VPP either using the default VPP Adapter, or using the adapter previously
26 // set by SetAdapter (useful mostly just for unit/integration tests with mocked VPP adapter).
27 // This call blocks until VPP is connected, or an error occurs. Only one connection attempt will be performed.
28 func Connect() (*core.Connection, error) {
29 if vppAdapter == nil {
30 vppAdapter = vppapiclient.NewVppAdapter()
32 return core.Connect(vppAdapter)
35 // AsyncConnect asynchronously connects the govpp core to VPP either using the default VPP Adapter,
36 // or using the adapter previously set by SetAdapter.
37 // This call does not block until connection is established, it returns immediately. The caller is
38 // supposed to watch the returned ConnectionState channel for Connected/Disconnected events.
39 // In case of disconnect, the library will asynchronously try to reconnect.
40 func AsyncConnect() (*core.Connection, chan core.ConnectionEvent, error) {
41 if vppAdapter == nil {
42 vppAdapter = vppapiclient.NewVppAdapter()
44 return core.AsyncConnect(vppAdapter)
47 // SetAdapter sets the adapter that will be used for connections to VPP in the subsequent `Connect` calls.
48 func SetAdapter(ad adapter.VppAdapter) {