Documentation ¶
Overview ¶
Package nsh is a generated VPP binary API for 'nsh' module.
It consists of:
6 enums 1 alias 8 messages 4 services
Index ¶
- Constants
- Variables
- func AllMessages() []api.Message
- type IfStatusFlags
- type IfType
- type InterfaceIndex
- type LinkDuplex
- type MtuProto
- type NshAddDelEntry
- type NshAddDelEntryReply
- type NshAddDelMap
- type NshAddDelMapReply
- type NshEntryDetails
- type NshEntryDump
- type NshMapDetails
- type NshMapDump
- type RPCService
- type RPCService_DumpNshEntryClient
- type RPCService_DumpNshMapClient
- type RxMode
- type SubIfFlags
Constants ¶
const ( // ModuleName is the name of this module. ModuleName = "nsh" // APIVersion is the API version of this module. APIVersion = "1.0.0" // VersionCrc is the CRC of this module. VersionCrc = 0x43be6707 )
Variables ¶
var IfStatusFlags_name = map[uint32]string{
1: "IF_STATUS_API_FLAG_ADMIN_UP",
2: "IF_STATUS_API_FLAG_LINK_UP",
}
var IfStatusFlags_value = map[string]uint32{
"IF_STATUS_API_FLAG_ADMIN_UP": 1,
"IF_STATUS_API_FLAG_LINK_UP": 2,
}
var IfType_name = map[uint32]string{
0: "IF_API_TYPE_HARDWARE",
1: "IF_API_TYPE_SUB",
2: "IF_API_TYPE_P2P",
3: "IF_API_TYPE_PIPE",
}
var IfType_value = map[string]uint32{
"IF_API_TYPE_HARDWARE": 0,
"IF_API_TYPE_SUB": 1,
"IF_API_TYPE_P2P": 2,
"IF_API_TYPE_PIPE": 3,
}
var LinkDuplex_name = map[uint32]string{
0: "LINK_DUPLEX_API_UNKNOWN",
1: "LINK_DUPLEX_API_HALF",
2: "LINK_DUPLEX_API_FULL",
}
var LinkDuplex_value = map[string]uint32{
"LINK_DUPLEX_API_UNKNOWN": 0,
"LINK_DUPLEX_API_HALF": 1,
"LINK_DUPLEX_API_FULL": 2,
}
var MtuProto_name = map[uint32]string{
0: "MTU_PROTO_API_L3",
1: "MTU_PROTO_API_IP4",
2: "MTU_PROTO_API_IP6",
3: "MTU_PROTO_API_MPLS",
}
var MtuProto_value = map[string]uint32{
"MTU_PROTO_API_L3": 0,
"MTU_PROTO_API_IP4": 1,
"MTU_PROTO_API_IP6": 2,
"MTU_PROTO_API_MPLS": 3,
}
var RxMode_name = map[uint32]string{
0: "RX_MODE_API_UNKNOWN",
1: "RX_MODE_API_POLLING",
2: "RX_MODE_API_INTERRUPT",
3: "RX_MODE_API_ADAPTIVE",
4: "RX_MODE_API_DEFAULT",
}
var RxMode_value = map[string]uint32{
"RX_MODE_API_UNKNOWN": 0,
"RX_MODE_API_POLLING": 1,
"RX_MODE_API_INTERRUPT": 2,
"RX_MODE_API_ADAPTIVE": 3,
"RX_MODE_API_DEFAULT": 4,
}
var SubIfFlags_name = map[uint32]string{
1: "SUB_IF_API_FLAG_NO_TAGS",
2: "SUB_IF_API_FLAG_ONE_TAG",
4: "SUB_IF_API_FLAG_TWO_TAGS",
8: "SUB_IF_API_FLAG_DOT1AD",
16: "SUB_IF_API_FLAG_EXACT_MATCH",
32: "SUB_IF_API_FLAG_DEFAULT",
64: "SUB_IF_API_FLAG_OUTER_VLAN_ID_ANY",
128: "SUB_IF_API_FLAG_INNER_VLAN_ID_ANY",
254: "SUB_IF_API_FLAG_MASK_VNET",
256: "SUB_IF_API_FLAG_DOT1AH",
}
var SubIfFlags_value = map[string]uint32{
"SUB_IF_API_FLAG_NO_TAGS": 1,
"SUB_IF_API_FLAG_ONE_TAG": 2,
"SUB_IF_API_FLAG_TWO_TAGS": 4,
"SUB_IF_API_FLAG_DOT1AD": 8,
"SUB_IF_API_FLAG_EXACT_MATCH": 16,
"SUB_IF_API_FLAG_DEFAULT": 32,
"SUB_IF_API_FLAG_OUTER_VLAN_ID_ANY": 64,
"SUB_IF_API_FLAG_INNER_VLAN_ID_ANY": 128,
"SUB_IF_API_FLAG_MASK_VNET": 254,
"SUB_IF_API_FLAG_DOT1AH": 256,
}
Functions ¶
func AllMessages ¶
Messages returns list of all messages in this module.
Types ¶
type IfStatusFlags ¶
type IfStatusFlags uint32
IfStatusFlags represents VPP binary API enum 'if_status_flags'.
const ( IF_STATUS_API_FLAG_ADMIN_UP IfStatusFlags = 1 IF_STATUS_API_FLAG_LINK_UP IfStatusFlags = 2 )
func (IfStatusFlags) String ¶
func (x IfStatusFlags) String() string
type InterfaceIndex ¶
type InterfaceIndex uint32
InterfaceIndex represents VPP binary API alias 'interface_index'.
type LinkDuplex ¶
type LinkDuplex uint32
LinkDuplex represents VPP binary API enum 'link_duplex'.
const ( LINK_DUPLEX_API_UNKNOWN LinkDuplex = 0 LINK_DUPLEX_API_HALF LinkDuplex = 1 LINK_DUPLEX_API_FULL LinkDuplex = 2 )
func (LinkDuplex) String ¶
func (x LinkDuplex) String() string
type NshAddDelEntry ¶
type NshAddDelEntry struct { IsAdd bool NspNsi uint32 MdType uint8 VerOC uint8 TTL uint8 Length uint8 NextProtocol uint8 C1 uint32 C2 uint32 C3 uint32 C4 uint32 TlvLength uint8 Tlv []byte `struc:"[248]byte"` }
NshAddDelEntry represents VPP binary API message 'nsh_add_del_entry'.
func (*NshAddDelEntry) GetCrcString ¶
func (*NshAddDelEntry) GetCrcString() string
func (*NshAddDelEntry) GetMessageName ¶
func (*NshAddDelEntry) GetMessageName() string
func (*NshAddDelEntry) GetMessageType ¶
func (*NshAddDelEntry) GetMessageType() api.MessageType
func (*NshAddDelEntry) Reset ¶
func (m *NshAddDelEntry) Reset()
type NshAddDelEntryReply ¶
NshAddDelEntryReply represents VPP binary API message 'nsh_add_del_entry_reply'.
func (*NshAddDelEntryReply) GetCrcString ¶
func (*NshAddDelEntryReply) GetCrcString() string
func (*NshAddDelEntryReply) GetMessageName ¶
func (*NshAddDelEntryReply) GetMessageName() string
func (*NshAddDelEntryReply) GetMessageType ¶
func (*NshAddDelEntryReply) GetMessageType() api.MessageType
func (*NshAddDelEntryReply) Reset ¶
func (m *NshAddDelEntryReply) Reset()
type NshAddDelMap ¶
type NshAddDelMap struct { IsAdd bool NspNsi uint32 MappedNspNsi uint32 NshAction uint32 SwIfIndex InterfaceIndex RxSwIfIndex InterfaceIndex NextNode uint32 }
NshAddDelMap represents VPP binary API message 'nsh_add_del_map'.
func (*NshAddDelMap) GetCrcString ¶
func (*NshAddDelMap) GetCrcString() string
func (*NshAddDelMap) GetMessageName ¶
func (*NshAddDelMap) GetMessageName() string
func (*NshAddDelMap) GetMessageType ¶
func (*NshAddDelMap) GetMessageType() api.MessageType
func (*NshAddDelMap) Reset ¶
func (m *NshAddDelMap) Reset()
type NshAddDelMapReply ¶
NshAddDelMapReply represents VPP binary API message 'nsh_add_del_map_reply'.
func (*NshAddDelMapReply) GetCrcString ¶
func (*NshAddDelMapReply) GetCrcString() string
func (*NshAddDelMapReply) GetMessageName ¶
func (*NshAddDelMapReply) GetMessageName() string
func (*NshAddDelMapReply) GetMessageType ¶
func (*NshAddDelMapReply) GetMessageType() api.MessageType
func (*NshAddDelMapReply) Reset ¶
func (m *NshAddDelMapReply) Reset()
type NshEntryDetails ¶
type NshEntryDetails struct { EntryIndex uint32 NspNsi uint32 MdType uint8 VerOC uint8 TTL uint8 Length uint8 NextProtocol uint8 C1 uint32 C2 uint32 C3 uint32 C4 uint32 TlvLength uint8 Tlv []byte `struc:"[248]byte"` }
NshEntryDetails represents VPP binary API message 'nsh_entry_details'.
func (*NshEntryDetails) GetCrcString ¶
func (*NshEntryDetails) GetCrcString() string
func (*NshEntryDetails) GetMessageName ¶
func (*NshEntryDetails) GetMessageName() string
func (*NshEntryDetails) GetMessageType ¶
func (*NshEntryDetails) GetMessageType() api.MessageType
func (*NshEntryDetails) Reset ¶
func (m *NshEntryDetails) Reset()
type NshEntryDump ¶
type NshEntryDump struct {
EntryIndex uint32
}
NshEntryDump represents VPP binary API message 'nsh_entry_dump'.
func (*NshEntryDump) GetCrcString ¶
func (*NshEntryDump) GetCrcString() string
func (*NshEntryDump) GetMessageName ¶
func (*NshEntryDump) GetMessageName() string
func (*NshEntryDump) GetMessageType ¶
func (*NshEntryDump) GetMessageType() api.MessageType
func (*NshEntryDump) Reset ¶
func (m *NshEntryDump) Reset()
type NshMapDetails ¶
type NshMapDetails struct { MapIndex uint32 NspNsi uint32 MappedNspNsi uint32 NshAction uint32 SwIfIndex InterfaceIndex RxSwIfIndex InterfaceIndex NextNode uint32 }
NshMapDetails represents VPP binary API message 'nsh_map_details'.
func (*NshMapDetails) GetCrcString ¶
func (*NshMapDetails) GetCrcString() string
func (*NshMapDetails) GetMessageName ¶
func (*NshMapDetails) GetMessageName() string
func (*NshMapDetails) GetMessageType ¶
func (*NshMapDetails) GetMessageType() api.MessageType
func (*NshMapDetails) Reset ¶
func (m *NshMapDetails) Reset()
type NshMapDump ¶
type NshMapDump struct {
MapIndex uint32
}
NshMapDump represents VPP binary API message 'nsh_map_dump'.
func (*NshMapDump) GetCrcString ¶
func (*NshMapDump) GetCrcString() string
func (*NshMapDump) GetMessageName ¶
func (*NshMapDump) GetMessageName() string
func (*NshMapDump) GetMessageType ¶
func (*NshMapDump) GetMessageType() api.MessageType
func (*NshMapDump) Reset ¶
func (m *NshMapDump) Reset()
type RPCService ¶
type RPCService interface { DumpNshEntry(ctx context.Context, in *NshEntryDump) (RPCService_DumpNshEntryClient, error) DumpNshMap(ctx context.Context, in *NshMapDump) (RPCService_DumpNshMapClient, error) NshAddDelEntry(ctx context.Context, in *NshAddDelEntry) (*NshAddDelEntryReply, error) NshAddDelMap(ctx context.Context, in *NshAddDelMap) (*NshAddDelMapReply, error) }
RPCService represents RPC service API for nsh module.
func NewServiceClient ¶
func NewServiceClient(ch api.Channel) RPCService
type RPCService_DumpNshEntryClient ¶
type RPCService_DumpNshEntryClient interface {
Recv() (*NshEntryDetails, error)
}
type RPCService_DumpNshMapClient ¶
type RPCService_DumpNshMapClient interface {
Recv() (*NshMapDetails, error)
}
type SubIfFlags ¶
type SubIfFlags uint32
SubIfFlags represents VPP binary API enum 'sub_if_flags'.
const ( SUB_IF_API_FLAG_NO_TAGS SubIfFlags = 1 SUB_IF_API_FLAG_ONE_TAG SubIfFlags = 2 SUB_IF_API_FLAG_TWO_TAGS SubIfFlags = 4 SUB_IF_API_FLAG_DOT1AD SubIfFlags = 8 SUB_IF_API_FLAG_EXACT_MATCH SubIfFlags = 16 SUB_IF_API_FLAG_DEFAULT SubIfFlags = 32 SUB_IF_API_FLAG_OUTER_VLAN_ID_ANY SubIfFlags = 64 SUB_IF_API_FLAG_INNER_VLAN_ID_ANY SubIfFlags = 128 SUB_IF_API_FLAG_MASK_VNET SubIfFlags = 254 SUB_IF_API_FLAG_DOT1AH SubIfFlags = 256 )
func (SubIfFlags) String ¶
func (x SubIfFlags) String() string