adapter/vppapiclient/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 vppapiclient is the default VPP adapter being used for
  16 // the connection to VPP binary & stats API via shared memory.
  17 // It is essentially Go wrapper for the VPP vppapiclient library written in C.
  18 //
  19 // DEPRECATED: The vppapiclient implementation has been deprecated.
  20 // Use socketclient and statsclient.
  21 package vppapiclient