nsh

Documentation

Overview

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

It consists of:

8 messages
4 services

Index

• Constants
• func AllMessages() []api.Message
• type NshAddDelEntry
  • func (*NshAddDelEntry) GetCrcString() string
  • func (*NshAddDelEntry) GetMessageName() string
  • func (*NshAddDelEntry) GetMessageType() api.MessageType
  • func (m *NshAddDelEntry) Reset()
• type NshAddDelEntryReply
  • func (*NshAddDelEntryReply) GetCrcString() string
  • func (*NshAddDelEntryReply) GetMessageName() string
  • func (*NshAddDelEntryReply) GetMessageType() api.MessageType
  • func (m *NshAddDelEntryReply) Reset()
• type NshAddDelMap
  • func (*NshAddDelMap) GetCrcString() string
  • func (*NshAddDelMap) GetMessageName() string
  • func (*NshAddDelMap) GetMessageType() api.MessageType
  • func (m *NshAddDelMap) Reset()
• type NshAddDelMapReply
  • func (*NshAddDelMapReply) GetCrcString() string
  • func (*NshAddDelMapReply) GetMessageName() string
  • func (*NshAddDelMapReply) GetMessageType() api.MessageType
  • func (m *NshAddDelMapReply) Reset()
• type NshEntryDetails
  • func (*NshEntryDetails) GetCrcString() string
  • func (*NshEntryDetails) GetMessageName() string
  • func (*NshEntryDetails) GetMessageType() api.MessageType
  • func (m *NshEntryDetails) Reset()
• type NshEntryDump
  • func (*NshEntryDump) GetCrcString() string
  • func (*NshEntryDump) GetMessageName() string
  • func (*NshEntryDump) GetMessageType() api.MessageType
  • func (m *NshEntryDump) Reset()
• type NshMapDetails
  • func (*NshMapDetails) GetCrcString() string
  • func (*NshMapDetails) GetMessageName() string
  • func (*NshMapDetails) GetMessageType() api.MessageType
  • func (m *NshMapDetails) Reset()
• type NshMapDump
  • func (*NshMapDump) GetCrcString() string
  • func (*NshMapDump) GetMessageName() string
  • func (*NshMapDump) GetMessageType() api.MessageType
  • func (m *NshMapDump) Reset()
• type RPCService
  • func NewServiceClient(ch api.Channel) RPCService
• type RPCService_DumpNshEntryClient
• type RPCService_DumpNshMapClient

Constants

const (
	// ModuleName is the name of this module.
	ModuleName = "nsh"
	// VersionCrc is the CRC of this module.
	VersionCrc = 0x6de57acf
)

Functions

func AllMessages

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type NshAddDelEntry

type NshAddDelEntry struct {
	IsAdd        uint8
	NspNsi       uint32
	MdType       uint8
	VerOC        uint8
	TTL          uint8
	Length       uint8
	NextProtocol uint8
	C1           uint32
	C2           uint32
	C3           uint32
	C4           uint32
	TlvLength    uint8
	Tlv          []byte `struc:"[248]byte"`
}

NshAddDelEntry represents VPP binary API message 'nsh_add_del_entry'.

func (*NshAddDelEntry) GetCrcString

func (*NshAddDelEntry) GetCrcString() string

func (*NshAddDelEntry) GetMessageName

func (*NshAddDelEntry) GetMessageName() string

func (*NshAddDelEntry) GetMessageType

func (*NshAddDelEntry) GetMessageType() api.MessageType

func (*NshAddDelEntry) Reset

func (m *NshAddDelEntry) Reset()

type NshAddDelEntryReply

type NshAddDelEntryReply struct {
	Retval     int32
	EntryIndex uint32
}

NshAddDelEntryReply represents VPP binary API message 'nsh_add_del_entry_reply'.

func (*NshAddDelEntryReply) GetCrcString

func (*NshAddDelEntryReply) GetCrcString() string

func (*NshAddDelEntryReply) GetMessageName

func (*NshAddDelEntryReply) GetMessageName() string

func (*NshAddDelEntryReply) GetMessageType

func (*NshAddDelEntryReply) GetMessageType() api.MessageType

func (*NshAddDelEntryReply) Reset

func (m *NshAddDelEntryReply) Reset()

type NshAddDelMap

type NshAddDelMap struct {
	IsAdd        uint8
	NspNsi       uint32
	MappedNspNsi uint32
	NshAction    uint32
	SwIfIndex    uint32
	RxSwIfIndex  uint32
	NextNode     uint32
}

NshAddDelMap represents VPP binary API message 'nsh_add_del_map'.

