ip_neighbor

package
v3.27.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package ip_neighbor contains generated bindings for API file ip_neighbor.api.

Contents: - 2 enums - 1 struct - 20 messages

Index

Constants

View Source 
const (
	APIFile    = "ip_neighbor"
	APIVersion = "1.0.1"
	VersionCrc = 0x36db39bd
)

Variables

View Source 
var (
	IPNeighborEventFlags_name = map[uint32]string{
		1: "IP_NEIGHBOR_API_EVENT_FLAG_ADDED",
		2: "IP_NEIGHBOR_API_EVENT_FLAG_REMOVED",
	}
	IPNeighborEventFlags_value = map[string]uint32{
		"IP_NEIGHBOR_API_EVENT_FLAG_ADDED":   1,
		"IP_NEIGHBOR_API_EVENT_FLAG_REMOVED": 2,
	}
)
View Source 
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",
	}
	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 

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type IPNeighbor 

type IPNeighbor struct {
	SwIfIndex  interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	Flags      IPNeighborFlags                `binapi:"ip_neighbor_flags,name=flags" json:"flags,omitempty"`
	MacAddress ethernet_types.MacAddress      `binapi:"mac_address,name=mac_address" json:"mac_address,omitempty"`
	IPAddress  ip_types.Address               `binapi:"address,name=ip_address" json:"ip_address,omitempty"`
}

IPNeighbor defines type 'ip_neighbor'.

type IPNeighborAddDel 

type IPNeighborAddDel struct {
	IsAdd    bool       `binapi:"bool,name=is_add" json:"is_add,omitempty"`
	Neighbor IPNeighbor `binapi:"ip_neighbor,name=neighbor" json:"neighbor,omitempty"`
}

IP neighbor add / del request

  • is_add - 1 to add neighbor, 0 to delete
  • neighbor - the neighbor to add/remove

IPNeighborAddDel defines 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) Marshal 

func (m *IPNeighborAddDel) Marshal(b []byte) ([]byte, error)

func (*IPNeighborAddDel) Reset 

func (m *IPNeighborAddDel) Reset()

func (*IPNeighborAddDel) Size 

func (m *IPNeighborAddDel) Size() (size int)

func (*IPNeighborAddDel) Unmarshal 

func (m *IPNeighborAddDel) Unmarshal(b []byte) error

type IPNeighborAddDelReply 

type IPNeighborAddDelReply struct {
	Retval     int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	StatsIndex uint32 `binapi:"u32,name=stats_index" json:"stats_index,omitempty"`
}

IP neighbor add / del reply

  • retval - return value
  • stats_index - the index to use for this neighbor in the stats segment

IPNeighborAddDelReply defines 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) Marshal 

func (m *IPNeighborAddDelReply) Marshal(b []byte) ([]byte, error)

func (*IPNeighborAddDelReply) Reset 

func (m *IPNeighborAddDelReply) Reset()

func (*IPNeighborAddDelReply) Size 

func (m *IPNeighborAddDelReply) Size() (size int)

func (*IPNeighborAddDelReply) Unmarshal 

func (m *IPNeighborAddDelReply) Unmarshal(b []byte) error

type IPNeighborConfig 

type IPNeighborConfig struct {
	Af        ip_types.AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
	MaxNumber uint32                 `binapi:"u32,name=max_number" json:"max_number,omitempty"`
	MaxAge    uint32                 `binapi:"u32,name=max_age" json:"max_age,omitempty"`
	Recycle   bool                   `binapi:"bool,name=recycle" json:"recycle,omitempty"`
}

Enable/disable periodic IP neighbor scan

  • af - Address family v4/v6
  • max_number - The maximum number of neighbours that will be created. default 50k
  • max_age - The maximum age (in seconds) before an inactive neighbour is flushed default 0 => never
  • recycle - If max_number of neighbours is reached and new ones need to be created should the oldest neighbour be 'recycled'.

IPNeighborConfig defines 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) Marshal 

func (m *IPNeighborConfig) Marshal(b []byte) ([]byte, error)

