initial commit

Signed-off-by: Rastislav Szabo <raszabo@cisco.com>

1 files changed, 33 insertions, 0 deletions

diff --git a/adapter/adapter.go b/adapter/adapter.go
new file mode 100644
index 0000000..2843d2c
--- /dev/null
+++ b/adapter/adapter.go
@@ -0,0 +1,33 @@
+// 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
+
+// VppAdapter provides connection to VPP. It is responsible for sending and receiving of binary-encoded messages to/from VPP.
+type VppAdapter interface {
+	// Connect connects the process to VPP.
+	Connect() error
+
+	// Disconnect disconnects the process from VPP.
+	Disconnect()
+
+	// GetMsgID returns a runtime message ID for the given message name and CRC.
+	GetMsgID(msgName string, msgCrc string) (uint16, error)
+
+	// SendMsg sends a binary-encoded message to VPP.
+	SendMsg(clientID uint32, data []byte) error
+
+	// SetMsgCallback sets a callback function that will be called by the adapter whenever a message comes from VPP.
+	SetMsgCallback(func(context uint32, msgId uint16, data []byte))
+}