summaryrefslogtreecommitdiffstats
path: root/adapter/vppapiclient/doc.go
diff options
context:
space:
mode:
authorOndrej Fabry <ofabry@cisco.com>2018-10-22 14:45:21 +0200
committerOndrej Fabry <ofabry@cisco.com>2018-10-22 14:56:09 +0200
commit28df7c855784e784fb0e614c1cca0e565a7ef75f (patch)
tree7d2eb1b3522d57680df8a6f576356f9dd4dc706c /adapter/vppapiclient/doc.go
parent62d19032621c7db801b313a1e19e787cfb1fbc3e (diff)
Introduce StatsAPI and it's initial implementation
- this implementation is basically Go wrapper around VPP's vppapiclient C library Change-Id: I6f53dc3e228868834bf3a8a00c686ad05e22f3dd Signed-off-by: Ondrej Fabry <ofabry@cisco.com>
Diffstat (limited to 'adapter/vppapiclient/doc.go')
-rw-r--r--adapter/vppapiclient/doc.go18
1 files changed, 18 insertions, 0 deletions
diff --git a/adapter/vppapiclient/doc.go b/adapter/vppapiclient/doc.go
new file mode 100644
index 0000000..6505498
--- /dev/null
+++ b/adapter/vppapiclient/doc.go
@@ -0,0 +1,18 @@
+// 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 vppapiclient is the default VPP adapter being used for
+// the connection to VPP binary & stats API via shared memory.
+// It is essentially Go wrapper for the VPP vppapiclient library written in C.
+package vppapiclient