summaryrefslogtreecommitdiffstats
path: root/adapter/vpp_api.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/vpp_api.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/vpp_api.go')
-rw-r--r--adapter/vpp_api.go47
1 files changed, 47 insertions, 0 deletions
diff --git a/adapter/vpp_api.go b/adapter/vpp_api.go
new file mode 100644
index 0000000..7d14633
--- /dev/null
+++ b/adapter/vpp_api.go
@@ -0,0 +1,47 @@
+// Copyright (c) 2017 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 adapter
+
+import (
+ "errors"
+)
+
+// ErrNotImplemented is an error returned when missing implementation.
+var ErrNotImplemented = errors.New("not implemented for this OS")
+
+// MsgCallback defines func signature for message callback.
+type MsgCallback func(msgID uint16, data []byte)
+
+// VppAPI provides connection to VPP binary API.
+// It is responsible for sending and receiving of binary-encoded messages to/from VPP.
+type VppAPI interface {
+ // Connect connects the process to VPP.
+ Connect() error
+
+ // Disconnect disconnects the process from VPP.
+ Disconnect() error
+
+ // GetMsgID returns a runtime message ID for the given message name and CRC.
+ GetMsgID(msgName string, msgCrc string) (msgID uint16, err error)
+
+ // SendMsg sends a binary-encoded message to VPP.
+ SendMsg(context uint32, data []byte) error
+
+ // SetMsgCallback sets a callback function that will be called by the adapter whenever a message comes from VPP.
+ SetMsgCallback(cb MsgCallback)
+
+ // WaitReady waits until adapter is ready.
+ WaitReady() error
+}