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.
23 // DefaultBinapiSocket defines a default socket file path for VPP binary API.
24 DefaultBinapiSocket = "/run/vpp/api.sock"
28 // ErrNotImplemented is an error returned when missing implementation.
29 ErrNotImplemented = errors.New("not implemented for this OS")
32 // MsgCallback defines func signature for message callback.
33 type MsgCallback func(msgID uint16, data []byte)
35 // VppAPI provides connection to VPP binary API.
36 // It is responsible for sending and receiving of binary-encoded messages to/from VPP.
37 type VppAPI interface {
38 // Connect connects the process to VPP.
41 // Disconnect disconnects the process from VPP.
44 // GetMsgID returns a runtime message ID for the given message name and CRC.
45 GetMsgID(msgName string, msgCrc string) (msgID uint16, err error)
47 // SendMsg sends a binary-encoded message to VPP.
48 SendMsg(context uint32, data []byte) error
50 // SetMsgCallback sets a callback function that will be called by the adapter whenever a message comes from VPP.
51 SetMsgCallback(cb MsgCallback)
53 // WaitReady waits until adapter is ready.
57 // UnknownMsgError is the error type usually returned by GetMsgID
58 // method of VppAPI. It describes the name and CRC for the unknown message.
59 type UnknownMsgError struct {
64 func (u *UnknownMsgError) Error() string {
65 return fmt.Sprintf("unknown message: %s_%s", u.MsgName, u.MsgCrc)