func (*IPNeighborConfig) Reset 

func (m *IPNeighborConfig) Reset()

func (*IPNeighborConfig) Size 

func (m *IPNeighborConfig) Size() (size int)

func (*IPNeighborConfig) Unmarshal 

func (m *IPNeighborConfig) Unmarshal(b []byte) error

type IPNeighborConfigGet added in v3.27.0 

type IPNeighborConfigGet struct {
	Af ip_types.AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
}

Get neighbor database configuration per AF

  • af - Address family (v4/v6)

IPNeighborConfigGet defines message 'ip_neighbor_config_get'. InProgress: the message form may change in the future versions

func (*IPNeighborConfigGet) GetCrcString added in v3.27.0 

func (*IPNeighborConfigGet) GetCrcString() string

func (*IPNeighborConfigGet) GetMessageName added in v3.27.0 

func (*IPNeighborConfigGet) GetMessageName() string

func (*IPNeighborConfigGet) GetMessageType added in v3.27.0 

func (*IPNeighborConfigGet) GetMessageType() api.MessageType

func (*IPNeighborConfigGet) Marshal added in v3.27.0 

func (m *IPNeighborConfigGet) Marshal(b []byte) ([]byte, error)

func (*IPNeighborConfigGet) Reset added in v3.27.0 

func (m *IPNeighborConfigGet) Reset()

func (*IPNeighborConfigGet) Size added in v3.27.0 

func (m *IPNeighborConfigGet) Size() (size int)

func (*IPNeighborConfigGet) Unmarshal added in v3.27.0 

func (m *IPNeighborConfigGet) Unmarshal(b []byte) error

type IPNeighborConfigGetReply added in v3.27.0 

type IPNeighborConfigGetReply struct {
	Retval    int32                  `binapi:"i32,name=retval" json:"retval,omitempty"`
	Af        ip_types.AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
	MaxNumber uint32                 `binapi:"u32,name=max_number" json:"max_number,omitempty"`
	MaxAge    uint32                 `binapi:"u32,name=max_age" json:"max_age,omitempty"`
	Recycle   bool                   `binapi:"bool,name=recycle" json:"recycle,omitempty"`
}

Neighbor database configuration reply

  • retval - error (0 is "no error")
  • af - Address family (v4/v6)
  • max_number - The maximum number of neighbours that will be created
  • max_age - The maximum age (in seconds) before an inactive neighbour is flushed
  • recycle - If max_number of neighbours is reached and new ones need to be created, should the oldest neighbour be 'recycled'

IPNeighborConfigGetReply defines message 'ip_neighbor_config_get_reply'. InProgress: the message form may change in the future versions

func (*IPNeighborConfigGetReply) GetCrcString added in v3.27.0 

func (*IPNeighborConfigGetReply) GetCrcString() string

func (*IPNeighborConfigGetReply) GetMessageName added in v3.27.0 

func (*IPNeighborConfigGetReply) GetMessageName() string

func (*IPNeighborConfigGetReply) GetMessageType added in v3.27.0 

func (*IPNeighborConfigGetReply) GetMessageType() api.MessageType

func (*IPNeighborConfigGetReply) Marshal added in v3.27.0 

func (m *IPNeighborConfigGetReply) Marshal(b []byte) ([]byte, error)

func (*IPNeighborConfigGetReply) Reset added in v3.27.0 

func (m *IPNeighborConfigGetReply) Reset()

func (*IPNeighborConfigGetReply) Size added in v3.27.0 

func (m *IPNeighborConfigGetReply) Size() (size int)

func (*IPNeighborConfigGetReply) Unmarshal added in v3.27.0 

func (m *IPNeighborConfigGetReply) Unmarshal(b []byte) error

type IPNeighborConfigReply 

type IPNeighborConfigReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

IPNeighborConfigReply defines 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) Marshal 

func (m *IPNeighborConfigReply) Marshal(b []byte) ([]byte, error)

func (*IPNeighborConfigReply) Reset 

