punt

Documentation

Overview

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

It consists of:

 1 type
10 messages
 5 services

Index

• Constants
• func AllMessages() []api.Message
• type Punt
  • func (*Punt) GetCrcString() string
  • func (*Punt) GetTypeName() string
• type PuntDetails
  • func (*PuntDetails) GetCrcString() string
  • func (*PuntDetails) GetMessageName() string
  • func (*PuntDetails) GetMessageType() api.MessageType
• type PuntDump
  • func (*PuntDump) GetCrcString() string
  • func (*PuntDump) GetMessageName() string
  • func (*PuntDump) GetMessageType() api.MessageType
• type PuntSocketDeregister
  • func (*PuntSocketDeregister) GetCrcString() string
  • func (*PuntSocketDeregister) GetMessageName() string
  • func (*PuntSocketDeregister) GetMessageType() api.MessageType
• type PuntSocketDeregisterReply
  • func (*PuntSocketDeregisterReply) GetCrcString() string
  • func (*PuntSocketDeregisterReply) GetMessageName() string
  • func (*PuntSocketDeregisterReply) GetMessageType() api.MessageType
• type PuntSocketDetails
  • func (*PuntSocketDetails) GetCrcString() string
  • func (*PuntSocketDetails) GetMessageName() string
  • func (*PuntSocketDetails) GetMessageType() api.MessageType
• type PuntSocketDump
  • func (*PuntSocketDump) GetCrcString() string
  • func (*PuntSocketDump) GetMessageName() string
  • func (*PuntSocketDump) GetMessageType() api.MessageType
• type PuntSocketRegister
  • func (*PuntSocketRegister) GetCrcString() string
  • func (*PuntSocketRegister) GetMessageName() string
  • func (*PuntSocketRegister) GetMessageType() api.MessageType
• type PuntSocketRegisterReply
  • func (*PuntSocketRegisterReply) GetCrcString() string
  • func (*PuntSocketRegisterReply) GetMessageName() string
  • func (*PuntSocketRegisterReply) GetMessageType() api.MessageType
• type RPCService
  • func NewServiceClient(ch api.Channel) RPCService
• type RPCService_DumpPuntClient
• type RPCService_DumpPuntSocketClient
• type SetPunt
  • func (*SetPunt) GetCrcString() string
  • func (*SetPunt) GetMessageName() string
  • func (*SetPunt) GetMessageType() api.MessageType
• type SetPuntReply
  • func (*SetPuntReply) GetCrcString() string
  • func (*SetPuntReply) GetMessageName() string
  • func (*SetPuntReply) GetMessageType() api.MessageType

Constants

const (
	// ModuleName is the name of this module.
	ModuleName = "punt"
	// APIVersion is the API version of this module.
	APIVersion = "2.0.0"
	// VersionCrc is the CRC of this module.
	VersionCrc = 0x1c487f2b
)

Functions

func AllMessages

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type Punt

type Punt struct {
	IPv        uint8
	L4Protocol uint8
	L4Port     uint16
}

Punt represents VPP binary API type 'punt'.

func (*Punt) GetCrcString

func (*Punt) GetCrcString() string

func (*Punt) GetTypeName

func (*Punt) GetTypeName() string

type PuntDetails

type PuntDetails struct {
	Punt Punt
}

PuntDetails represents VPP binary API message 'punt_details'.

func (*PuntDetails) GetCrcString

func (*PuntDetails) GetCrcString() string

func (*PuntDetails) GetMessageName

func (*PuntDetails) GetMessageName() string

func (*PuntDetails) GetMessageType

func (*PuntDetails) GetMessageType() api.MessageType

type PuntDump

type PuntDump struct {
	IsIPv6 uint8
}

PuntDump represents VPP binary API message 'punt_dump'.

func (*PuntDump) GetCrcString

func (*PuntDump) GetCrcString() string

func (*PuntDump) GetMessageName

func (*PuntDump) GetMessageName() string

func (*PuntDump) GetMessageType

func (*PuntDump) GetMessageType() api.MessageType

type PuntSocketDeregister

type PuntSocketDeregister struct {
	Punt Punt
}

PuntSocketDeregister represents VPP binary API message 'punt_socket_deregister'.

func (*PuntSocketDeregister) GetCrcString

func (*PuntSocketDeregister) GetCrcString() string

func (*PuntSocketDeregister) GetMessageName

func (*PuntSocketDeregister) GetMessageName() string

func (*PuntSocketDeregister) GetMessageType

func (*PuntSocketDeregister) GetMessageType() api.MessageType

type PuntSocketDeregisterReply

type PuntSocketDeregisterReply struct {
	Retval int32
}

