adapter/socketclient/doc.go

   1 // Copyright (c) 2018 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 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.
  17 //
  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.
  20 //
  21 //
  22 // Requirements
  23 //
  24 // The socketclient will connect to /run/vpp-api.sock by default. However this
  25 // is not enabled in VPP configuration by default.
  26 //
  27 // To enable the socket in VPP, add following section to VPP config.
  28 //
  29 //      socksvr {
  30 //              default
  31 //      }
  32 //
  33 package socketclient