func (m *IPNeighborConfigReply) Reset()

func (*IPNeighborConfigReply) Size 

func (m *IPNeighborConfigReply) Size() (size int)

func (*IPNeighborConfigReply) Unmarshal 

func (m *IPNeighborConfigReply) Unmarshal(b []byte) error

type IPNeighborDetails 

type IPNeighborDetails struct {
	Age      float64    `binapi:"f64,name=age" json:"age,omitempty"`
	Neighbor IPNeighbor `binapi:"ip_neighbor,name=neighbor" json:"neighbor,omitempty"`
}

IP neighbors dump response

  • age - time between last update and sending this message, in seconds
  • neighbour - the neighbor

IPNeighborDetails defines 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) Marshal 

func (m *IPNeighborDetails) Marshal(b []byte) ([]byte, error)

func (*IPNeighborDetails) Reset 

func (m *IPNeighborDetails) Reset()

func (*IPNeighborDetails) Size 

func (m *IPNeighborDetails) Size() (size int)

func (*IPNeighborDetails) Unmarshal 

func (m *IPNeighborDetails) Unmarshal(b []byte) error

type IPNeighborDump 

type IPNeighborDump struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index,default=4294967295" json:"sw_if_index,omitempty"`
	Af        ip_types.AddressFamily         `binapi:"address_family,name=af" json:"af,omitempty"`
}

Dump IP neighbors

  • sw_if_index - the interface to dump neighbors, ~0 == all
  • af - address family is ipv[6|4]

IPNeighborDump defines 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) Marshal 

func (m *IPNeighborDump) Marshal(b []byte) ([]byte, error)

func (*IPNeighborDump) Reset 

func (m *IPNeighborDump) Reset()

func (*IPNeighborDump) Size 

func (m *IPNeighborDump) Size() (size int)

func (*IPNeighborDump) Unmarshal 

func (m *IPNeighborDump) Unmarshal(b []byte) error

type IPNeighborEvent 

type IPNeighborEvent struct {
	PID      uint32     `binapi:"u32,name=pid" json:"pid,omitempty"`
	Neighbor IPNeighbor `binapi:"ip_neighbor,name=neighbor" json:"neighbor,omitempty"`
}

Tell client about an IP4 ARP resolution event or 

       MAC/IP info from ARP requests in L2 BDs
- pid - client pid registered to receive notification
- neighbor - new neighbor created

IPNeighborEvent defines message 'ip_neighbor_event'. Deprecated: the message will be removed in the future versions

func (*IPNeighborEvent) GetCrcString 

func (*IPNeighborEvent) GetCrcString() string

func (*IPNeighborEvent) GetMessageName 

func (*IPNeighborEvent) GetMessageName() string

func (*IPNeighborEvent) GetMessageType 

func (*IPNeighborEvent) GetMessageType() api.MessageType

func (*IPNeighborEvent) Marshal 

func (m *IPNeighborEvent) Marshal(b []byte) ([]byte, error)

func (*IPNeighborEvent) Reset 

func (m *IPNeighborEvent) Reset()

func (*IPNeighborEvent) Size 

func (m *IPNeighborEvent) Size() (size int)

func (*IPNeighborEvent) Unmarshal 

func (m *IPNeighborEvent) Unmarshal(b []byte) error

type IPNeighborEventFlags 

type IPNeighborEventFlags uint32

IPNeighborEventFlags defines enum 'ip_neighbor_event_flags'. 

const (
	IP_NEIGHBOR_API_EVENT_FLAG_ADDED   IPNeighborEventFlags = 1
	IP_NEIGHBOR_API_EVENT_FLAG_REMOVED IPNeighborEventFlags = 2
)

func (IPNeighborEventFlags) String 

func (x IPNeighborEventFlags) String() string

type IPNeighborEventV2 

type IPNeighborEventV2 struct {
	PID      uint32               `binapi:"u32,name=pid" json:"pid,omitempty"`
	Flags    IPNeighborEventFlags `binapi:"ip_neighbor_event_flags,name=flags" json:"flags,omitempty"`
	Neighbor IPNeighbor           `binapi:"ip_neighbor,name=neighbor" json:"neighbor,omitempty"`
}

