initial commit
[govpp.git] / 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         "gerrit.fd.io/r/govpp/adapter"
19         "gerrit.fd.io/r/govpp/adapter/vppapiclient"
20         "gerrit.fd.io/r/govpp/core"
21 )
22
23 var vppAdapter adapter.VppAdapter // VPP Adapter that will be used in the subsequent Connect calls
24
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 func Connect() (*core.Connection, error) {
28         if vppAdapter == nil {
29                 vppAdapter = vppapiclient.NewVppAdapter()
30         }
31         return core.Connect(vppAdapter)
32 }
33
34 // SetAdapter sets the adapter that will be used for connections to VPP in the subsequent `Connect` calls.
35 func SetAdapter(ad adapter.VppAdapter) {
36         vppAdapter = ad
37 }