diff options
Diffstat (limited to 'adapter/socketclient/doc.go')
| -rw-r--r-- | adapter/socketclient/doc.go | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/adapter/socketclient/doc.go b/adapter/socketclient/doc.go new file mode 100644 index 0000000..0f93c56 --- /dev/null +++ b/adapter/socketclient/doc.go @@ -0,0 +1,33 @@ +// Copyright (c) 2018 Cisco and/or its affiliates. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at: +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package socketclient is a pure Go implementation of adapter.VppAPI, which uses +// unix domain sockets as the transport for connecting to the VPP binary API. +// +// The current implementation only supports VPP binary API, the VPP stats API +// is not supported and clients still have to use vppapiclient for retrieving stats. +// +// +// Requirements +// +// The socketclient will connect to /run/vpp-api.sock by default. However this +// is not enabled in VPP configuration by default. +// +// To enable the socket in VPP, add following section to VPP config. +// +// socksvr { +// default +// } +// +package socketclient |