PuntSocketDeregisterReply represents VPP binary API message 'punt_socket_deregister_reply'.

func (*PuntSocketDeregisterReply) GetCrcString

func (*PuntSocketDeregisterReply) GetCrcString() string

func (*PuntSocketDeregisterReply) GetMessageName

func (*PuntSocketDeregisterReply) GetMessageName() string

func (*PuntSocketDeregisterReply) GetMessageType

func (*PuntSocketDeregisterReply) GetMessageType() api.MessageType

type PuntSocketDetails

type PuntSocketDetails struct {
	Punt     Punt
	Pathname []byte `struc:"[108]byte"`
}

PuntSocketDetails represents VPP binary API message 'punt_socket_details'.

func (*PuntSocketDetails) GetCrcString

func (*PuntSocketDetails) GetCrcString() string

func (*PuntSocketDetails) GetMessageName

func (*PuntSocketDetails) GetMessageName() string

func (*PuntSocketDetails) GetMessageType

func (*PuntSocketDetails) GetMessageType() api.MessageType

type PuntSocketDump

type PuntSocketDump struct {
	IsIPv6 uint8
}

PuntSocketDump represents VPP binary API message 'punt_socket_dump'.

func (*PuntSocketDump) GetCrcString

func (*PuntSocketDump) GetCrcString() string

func (*PuntSocketDump) GetMessageName

func (*PuntSocketDump) GetMessageName() string

func (*PuntSocketDump) GetMessageType

func (*PuntSocketDump) GetMessageType() api.MessageType

type PuntSocketRegister

type PuntSocketRegister struct {
	HeaderVersion uint32
	Punt          Punt
	Pathname      []byte `struc:"[108]byte"`
}

PuntSocketRegister represents VPP binary API message 'punt_socket_register'.

func (*PuntSocketRegister) GetCrcString

func (*PuntSocketRegister) GetCrcString() string

func (*PuntSocketRegister) GetMessageName

func (*PuntSocketRegister) GetMessageName() string

func (*PuntSocketRegister) GetMessageType

func (*PuntSocketRegister) GetMessageType() api.MessageType

type PuntSocketRegisterReply

type PuntSocketRegisterReply struct {
	Retval   int32
	Pathname []byte `struc:"[64]byte"`
}

PuntSocketRegisterReply represents VPP binary API message 'punt_socket_register_reply'.

func (*PuntSocketRegisterReply) GetCrcString

func (*PuntSocketRegisterReply) GetCrcString() string

func (*PuntSocketRegisterReply) GetMessageName

func (*PuntSocketRegisterReply) GetMessageName() string

func (*PuntSocketRegisterReply) GetMessageType

func (*PuntSocketRegisterReply) GetMessageType() api.MessageType

type RPCService

type RPCService interface {
	DumpPunt(ctx context.Context, in *PuntDump) (RPCService_DumpPuntClient, error)
	DumpPuntSocket(ctx context.Context, in *PuntSocketDump) (RPCService_DumpPuntSocketClient, error)
	PuntSocketDeregister(ctx context.Context, in *PuntSocketDeregister) (*PuntSocketDeregisterReply, error)
	PuntSocketRegister(ctx context.Context, in *PuntSocketRegister) (*PuntSocketRegisterReply, error)
	SetPunt(ctx context.Context, in *SetPunt) (*SetPuntReply, error)
}

RPCService represents RPC service API for punt module.

func NewServiceClient

func NewServiceClient(ch api.Channel) RPCService

type RPCService_DumpPuntClient

type RPCService_DumpPuntClient interface {
	Recv() (*PuntDetails, error)
}

type RPCService_DumpPuntSocketClient

type RPCService_DumpPuntSocketClient interface {
	Recv() (*PuntSocketDetails, error)
}

type SetPunt

type SetPunt struct {
	IsAdd uint8
	Punt  Punt
}

SetPunt represents VPP binary API message 'set_punt'.

func (*SetPunt) GetCrcString

func (*SetPunt) GetCrcString() string

func (*SetPunt) GetMessageName

func (*SetPunt) GetMessageName() string

func (*SetPunt) GetMessageType

func (*SetPunt) GetMessageType() api.MessageType

type SetPuntReply

type SetPuntReply struct {
	Retval int32
}

SetPuntReply represents VPP binary API message 'set_punt_reply'.

func (*SetPuntReply) GetCrcString

func (*SetPuntReply) GetCrcString() string

func (*SetPuntReply) GetMessageName

func (*SetPuntReply) GetMessageName() string

func (*SetPuntReply) GetMessageType

func (*SetPuntReply) GetMessageType() api.MessageType