blob: b32f97580b85f8fdbb2c3894f634d0d9891d9bdf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
// 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"
"fmt"
)
const (
// DefaultBinapiSocket defines a default socket file path for VPP binary API.
DefaultBinapiSocket = "/run/vpp/api.sock"
)
var (
// ErrNotImplemented is an error returned when missing implementation.
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
}
// UnknownMsgError is the error type usually returned by GetMsgID
// method of VppAPI. It describes the name and CRC for the unknown message.
type UnknownMsgError struct {
MsgName string
MsgCrc string
}
func (u *UnknownMsgError) Error() string {
return fmt.Sprintf("unknown message: %s_%s", u.MsgName, u.MsgCrc)
}
|
