Documentation ¶
Overview ¶
Package memif is a generated VPP binary API for 'memif' module.
It consists of:
8 enums 2 aliases 10 messages 5 services
Index ¶
- Constants
- Variables
- func AllMessages() []api.Message
- type IfStatusFlags
- type IfType
- type InterfaceIndex
- type LinkDuplex
- type MacAddress
- type MemifCreate
- type MemifCreateReply
- type MemifDelete
- type MemifDeleteReply
- type MemifDetails
- type MemifDump
- type MemifMode
- type MemifRole
- type MemifSocketFilenameAddDel
- type MemifSocketFilenameAddDelReply
- type MemifSocketFilenameDetails
- type MemifSocketFilenameDump
- type MtuProto
- type RPCService
- type RPCService_DumpMemifClient
- type RPCService_DumpMemifSocketFilenameClient
- type RxMode
- type SubIfFlags
Constants ¶
const ( // ModuleName is the name of this module. ModuleName = "memif" // VersionCrc is the CRC of this module. VersionCrc = 0x88dc56c9 )
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{
1: "IF_API_TYPE_HARDWARE",
2: "IF_API_TYPE_SUB",
3: "IF_API_TYPE_P2P",
4: "IF_API_TYPE_PIPE",
}
var IfType_value = map[string]uint32{
"IF_API_TYPE_HARDWARE": 1,
"IF_API_TYPE_SUB": 2,
"IF_API_TYPE_P2P": 3,
"IF_API_TYPE_PIPE": 4,
}
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 MemifMode_name = map[uint32]string{
0: "MEMIF_MODE_API_ETHERNET",
1: "MEMIF_MODE_API_IP",
2: "MEMIF_MODE_API_PUNT_INJECT",
}
var MemifMode_value = map[string]uint32{
"MEMIF_MODE_API_ETHERNET": 0,
"MEMIF_MODE_API_IP": 1,
"MEMIF_MODE_API_PUNT_INJECT": 2,
}
var MemifRole_name = map[uint32]string{
0: "MEMIF_ROLE_API_MASTER",
1: "MEMIF_ROLE_API_SLAVE",
}
var MemifRole_value = map[string]uint32{
"MEMIF_ROLE_API_MASTER": 0,
"MEMIF_ROLE_API_SLAVE": 1,
}
var MtuProto_name = map[uint32]string{
1: "MTU_PROTO_API_L3",
2: "MTU_PROTO_API_IP4",
3: "MTU_PROTO_API_IP6",
4: "MTU_PROTO_API_MPLS",
5: "MTU_PROTO_API_N",
}
var MtuProto_value = map[string]uint32{
"MTU_PROTO_API_L3": 1,
"MTU_PROTO_API_IP4": 2,
"MTU_PROTO_API_IP6": 3,
"MTU_PROTO_API_MPLS": 4,
"MTU_PROTO_API_N": 5,
}
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 MacAddress ¶
type MacAddress [6]uint8
MacAddress represents VPP binary API alias 'mac_address'.
type MemifCreate ¶
type MemifCreate struct { Role MemifRole Mode MemifMode RxQueues uint8 TxQueues uint8 ID uint32 SocketID uint32 RingSize uint32 BufferSize uint16 NoZeroCopy bool HwAddr MacAddress Secret string `struc:"[24]byte"` }
MemifCreate represents VPP binary API message 'memif_create'.
func (*MemifCreate) GetCrcString ¶
func (*MemifCreate) GetCrcString() string
func (*MemifCreate) GetMessageName ¶
func (*MemifCreate) GetMessageName() string
func (*MemifCreate) GetMessageType ¶
func (*MemifCreate) GetMessageType() api.MessageType
type MemifCreateReply ¶
type MemifCreateReply struct { Retval int32 SwIfIndex InterfaceIndex }
MemifCreateReply represents VPP binary API message 'memif_create_reply'.
func (*MemifCreateReply) GetCrcString ¶
func (*MemifCreateReply) GetCrcString() string
func (*MemifCreateReply) GetMessageName ¶
func (*MemifCreateReply) GetMessageName() string
func (*MemifCreateReply) GetMessageType ¶
func (*MemifCreateReply) GetMessageType() api.MessageType
type MemifDelete ¶
type MemifDelete struct {
SwIfIndex InterfaceIndex
}
MemifDelete represents VPP binary API message 'memif_delete'.
func (*MemifDelete) GetCrcString ¶
func (*MemifDelete) GetCrcString() string
func (*MemifDelete) GetMessageName ¶
func (*MemifDelete) GetMessageName() string
func (*MemifDelete) GetMessageType ¶
func (*MemifDelete) GetMessageType() api.MessageType
type MemifDeleteReply ¶
type MemifDeleteReply struct {
Retval int32
}
MemifDeleteReply represents VPP binary API message 'memif_delete_reply'.
func (*MemifDeleteReply) GetCrcString ¶
func (*MemifDeleteReply) GetCrcString() string
func (*MemifDeleteReply) GetMessageName ¶
func (*MemifDeleteReply) GetMessageName() string
func (*MemifDeleteReply) GetMessageType ¶
func (*MemifDeleteReply) GetMessageType() api.MessageType
type MemifDetails ¶
type MemifDetails struct { SwIfIndex InterfaceIndex HwAddr MacAddress ID uint32 Role MemifRole Mode MemifMode ZeroCopy bool SocketID uint32 RingSize uint32 BufferSize uint16 Flags IfStatusFlags IfName string `struc:"[64]byte"` }
MemifDetails represents VPP binary API message 'memif_details'.
func (*MemifDetails) GetCrcString ¶
func (*MemifDetails) GetCrcString() string
func (*MemifDetails) GetMessageName ¶
func (*MemifDetails) GetMessageName() string
func (*MemifDetails) GetMessageType ¶
func (*MemifDetails) GetMessageType() api.MessageType
type MemifDump ¶
type MemifDump struct{}
MemifDump represents VPP binary API message 'memif_dump'.
func (*MemifDump) GetCrcString ¶
func (*MemifDump) GetMessageName ¶
func (*MemifDump) GetMessageType ¶
func (*MemifDump) GetMessageType() api.MessageType
type MemifSocketFilenameAddDel ¶
type MemifSocketFilenameAddDel struct { IsAdd bool SocketID uint32 SocketFilename string `struc:"[108]byte"` }
MemifSocketFilenameAddDel represents VPP binary API message 'memif_socket_filename_add_del'.
func (*MemifSocketFilenameAddDel) GetCrcString ¶
func (*MemifSocketFilenameAddDel) GetCrcString() string
func (*MemifSocketFilenameAddDel) GetMessageName ¶
func (*MemifSocketFilenameAddDel) GetMessageName() string
func (*MemifSocketFilenameAddDel) GetMessageType ¶
func (*MemifSocketFilenameAddDel) GetMessageType() api.MessageType
type MemifSocketFilenameAddDelReply ¶
type MemifSocketFilenameAddDelReply struct {
Retval int32
}
MemifSocketFilenameAddDelReply represents VPP binary API message 'memif_socket_filename_add_del_reply'.
func (*MemifSocketFilenameAddDelReply) GetCrcString ¶
func (*MemifSocketFilenameAddDelReply) GetCrcString() string
func (*MemifSocketFilenameAddDelReply) GetMessageName ¶
func (*MemifSocketFilenameAddDelReply) GetMessageName() string
func (*MemifSocketFilenameAddDelReply) GetMessageType ¶
func (*MemifSocketFilenameAddDelReply) GetMessageType() api.MessageType
type MemifSocketFilenameDetails ¶
type MemifSocketFilenameDetails struct { SocketID uint32 SocketFilename string `struc:"[108]byte"` }
MemifSocketFilenameDetails represents VPP binary API message 'memif_socket_filename_details'.
func (*MemifSocketFilenameDetails) GetCrcString ¶
func (*MemifSocketFilenameDetails) GetCrcString() string
func (*MemifSocketFilenameDetails) GetMessageName ¶
func (*MemifSocketFilenameDetails) GetMessageName() string
func (*MemifSocketFilenameDetails) GetMessageType ¶
func (*MemifSocketFilenameDetails) GetMessageType() api.MessageType
type MemifSocketFilenameDump ¶
type MemifSocketFilenameDump struct{}
MemifSocketFilenameDump represents VPP binary API message 'memif_socket_filename_dump'.
func (*MemifSocketFilenameDump) GetCrcString ¶
func (*MemifSocketFilenameDump) GetCrcString() string
func (*MemifSocketFilenameDump) GetMessageName ¶
func (*MemifSocketFilenameDump) GetMessageName() string
func (*MemifSocketFilenameDump) GetMessageType ¶
func (*MemifSocketFilenameDump) GetMessageType() api.MessageType
type RPCService ¶
type RPCService interface { DumpMemif(ctx context.Context, in *MemifDump) (RPCService_DumpMemifClient, error) DumpMemifSocketFilename(ctx context.Context, in *MemifSocketFilenameDump) (RPCService_DumpMemifSocketFilenameClient, error) MemifCreate(ctx context.Context, in *MemifCreate) (*MemifCreateReply, error) MemifDelete(ctx context.Context, in *MemifDelete) (*MemifDeleteReply, error) MemifSocketFilenameAddDel(ctx context.Context, in *MemifSocketFilenameAddDel) (*MemifSocketFilenameAddDelReply, error) }
RPCService represents RPC service API for memif module.
func NewServiceClient ¶
func NewServiceClient(ch api.Channel) RPCService
type RPCService_DumpMemifClient ¶
type RPCService_DumpMemifClient interface {
Recv() (*MemifDetails, error)
}
type RPCService_DumpMemifSocketFilenameClient ¶
type RPCService_DumpMemifSocketFilenameClient interface {
Recv() (*MemifSocketFilenameDetails, 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