oam

Documentation

Overview

Package oam is a generated VPP binary API for 'oam' module.

It consists of:

5 messages
2 services

Index

• Constants
• func AllMessages() []api.Message
• type OamAddDel
  • func (*OamAddDel) GetCrcString() string
  • func (*OamAddDel) GetMessageName() string
  • func (*OamAddDel) GetMessageType() api.MessageType
  • func (m *OamAddDel) Reset()
• type OamAddDelReply
  • func (*OamAddDelReply) GetCrcString() string
  • func (*OamAddDelReply) GetMessageName() string
  • func (*OamAddDelReply) GetMessageType() api.MessageType
  • func (m *OamAddDelReply) Reset()
• type OamEvent
  • func (*OamEvent) GetCrcString() string
  • func (*OamEvent) GetMessageName() string
  • func (*OamEvent) GetMessageType() api.MessageType
  • func (m *OamEvent) Reset()
• type RPCService
  • func NewServiceClient(ch api.Channel) RPCService
• type WantOamEvents
  • func (*WantOamEvents) GetCrcString() string
  • func (*WantOamEvents) GetMessageName() string
  • func (*WantOamEvents) GetMessageType() api.MessageType
  • func (m *WantOamEvents) Reset()
• type WantOamEventsReply
  • func (*WantOamEventsReply) GetCrcString() string
  • func (*WantOamEventsReply) GetMessageName() string
  • func (*WantOamEventsReply) GetMessageType() api.MessageType
  • func (m *WantOamEventsReply) Reset()

Constants

const (
	// ModuleName is the name of this module.
	ModuleName = "oam"
	// APIVersion is the API version of this module.
	APIVersion = "1.0.0"
	// VersionCrc is the CRC of this module.
	VersionCrc = 0x6aac8f57
)

Functions

func AllMessages

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type OamAddDel

type OamAddDel struct {
	VrfID      uint32
	SrcAddress []byte `struc:"[4]byte"`
	DstAddress []byte `struc:"[4]byte"`
	IsAdd      uint8
}

OamAddDel represents VPP binary API message 'oam_add_del'.

func (*OamAddDel) GetCrcString

func (*OamAddDel) GetCrcString() string

func (*OamAddDel) GetMessageName

func (*OamAddDel) GetMessageName() string

func (*OamAddDel) GetMessageType

func (*OamAddDel) GetMessageType() api.MessageType

func (*OamAddDel) Reset

func (m *OamAddDel) Reset()

type OamAddDelReply

type OamAddDelReply struct {
	Retval int32
}

OamAddDelReply represents VPP binary API message 'oam_add_del_reply'.

func (*OamAddDelReply) GetCrcString

func (*OamAddDelReply) GetCrcString() string

func (*OamAddDelReply) GetMessageName

func (*OamAddDelReply) GetMessageName() string

func (*OamAddDelReply) GetMessageType

func (*OamAddDelReply) GetMessageType() api.MessageType

func (*OamAddDelReply) Reset

func (m *OamAddDelReply) Reset()

type OamEvent

type OamEvent struct {
	DstAddress []byte `struc:"[4]byte"`
	State      uint8
}

OamEvent represents VPP binary API message 'oam_event'.

func (*OamEvent) GetCrcString

func (*OamEvent) GetCrcString() string

func (*OamEvent) GetMessageName

func (*OamEvent) GetMessageName() string

func (*OamEvent) GetMessageType

func (*OamEvent) GetMessageType() api.MessageType

func (*OamEvent) Reset

func (m *OamEvent) Reset()

type RPCService

type RPCService interface {
	OamAddDel(ctx context.Context, in *OamAddDel) (*OamAddDelReply, error)
	WantOamEvents(ctx context.Context, in *WantOamEvents) (*WantOamEventsReply, error)
}

RPCService represents RPC service API for oam module.

func NewServiceClient

func NewServiceClient(ch api.Channel) RPCService

type WantOamEvents

type WantOamEvents struct {
	EnableDisable uint32
	PID           uint32
}

WantOamEvents represents VPP binary API message 'want_oam_events'.

func (*WantOamEvents) GetCrcString

func (*WantOamEvents) GetCrcString() string

func (*WantOamEvents) GetMessageName

func (*WantOamEvents) GetMessageName() string

func (*WantOamEvents) GetMessageType

func (*WantOamEvents) GetMessageType() api.MessageType

func (*WantOamEvents) Reset

func (m *WantOamEvents) Reset()

type WantOamEventsReply

type WantOamEventsReply struct {
	Retval int32
}

WantOamEventsReply represents VPP binary API message 'want_oam_events_reply'.

func (*WantOamEventsReply) GetCrcString

func (*WantOamEventsReply) GetCrcString() string

func (*WantOamEventsReply) GetMessageName

func (*WantOamEventsReply) GetMessageName() string

func (*WantOamEventsReply) GetMessageType

func (*WantOamEventsReply) GetMessageType() api.MessageType

func (*WantOamEventsReply) Reset

func (m *WantOamEventsReply) Reset()