Documentation ¶
Overview ¶
Package ip_neighbor is a generated VPP binary API for 'ip_neighbor' module.
It consists of:
11 enums 7 aliases 7 types 1 union 9 messages 4 services
Index ¶
- Constants
- Variables
- func AllMessages() []api.Message
- type Address
- type AddressFamily
- type AddressUnion
- type AddressWithPrefix
- type IP4Address
- type IP4AddressWithPrefix
- type IP4Prefix
- type IP6Address
- type IP6AddressWithPrefix
- type IP6Prefix
- type IPDscp
- type IPEcn
- type IPNeighbor
- type IPNeighborAddDel
- type IPNeighborAddDelReply
- type IPNeighborConfig
- type IPNeighborConfigReply
- type IPNeighborDetails
- type IPNeighborDump
- type IPNeighborEvent
- type IPNeighborFlags
- type IPProto
- type IfStatusFlags
- type IfType
- type InterfaceIndex
- type LinkDuplex
- type MacAddress
- type Mprefix
- type MtuProto
- type Prefix
- type PrefixMatcher
- type RPCService
- type RPCService_DumpIPNeighborClient
- type RxMode
- type SubIfFlags
- type WantIPNeighborEvents
- type WantIPNeighborEventsReply
Constants ¶
const ( // ModuleName is the name of this module. ModuleName = "ip_neighbor" // APIVersion is the API version of this module. APIVersion = "1.0.0" // VersionCrc is the CRC of this module. VersionCrc = 0xdae37c55 )
Variables ¶
var IPNeighborFlags_name = map[uint8]string{
0: "IP_API_NEIGHBOR_FLAG_NONE",
1: "IP_API_NEIGHBOR_FLAG_STATIC",
2: "IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY",
}
var IPNeighborFlags_value = map[string]uint8{
"IP_API_NEIGHBOR_FLAG_NONE": 0,
"IP_API_NEIGHBOR_FLAG_STATIC": 1,
"IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY": 2,
}
Functions ¶
func AllMessages ¶
Messages returns list of all messages in this module.
Types ¶
type AddressFamily ¶
type AddressFamily = ip_types.AddressFamily
type AddressUnion ¶
type AddressUnion = ip_types.AddressUnion
type AddressWithPrefix ¶
type AddressWithPrefix = ip_types.AddressWithPrefix
type IP4Address ¶
type IP4Address = ip_types.IP4Address
type IP4AddressWithPrefix ¶
type IP4AddressWithPrefix = ip_types.IP4AddressWithPrefix
type IP6Address ¶
type IP6Address = ip_types.IP6Address
type IP6AddressWithPrefix ¶
type IP6AddressWithPrefix = ip_types.IP6AddressWithPrefix
type IPNeighbor ¶
type IPNeighbor struct { SwIfIndex InterfaceIndex Flags IPNeighborFlags MacAddress MacAddress IPAddress Address }
IPNeighbor represents VPP binary API type 'ip_neighbor'.
func (*IPNeighbor) GetTypeName ¶
func (*IPNeighbor) GetTypeName() string
type IPNeighborAddDel ¶
type IPNeighborAddDel struct { IsAdd bool Neighbor IPNeighbor }
IPNeighborAddDel represents VPP binary API message 'ip_neighbor_add_del'.
func (*IPNeighborAddDel) GetCrcString ¶
func (*IPNeighborAddDel) GetCrcString() string
func (*IPNeighborAddDel) GetMessageName ¶
func (*IPNeighborAddDel) GetMessageName() string
func (*IPNeighborAddDel) GetMessageType ¶
func (*IPNeighborAddDel) GetMessageType() api.MessageType
func (*IPNeighborAddDel) Reset ¶
func (m *IPNeighborAddDel) Reset()
type IPNeighborAddDelReply ¶
IPNeighborAddDelReply represents VPP binary API message 'ip_neighbor_add_del_reply'.
func (*IPNeighborAddDelReply) GetCrcString ¶
func (*IPNeighborAddDelReply) GetCrcString() string
func (*IPNeighborAddDelReply) GetMessageName ¶
func (*IPNeighborAddDelReply) GetMessageName() string
func (*IPNeighborAddDelReply) GetMessageType ¶
func (*IPNeighborAddDelReply) GetMessageType() api.MessageType
func (*IPNeighborAddDelReply) Reset ¶
func (m *IPNeighborAddDelReply) Reset()
type IPNeighborConfig ¶
type IPNeighborConfig struct { Af AddressFamily MaxNumber uint32 MaxAge uint32 Recycle bool }
IPNeighborConfig represents VPP binary API message 'ip_neighbor_config'.
func (*IPNeighborConfig) GetCrcString ¶
func (*IPNeighborConfig) GetCrcString() string
func (*IPNeighborConfig) GetMessageName ¶
func (*IPNeighborConfig) GetMessageName() string
func (*IPNeighborConfig) GetMessageType ¶
func (*IPNeighborConfig) GetMessageType() api.MessageType
func (*IPNeighborConfig) Reset ¶
func (m *IPNeighborConfig) Reset()
type IPNeighborConfigReply ¶
type IPNeighborConfigReply struct {
Retval int32
}
IPNeighborConfigReply represents VPP binary API message 'ip_neighbor_config_reply'.
func (*IPNeighborConfigReply) GetCrcString ¶
func (*IPNeighborConfigReply) GetCrcString() string
func (*IPNeighborConfigReply) GetMessageName ¶
func (*IPNeighborConfigReply) GetMessageName() string
func (*IPNeighborConfigReply) GetMessageType ¶
func (*IPNeighborConfigReply) GetMessageType() api.MessageType
func (*IPNeighborConfigReply) Reset ¶
func (m *IPNeighborConfigReply) Reset()
type IPNeighborDetails ¶
type IPNeighborDetails struct {
Neighbor IPNeighbor
}
IPNeighborDetails represents VPP binary API message 'ip_neighbor_details'.
func (*IPNeighborDetails) GetCrcString ¶
func (*IPNeighborDetails) GetCrcString() string
func (*IPNeighborDetails) GetMessageName ¶
func (*IPNeighborDetails) GetMessageName() string
func (*IPNeighborDetails) GetMessageType ¶
func (*IPNeighborDetails) GetMessageType() api.MessageType
func (*IPNeighborDetails) Reset ¶
func (m *IPNeighborDetails) Reset()
type IPNeighborDump ¶
type IPNeighborDump struct { SwIfIndex InterfaceIndex Af AddressFamily }
IPNeighborDump represents VPP binary API message 'ip_neighbor_dump'.
func (*IPNeighborDump) GetCrcString ¶
func (*IPNeighborDump) GetCrcString() string
func (*IPNeighborDump) GetMessageName ¶
func (*IPNeighborDump) GetMessageName() string
func (*IPNeighborDump) GetMessageType ¶
func (*IPNeighborDump) GetMessageType() api.MessageType
func (*IPNeighborDump) Reset ¶
func (m *IPNeighborDump) Reset()
type IPNeighborEvent ¶
type IPNeighborEvent struct { PID uint32 Neighbor IPNeighbor }
IPNeighborEvent represents VPP binary API message 'ip_neighbor_event'.
func (*IPNeighborEvent) GetCrcString ¶
func (*IPNeighborEvent) GetCrcString() string
func (*IPNeighborEvent) GetMessageName ¶
func (*IPNeighborEvent) GetMessageName() string
func (*IPNeighborEvent) GetMessageType ¶
func (*IPNeighborEvent) GetMessageType() api.MessageType
func (*IPNeighborEvent) Reset ¶
func (m *IPNeighborEvent) Reset()
type IPNeighborFlags ¶
type IPNeighborFlags uint8
IPNeighborFlags represents VPP binary API enum 'ip_neighbor_flags'.
const ( IP_API_NEIGHBOR_FLAG_NONE IPNeighborFlags = 0 IP_API_NEIGHBOR_FLAG_STATIC IPNeighborFlags = 1 IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY IPNeighborFlags = 2 )
func (IPNeighborFlags) String ¶
func (x IPNeighborFlags) String() string
type IfStatusFlags ¶
type IfStatusFlags = interface_types.IfStatusFlags
type IfType ¶
type IfType = interface_types.IfType
type InterfaceIndex ¶
type InterfaceIndex = interface_types.InterfaceIndex
type LinkDuplex ¶
type LinkDuplex = interface_types.LinkDuplex
type MacAddress ¶
type MacAddress = ethernet_types.MacAddress
type MtuProto ¶
type MtuProto = interface_types.MtuProto
type PrefixMatcher ¶
type PrefixMatcher = ip_types.PrefixMatcher
type RPCService ¶
type RPCService interface { DumpIPNeighbor(ctx context.Context, in *IPNeighborDump) (RPCService_DumpIPNeighborClient, error) IPNeighborAddDel(ctx context.Context, in *IPNeighborAddDel) (*IPNeighborAddDelReply, error) IPNeighborConfig(ctx context.Context, in *IPNeighborConfig) (*IPNeighborConfigReply, error) WantIPNeighborEvents(ctx context.Context, in *WantIPNeighborEvents) (*WantIPNeighborEventsReply, error) }
RPCService represents RPC service API for ip_neighbor module.
func NewServiceClient ¶
func NewServiceClient(ch api.Channel) RPCService
type RPCService_DumpIPNeighborClient ¶
type RPCService_DumpIPNeighborClient interface {
Recv() (*IPNeighborDetails, error)
}
type RxMode ¶
type RxMode = interface_types.RxMode
type SubIfFlags ¶
type SubIfFlags = interface_types.SubIfFlags
type WantIPNeighborEvents ¶
type WantIPNeighborEvents struct { Enable bool PID uint32 IP Address SwIfIndex InterfaceIndex }
WantIPNeighborEvents represents VPP binary API message 'want_ip_neighbor_events'.
func (*WantIPNeighborEvents) GetCrcString ¶
func (*WantIPNeighborEvents) GetCrcString() string
func (*WantIPNeighborEvents) GetMessageName ¶
func (*WantIPNeighborEvents) GetMessageName() string
func (*WantIPNeighborEvents) GetMessageType ¶
func (*WantIPNeighborEvents) GetMessageType() api.MessageType
func (*WantIPNeighborEvents) Reset ¶
func (m *WantIPNeighborEvents) Reset()
type WantIPNeighborEventsReply ¶
type WantIPNeighborEventsReply struct {
Retval int32
}
WantIPNeighborEventsReply represents VPP binary API message 'want_ip_neighbor_events_reply'.
func (*WantIPNeighborEventsReply) GetCrcString ¶
func (*WantIPNeighborEventsReply) GetCrcString() string
func (*WantIPNeighborEventsReply) GetMessageName ¶
func (*WantIPNeighborEventsReply) GetMessageName() string
func (*WantIPNeighborEventsReply) GetMessageType ¶
func (*WantIPNeighborEventsReply) GetMessageType() api.MessageType
func (*WantIPNeighborEventsReply) Reset ¶
func (m *WantIPNeighborEventsReply) Reset()