func (*NshAddDelMap) GetCrcString

func (*NshAddDelMap) GetCrcString() string

func (*NshAddDelMap) GetMessageName

func (*NshAddDelMap) GetMessageName() string

func (*NshAddDelMap) GetMessageType

func (*NshAddDelMap) GetMessageType() api.MessageType

func (*NshAddDelMap) Reset

func (m *NshAddDelMap) Reset()

type NshAddDelMapReply

type NshAddDelMapReply struct {
	Retval   int32
	MapIndex uint32
}

NshAddDelMapReply represents VPP binary API message 'nsh_add_del_map_reply'.

func (*NshAddDelMapReply) GetCrcString

func (*NshAddDelMapReply) GetCrcString() string

func (*NshAddDelMapReply) GetMessageName

func (*NshAddDelMapReply) GetMessageName() string

func (*NshAddDelMapReply) GetMessageType

func (*NshAddDelMapReply) GetMessageType() api.MessageType

func (*NshAddDelMapReply) Reset

func (m *NshAddDelMapReply) Reset()

type NshEntryDetails

type NshEntryDetails struct {
	EntryIndex   uint32
	NspNsi       uint32
	MdType       uint8
	VerOC        uint8
	TTL          uint8
	Length       uint8
	NextProtocol uint8
	C1           uint32
	C2           uint32
	C3           uint32
	C4           uint32
	TlvLength    uint8
	Tlv          []byte `struc:"[248]byte"`
}

NshEntryDetails represents VPP binary API message 'nsh_entry_details'.

func (*NshEntryDetails) GetCrcString

func (*NshEntryDetails) GetCrcString() string

func (*NshEntryDetails) GetMessageName

func (*NshEntryDetails) GetMessageName() string

func (*NshEntryDetails) GetMessageType

func (*NshEntryDetails) GetMessageType() api.MessageType

func (*NshEntryDetails) Reset

func (m *NshEntryDetails) Reset()

type NshEntryDump

type NshEntryDump struct {
	EntryIndex uint32
}

NshEntryDump represents VPP binary API message 'nsh_entry_dump'.

func (*NshEntryDump) GetCrcString

func (*NshEntryDump) GetCrcString() string

func (*NshEntryDump) GetMessageName

func (*NshEntryDump) GetMessageName() string

func (*NshEntryDump) GetMessageType

func (*NshEntryDump) GetMessageType() api.MessageType

func (*NshEntryDump) Reset

func (m *NshEntryDump) Reset()

type NshMapDetails

type NshMapDetails struct {
	MapIndex     uint32
	NspNsi       uint32
	MappedNspNsi uint32
	NshAction    uint32
	SwIfIndex    uint32
	RxSwIfIndex  uint32
	NextNode     uint32
}

NshMapDetails represents VPP binary API message 'nsh_map_details'.

func (*NshMapDetails) GetCrcString

func (*NshMapDetails) GetCrcString() string

func (*NshMapDetails) GetMessageName

func (*NshMapDetails) GetMessageName() string

func (*NshMapDetails) GetMessageType

func (*NshMapDetails) GetMessageType() api.MessageType

func (*NshMapDetails) Reset

func (m *NshMapDetails) Reset()

type NshMapDump

type NshMapDump struct {
	MapIndex uint32
}

NshMapDump represents VPP binary API message 'nsh_map_dump'.

func (*NshMapDump) GetCrcString

func (*NshMapDump) GetCrcString() string

func (*NshMapDump) GetMessageName

func (*NshMapDump) GetMessageName() string

func (*NshMapDump) GetMessageType

func (*NshMapDump) GetMessageType() api.MessageType

func (*NshMapDump) Reset

func (m *NshMapDump) Reset()

type RPCService

type RPCService interface {
	DumpNshEntry(ctx context.Context, in *NshEntryDump) (RPCService_DumpNshEntryClient, error)
	DumpNshMap(ctx context.Context, in *NshMapDump) (RPCService_DumpNshMapClient, error)
	NshAddDelEntry(ctx context.Context, in *NshAddDelEntry) (*NshAddDelEntryReply, error)
	NshAddDelMap(ctx context.Context, in *NshAddDelMap) (*NshAddDelMapReply, error)
}

RPCService represents RPC service API for nsh module.

func NewServiceClient

func NewServiceClient(ch api.Channel) RPCService

type RPCService_DumpNshEntryClient

type RPCService_DumpNshEntryClient interface {
	Recv() (*NshEntryDetails, error)
}

type RPCService_DumpNshMapClient

type RPCService_DumpNshMapClient interface {
	Recv() (*NshMapDetails, error)
}