1 // Copyright (c) 2018 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.
15 // Package socketclient is a pure Go implementation of adapter.VppAPI, which uses
16 // unix domain sockets as the transport for connecting to the VPP binary API.
18 // The current implementation only supports VPP binary API, the VPP stats API
19 // is not supported and clients still have to use vppapiclient for retrieving stats.
24 // The socketclient connects to unix domain socket defined in VPP configuration.
26 // It is enabled by default at /run/vpp/api.sock by the following config section:
29 // socket-name default
32 // If you want to use custom socket path:
35 // socket-name /run/vpp/api.sock