Tell client about an IP4 ARP resolution event or 

       MAC/IP info from ARP requests in L2 BDs
- pid - client pid registered to receive notification
- flags - Flags
- neighbor -  neighbor

IPNeighborEventV2 defines message 'ip_neighbor_event_v2'.

func (*IPNeighborEventV2) GetCrcString 

func (*IPNeighborEventV2) GetCrcString() string

func (*IPNeighborEventV2) GetMessageName 

func (*IPNeighborEventV2) GetMessageName() string

func (*IPNeighborEventV2) GetMessageType 

func (*IPNeighborEventV2) GetMessageType() api.MessageType

func (*IPNeighborEventV2) Marshal 

func (m *IPNeighborEventV2) Marshal(b []byte) ([]byte, error)

func (*IPNeighborEventV2) Reset 

func (m *IPNeighborEventV2) Reset()

func (*IPNeighborEventV2) Size 

func (m *IPNeighborEventV2) Size() (size int)

func (*IPNeighborEventV2) Unmarshal 

func (m *IPNeighborEventV2) Unmarshal(b []byte) error

type IPNeighborFlags 

type IPNeighborFlags uint8

IPNeighborFlags defines 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 IPNeighborFlush 

type IPNeighborFlush struct {
	Af        ip_types.AddressFamily         `binapi:"address_family,name=af" json:"af,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index,default=4294967295" json:"sw_if_index,omitempty"`
}

IP neighbor flush request - removes *all* neighbours. 

 dynamic and static from API/CLI and dynamic from data-plane.
- af - Flush neighbours of this address family
- sw_if_index - Flush on this interface (~0 => all interfaces)

IPNeighborFlush defines message 'ip_neighbor_flush'.

func (*IPNeighborFlush) GetCrcString 

func (*IPNeighborFlush) GetCrcString() string

func (*IPNeighborFlush) GetMessageName 

func (*IPNeighborFlush) GetMessageName() string

func (*IPNeighborFlush) GetMessageType 

func (*IPNeighborFlush) GetMessageType() api.MessageType

func (*IPNeighborFlush) Marshal 

func (m *IPNeighborFlush) Marshal(b []byte) ([]byte, error)

func (*IPNeighborFlush) Reset 

func (m *IPNeighborFlush) Reset()

func (*IPNeighborFlush) Size 

func (m *IPNeighborFlush) Size() (size int)

func (*IPNeighborFlush) Unmarshal 

func (m *IPNeighborFlush) Unmarshal(b []byte) error

type IPNeighborFlushReply 

type IPNeighborFlushReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

IPNeighborFlushReply defines message 'ip_neighbor_flush_reply'.

func (*IPNeighborFlushReply) GetCrcString 

func (*IPNeighborFlushReply) GetCrcString() string

func (*IPNeighborFlushReply) GetMessageName 

func (*IPNeighborFlushReply) GetMessageName() string

func (*IPNeighborFlushReply) GetMessageType 

func (*IPNeighborFlushReply) GetMessageType() api.MessageType

func (*IPNeighborFlushReply) Marshal 

func (m *IPNeighborFlushReply) Marshal(b []byte) ([]byte, error)

func (*IPNeighborFlushReply) Reset 

func (m *IPNeighborFlushReply) Reset()

func (*IPNeighborFlushReply) Size 

func (m *IPNeighborFlushReply) Size() (size int)

func (*IPNeighborFlushReply) Unmarshal 

func (m *IPNeighborFlushReply) Unmarshal(b []byte) error

type IPNeighborReplaceBegin 

type IPNeighborReplaceBegin struct{}

IP neighbour replace begin 

