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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
// 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 api
import (
"fmt"
"reflect"
)
// MessageType represents the type of a VPP message.
// Note: this is currently derived from the message header (fields),
// and in many cases it does not represent the actual type of VPP message.
// This means that some replies can be identified as requests, etc.
// TODO: use services to identify type of message
type MessageType int
const (
// RequestMessage represents a VPP request message
RequestMessage MessageType = iota
// ReplyMessage represents a VPP reply message
ReplyMessage
// EventMessage represents a VPP event message
EventMessage
// OtherMessage represents other VPP message
OtherMessage
)
// Message is an interface that is implemented by all VPP Binary API messages generated by the binapigenerator.
type Message interface {
// GetMessageName returns the original VPP name of the message, as defined in the VPP API.
GetMessageName() string
// GetCrcString returns the string with CRC checksum of the message definition (the string represents a hexadecimal number).
GetCrcString() string
// GetMessageType returns the type of the VPP message.
GetMessageType() MessageType
}
// DataType is an interface that is implemented by all VPP Binary API data types by the binapi_generator.
type DataType interface {
// GetTypeName returns the original VPP name of the data type, as defined in the VPP API.
GetTypeName() string
}
var (
registeredMessageTypes = make(map[reflect.Type]string)
registeredMessages = make(map[string]Message)
)
// RegisterMessage is called from generated code to register message.
func RegisterMessage(x Message, name string) {
typ := reflect.TypeOf(x)
namecrc := x.GetMessageName() + "_" + x.GetCrcString()
if _, ok := registeredMessageTypes[typ]; ok {
panic(fmt.Errorf("govpp: message type %v already registered as %s (%s)", typ, name, namecrc))
}
registeredMessages[namecrc] = x
registeredMessageTypes[typ] = name
}
// GetRegisteredMessages returns list of all registered messages.
func GetRegisteredMessages() map[string]Message {
return registeredMessages
}
// GetRegisteredMessageTypes returns list of all registered message types.
func GetRegisteredMessageTypes() map[reflect.Type]string {
return registeredMessageTypes
}
// GoVppAPIPackageIsVersionX is referenced from generated binapi files
// to assert that that code is compatible with this version of the GoVPP api package.
const GoVppAPIPackageIsVersion1 = true
const GoVppAPIPackageIsVersion2 = true
|
