Documentation ¶
Overview ¶
Package pipe is a generated VPP binary API for 'pipe' module.
It consists of:
6 enums 1 alias 6 messages 3 services
Index ¶
- Constants
- Variables
- func AllMessages() []api.Message
- type IfStatusFlags
- type IfType
- type InterfaceIndex
- type LinkDuplex
- type MtuProto
- type PipeCreate
- type PipeCreateReply
- type PipeDelete
- type PipeDeleteReply
- type PipeDetails
- type PipeDump
- type RPCService
- type RPCService_DumpPipeClient
- type RxMode
- type SubIfFlags
Constants ¶
const ( // ModuleName is the name of this module. ModuleName = "pipe" // APIVersion is the API version of this module. APIVersion = "1.0.1" // VersionCrc is the CRC of this module. VersionCrc = 0xd22736c9 )
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 PipeCreate ¶
PipeCreate represents VPP binary API message 'pipe_create'.
func (*PipeCreate) GetCrcString ¶
func (*PipeCreate) GetCrcString() string
func (*PipeCreate) GetMessageName ¶
func (*PipeCreate) GetMessageName() string
func (*PipeCreate) GetMessageType ¶
func (*PipeCreate) GetMessageType() api.MessageType
func (*PipeCreate) Reset ¶
func (m *PipeCreate) Reset()
type PipeCreateReply ¶
type PipeCreateReply struct { Retval int32 SwIfIndex InterfaceIndex PipeSwIfIndex []InterfaceIndex `struc:"[2]InterfaceIndex"` }
PipeCreateReply represents VPP binary API message 'pipe_create_reply'.
func (*PipeCreateReply) GetCrcString ¶
func (*PipeCreateReply) GetCrcString() string
func (*PipeCreateReply) GetMessageName ¶
func (*PipeCreateReply) GetMessageName() string
func (*PipeCreateReply) GetMessageType ¶
func (*PipeCreateReply) GetMessageType() api.MessageType
func (*PipeCreateReply) Reset ¶
func (m *PipeCreateReply) Reset()
type PipeDelete ¶
type PipeDelete struct {
SwIfIndex InterfaceIndex
}
PipeDelete represents VPP binary API message 'pipe_delete'.
func (*PipeDelete) GetCrcString ¶
func (*PipeDelete) GetCrcString() string
func (*PipeDelete) GetMessageName ¶
func (*PipeDelete) GetMessageName() string
func (*PipeDelete) GetMessageType ¶
func (*PipeDelete) GetMessageType() api.MessageType
func (*PipeDelete) Reset ¶
func (m *PipeDelete) Reset()
type PipeDeleteReply ¶
type PipeDeleteReply struct {
Retval int32
}
PipeDeleteReply represents VPP binary API message 'pipe_delete_reply'.
func (*PipeDeleteReply) GetCrcString ¶
func (*PipeDeleteReply) GetCrcString() string
func (*PipeDeleteReply) GetMessageName ¶
func (*PipeDeleteReply) GetMessageName() string
func (*PipeDeleteReply) GetMessageType ¶
func (*PipeDeleteReply) GetMessageType() api.MessageType
func (*PipeDeleteReply) Reset ¶
func (m *PipeDeleteReply) Reset()
type PipeDetails ¶
type PipeDetails struct { SwIfIndex InterfaceIndex PipeSwIfIndex []InterfaceIndex `struc:"[2]InterfaceIndex"` Instance uint32 }
PipeDetails represents VPP binary API message 'pipe_details'.
func (*PipeDetails) GetCrcString ¶
func (*PipeDetails) GetCrcString() string
func (*PipeDetails) GetMessageName ¶
func (*PipeDetails) GetMessageName() string
func (*PipeDetails) GetMessageType ¶
func (*PipeDetails) GetMessageType() api.MessageType
func (*PipeDetails) Reset ¶
func (m *PipeDetails) Reset()
type PipeDump ¶
type PipeDump struct{}
PipeDump represents VPP binary API message 'pipe_dump'.
func (*PipeDump) GetCrcString ¶
func (*PipeDump) GetMessageName ¶
func (*PipeDump) GetMessageType ¶
func (*PipeDump) GetMessageType() api.MessageType
type RPCService ¶
type RPCService interface { DumpPipe(ctx context.Context, in *PipeDump) (RPCService_DumpPipeClient, error) PipeCreate(ctx context.Context, in *PipeCreate) (*PipeCreateReply, error) PipeDelete(ctx context.Context, in *PipeDelete) (*PipeDeleteReply, error) }
RPCService represents RPC service API for pipe module.
func NewServiceClient ¶
func NewServiceClient(ch api.Channel) RPCService
type RPCService_DumpPipeClient ¶
type RPCService_DumpPipeClient interface {
Recv() (*PipeDetails, 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