The use-case is that, for some unspecified reason, the control plane
has a different set of neighbours it than VPP
currently has. The CP would thus like to 'replace' VPP's set
only by specifying what the new set shall be, i.e. it is not
going to delete anything that already exists, rather, it wants any
unspecified neighbors deleted implicitly.
The CP declares the start of this procedure with this replace_begin
API Call, and when it has populated all neighbours it wants, it calls
the below replace_end API. From this point on it is of course free
to add and delete neighbours as usual.
The underlying mechanism by which VPP implements this replace is
intentionally left unspecified.

IPNeighborReplaceBegin defines message 'ip_neighbor_replace_begin'.

func (*IPNeighborReplaceBegin) GetCrcString 

func (*IPNeighborReplaceBegin) GetCrcString() string

func (*IPNeighborReplaceBegin) GetMessageName 

func (*IPNeighborReplaceBegin) GetMessageName() string

func (*IPNeighborReplaceBegin) GetMessageType 

func (*IPNeighborReplaceBegin) GetMessageType() api.MessageType

func (*IPNeighborReplaceBegin) Marshal 

func (m *IPNeighborReplaceBegin) Marshal(b []byte) ([]byte, error)

func (*IPNeighborReplaceBegin) Reset 

func (m *IPNeighborReplaceBegin) Reset()

func (*IPNeighborReplaceBegin) Size 

func (m *IPNeighborReplaceBegin) Size() (size int)

func (*IPNeighborReplaceBegin) Unmarshal 

func (m *IPNeighborReplaceBegin) Unmarshal(b []byte) error

type IPNeighborReplaceBeginReply 

type IPNeighborReplaceBeginReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

IPNeighborReplaceBeginReply defines message 'ip_neighbor_replace_begin_reply'.

func (*IPNeighborReplaceBeginReply) GetCrcString 

func (*IPNeighborReplaceBeginReply) GetCrcString() string

func (*IPNeighborReplaceBeginReply) GetMessageName 

func (*IPNeighborReplaceBeginReply) GetMessageName() string

func (*IPNeighborReplaceBeginReply) GetMessageType 

func (*IPNeighborReplaceBeginReply) GetMessageType() api.MessageType

func (*IPNeighborReplaceBeginReply) Marshal 

func (m *IPNeighborReplaceBeginReply) Marshal(b []byte) ([]byte, error)

func (*IPNeighborReplaceBeginReply) Reset 

func (m *IPNeighborReplaceBeginReply) Reset()

func (*IPNeighborReplaceBeginReply) Size 

func (m *IPNeighborReplaceBeginReply) Size() (size int)

func (*IPNeighborReplaceBeginReply) Unmarshal 

func (m *IPNeighborReplaceBeginReply) Unmarshal(b []byte) error

type IPNeighborReplaceEnd 

type IPNeighborReplaceEnd struct{}

IP neighbour replace end 

see ip_neighbor_replace_begin description.

IPNeighborReplaceEnd defines message 'ip_neighbor_replace_end'.

func (*IPNeighborReplaceEnd) GetCrcString 

func (*IPNeighborReplaceEnd) GetCrcString() string

func (*IPNeighborReplaceEnd) GetMessageName 

func (*IPNeighborReplaceEnd) GetMessageName() string

func (*IPNeighborReplaceEnd) GetMessageType 

func (*IPNeighborReplaceEnd) GetMessageType() api.MessageType

func (*IPNeighborReplaceEnd) Marshal 

func (m *IPNeighborReplaceEnd) Marshal(b []byte) ([]byte, error)

func (*IPNeighborReplaceEnd) Reset 

func (m *IPNeighborReplaceEnd) Reset()

func (*IPNeighborReplaceEnd) Size 

func (m *IPNeighborReplaceEnd) Size() (size int)

func (*IPNeighborReplaceEnd) Unmarshal 

func (m *IPNeighborReplaceEnd) Unmarshal(b []byte) error

type IPNeighborReplaceEndReply 

type IPNeighborReplaceEndReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

IPNeighborReplaceEndReply defines message 'ip_neighbor_replace_end_reply'.

func (*IPNeighborReplaceEndReply) GetCrcString 

func (*IPNeighborReplaceEndReply) GetCrcString() string

