1 // Copyright (c) 2017 Cisco and/or its affiliates.
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:
7 // http://www.apache.org/licenses/LICENSE-2.0
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.
17 // VppAdapter provides connection to VPP. It is responsible for sending and receiving of binary-encoded messages to/from VPP.
18 type VppAdapter interface {
19 // Connect connects the process to VPP.
22 // Disconnect disconnects the process from VPP.
25 // GetMsgID returns a runtime message ID for the given message name and CRC.
26 GetMsgID(msgName string, msgCrc string) (uint16, error)
28 // SendMsg sends a binary-encoded message to VPP.
29 SendMsg(clientID uint32, data []byte) error
31 // SetMsgCallback sets a callback function that will be called by the adapter whenever a message comes from VPP.
32 SetMsgCallback(func(context uint32, msgId uint16, data []byte))
34 // WaitReady returns func which waits until adapter is ready.
35 WaitReady() func() error