func (*IPNeighborReplaceEndReply) GetMessageName 

func (*IPNeighborReplaceEndReply) GetMessageName() string

func (*IPNeighborReplaceEndReply) GetMessageType 

func (*IPNeighborReplaceEndReply) GetMessageType() api.MessageType

func (*IPNeighborReplaceEndReply) Marshal 

func (m *IPNeighborReplaceEndReply) Marshal(b []byte) ([]byte, error)

func (*IPNeighborReplaceEndReply) Reset 

func (m *IPNeighborReplaceEndReply) Reset()

func (*IPNeighborReplaceEndReply) Size 

func (m *IPNeighborReplaceEndReply) Size() (size int)

func (*IPNeighborReplaceEndReply) Unmarshal 

func (m *IPNeighborReplaceEndReply) Unmarshal(b []byte) error

type RPCService 

type RPCService interface {
	IPNeighborAddDel(ctx context.Context, in *IPNeighborAddDel) (*IPNeighborAddDelReply, error)
	IPNeighborConfig(ctx context.Context, in *IPNeighborConfig) (*IPNeighborConfigReply, error)
	IPNeighborConfigGet(ctx context.Context, in *IPNeighborConfigGet) (*IPNeighborConfigGetReply, error)
	IPNeighborDump(ctx context.Context, in *IPNeighborDump) (RPCService_IPNeighborDumpClient, error)
	IPNeighborFlush(ctx context.Context, in *IPNeighborFlush) (*IPNeighborFlushReply, error)
	IPNeighborReplaceBegin(ctx context.Context, in *IPNeighborReplaceBegin) (*IPNeighborReplaceBeginReply, error)
	IPNeighborReplaceEnd(ctx context.Context, in *IPNeighborReplaceEnd) (*IPNeighborReplaceEndReply, error)
	WantIPNeighborEvents(ctx context.Context, in *WantIPNeighborEvents) (*WantIPNeighborEventsReply, error)
	WantIPNeighborEventsV2(ctx context.Context, in *WantIPNeighborEventsV2) (*WantIPNeighborEventsV2Reply, error)
}

RPCService defines RPC service ip_neighbor.

func NewServiceClient 

func NewServiceClient(conn api.Connection) RPCService

type RPCService_IPNeighborDumpClient 

type RPCService_IPNeighborDumpClient interface {
	Recv() (*IPNeighborDetails, error)
	api.Stream
}

type WantIPNeighborEvents 

type WantIPNeighborEvents struct {
	Enable    bool                           `binapi:"bool,name=enable" json:"enable,omitempty"`
	PID       uint32                         `binapi:"u32,name=pid" json:"pid,omitempty"`
	IP        ip_types.Address               `binapi:"address,name=ip" json:"ip,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index,default=4294967295" json:"sw_if_index,omitempty"`
}

Register for IP neighbour events creation

  • enable - 1 => register for events, 0 => cancel registration
  • pid - sender's pid
  • ip - exact IP address of interested neighbor resolution event
  • sw_if_index - interface on which the IP address is present.

WantIPNeighborEvents defines message 'want_ip_neighbor_events'. Deprecated: the message will be removed in the future versions

func (*WantIPNeighborEvents) GetCrcString 

func (*WantIPNeighborEvents) GetCrcString() string

func (*WantIPNeighborEvents) GetMessageName 

func (*WantIPNeighborEvents) GetMessageName() string

func (*WantIPNeighborEvents) GetMessageType 

func (*WantIPNeighborEvents) GetMessageType() api.MessageType

func (*WantIPNeighborEvents) Marshal 

func (m *WantIPNeighborEvents) Marshal(b []byte) ([]byte, error)

func (*WantIPNeighborEvents) Reset 

func (m *WantIPNeighborEvents) Reset()

func (*WantIPNeighborEvents) Size 

func (m *WantIPNeighborEvents) Size() (size int)

func (*WantIPNeighborEvents) Unmarshal 

func (m *WantIPNeighborEvents) Unmarshal(b []byte) error

type WantIPNeighborEventsReply 

type WantIPNeighborEventsReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

WantIPNeighborEventsReply defines message 'want_ip_neighbor_events_reply'. Deprecated: the message will be removed in the future versions

func (*WantIPNeighborEventsReply) GetCrcString 

func (*WantIPNeighborEventsReply) GetCrcString() string

func (*WantIPNeighborEventsReply) GetMessageName 

func (*WantIPNeighborEventsReply) GetMessageName() string

func (*WantIPNeighborEventsReply) GetMessageType 

func (*WantIPNeighborEventsReply) GetMessageType() api.MessageType

func (*WantIPNeighborEventsReply) Marshal 

func (m *WantIPNeighborEventsReply) Marshal(b []byte) ([]byte, error)

func (*WantIPNeighborEventsReply) Reset 

func (m *WantIPNeighborEventsReply) Reset()

func (*WantIPNeighborEventsReply) Size 

func (m *WantIPNeighborEventsReply) Size() (size int)

func (*WantIPNeighborEventsReply) Unmarshal 

func (m *WantIPNeighborEventsReply) Unmarshal(b []byte) error

type WantIPNeighborEventsV2 

type WantIPNeighborEventsV2 struct {
	Enable    bool                           `binapi:"bool,name=enable" json:"enable,omitempty"`
	PID       uint32                         `binapi:"u32,name=pid" json:"pid,omitempty"`
	IP        ip_types.Address               `binapi:"address,name=ip" json:"ip,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index,default=4294967295" json:"sw_if_index,omitempty"`
}

Register for IP neighbour events (creation or deletion)

  • enable - 1 => register for events, 0 => cancel registration
  • pid - sender's pid
  • ip - exact IP address of interested neighbor resolution event
  • sw_if_index - interface on which the IP address is present.

WantIPNeighborEventsV2 defines message 'want_ip_neighbor_events_v2'.

func (*WantIPNeighborEventsV2) GetCrcString 

func (*WantIPNeighborEventsV2) GetCrcString() string

func (*WantIPNeighborEventsV2) GetMessageName 

func (*WantIPNeighborEventsV2) GetMessageName() string

func (*WantIPNeighborEventsV2) GetMessageType 

func (*WantIPNeighborEventsV2) GetMessageType() api.MessageType

func (*WantIPNeighborEventsV2) Marshal 

func (m *WantIPNeighborEventsV2) Marshal(b []byte) ([]byte, error)

func (*WantIPNeighborEventsV2) Reset 

func (m *WantIPNeighborEventsV2) Reset()

func (*WantIPNeighborEventsV2) Size 

func (m *WantIPNeighborEventsV2) Size() (size int)

func (*WantIPNeighborEventsV2) Unmarshal 

func (m *WantIPNeighborEventsV2) Unmarshal(b []byte) error

type WantIPNeighborEventsV2Reply 

type WantIPNeighborEventsV2Reply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

WantIPNeighborEventsV2Reply defines message 'want_ip_neighbor_events_v2_reply'.

func (*WantIPNeighborEventsV2Reply) GetCrcString 

func (*WantIPNeighborEventsV2Reply) GetCrcString() string

func (*WantIPNeighborEventsV2Reply) GetMessageName 

func (*WantIPNeighborEventsV2Reply) GetMessageName() string

func (*WantIPNeighborEventsV2Reply) GetMessageType 

func (*WantIPNeighborEventsV2Reply) GetMessageType() api.MessageType

func (*WantIPNeighborEventsV2Reply) Marshal 

func (m *WantIPNeighborEventsV2Reply) Marshal(b []byte) ([]byte, error)

func (*WantIPNeighborEventsV2Reply) Reset 

func (m *WantIPNeighborEventsV2Reply) Reset()

func (*WantIPNeighborEventsV2Reply) Size 

func (m *WantIPNeighborEventsV2Reply) Size() (size int)

func (*WantIPNeighborEventsV2Reply) Unmarshal 

func (m *WantIPNeighborEventsV2Reply) Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.