pipe

Documentation

Overview

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

It consists of:

6 messages
3 services

Index

• Constants
• func AllMessages() []api.Message
• type PipeCreate
  • func (*PipeCreate) GetCrcString() string
  • func (*PipeCreate) GetMessageName() string
  • func (*PipeCreate) GetMessageType() api.MessageType
  • func (m *PipeCreate) Reset()
• type PipeCreateReply
  • func (*PipeCreateReply) GetCrcString() string
  • func (*PipeCreateReply) GetMessageName() string
  • func (*PipeCreateReply) GetMessageType() api.MessageType
  • func (m *PipeCreateReply) Reset()
• type PipeDelete
  • func (*PipeDelete) GetCrcString() string
  • func (*PipeDelete) GetMessageName() string
  • func (*PipeDelete) GetMessageType() api.MessageType
  • func (m *PipeDelete) Reset()
• type PipeDeleteReply
  • func (*PipeDeleteReply) GetCrcString() string
  • func (*PipeDeleteReply) GetMessageName() string
  • func (*PipeDeleteReply) GetMessageType() api.MessageType
  • func (m *PipeDeleteReply) Reset()
• type PipeDetails
  • func (*PipeDetails) GetCrcString() string
  • func (*PipeDetails) GetMessageName() string
  • func (*PipeDetails) GetMessageType() api.MessageType
  • func (m *PipeDetails) Reset()
• type PipeDump
  • func (*PipeDump) GetCrcString() string
  • func (*PipeDump) GetMessageName() string
  • func (*PipeDump) GetMessageType() api.MessageType
  • func (m *PipeDump) Reset()
• type RPCService
  • func NewServiceClient(ch api.Channel) RPCService
• type RPCService_DumpPipeClient

Constants

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

Functions

func AllMessages

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type PipeCreate

type PipeCreate struct {
	IsSpecified  uint8
	UserInstance uint32
}

PipeCreate represents VPP binary API message 'pipe_create'.

func (*PipeCreate) GetCrcString

func (*PipeCreate) GetCrcString() string

func (*PipeCreate) GetMessageName

func (*PipeCreate) GetMessageName() string

func (*PipeCreate) GetMessageType

func (*PipeCreate) GetMessageType() api.MessageType

func (*PipeCreate) Reset

func (m *PipeCreate) Reset()

type PipeCreateReply

type PipeCreateReply struct {
	Retval        int32
	SwIfIndex     uint32
	PipeSwIfIndex []uint32 `struc:"[2]uint32"`
}

PipeCreateReply represents VPP binary API message 'pipe_create_reply'.

func (*PipeCreateReply) GetCrcString

func (*PipeCreateReply) GetCrcString() string

func (*PipeCreateReply) GetMessageName

func (*PipeCreateReply) GetMessageName() string

func (*PipeCreateReply) GetMessageType

func (*PipeCreateReply) GetMessageType() api.MessageType

func (*PipeCreateReply) Reset

func (m *PipeCreateReply) Reset()

type PipeDelete

type PipeDelete struct {
	SwIfIndex uint32
}

PipeDelete represents VPP binary API message 'pipe_delete'.

func (*PipeDelete) GetCrcString

func (*PipeDelete) GetCrcString() string

func (*PipeDelete) GetMessageName

func (*PipeDelete) GetMessageName() string

func (*PipeDelete) GetMessageType

func (*PipeDelete) GetMessageType() api.MessageType

func (*PipeDelete) Reset

func (m *PipeDelete) Reset()

type PipeDeleteReply

type PipeDeleteReply struct {
	Retval int32
}

PipeDeleteReply represents VPP binary API message 'pipe_delete_reply'.

func (*PipeDeleteReply) GetCrcString

func (*PipeDeleteReply) GetCrcString() string

func (*PipeDeleteReply) GetMessageName

func (*PipeDeleteReply) GetMessageName() string

func (*PipeDeleteReply) GetMessageType

func (*PipeDeleteReply) GetMessageType() api.MessageType

func (*PipeDeleteReply) Reset

func (m *PipeDeleteReply) Reset()

type PipeDetails

type PipeDetails struct {
	SwIfIndex     uint32
	PipeSwIfIndex []uint32 `struc:"[2]uint32"`
	Instance      uint32
}

PipeDetails represents VPP binary API message 'pipe_details'.

func (*PipeDetails) GetCrcString

func (*PipeDetails) GetCrcString() string

func (*PipeDetails) GetMessageName

func (*PipeDetails) GetMessageName() string

func (*PipeDetails) GetMessageType

func (*PipeDetails) GetMessageType() api.MessageType

func (*PipeDetails) Reset

func (m *PipeDetails) Reset()

type PipeDump

type PipeDump struct{}

PipeDump represents VPP binary API message 'pipe_dump'.

func (*PipeDump) GetCrcString

func (*PipeDump) GetCrcString() string

func (*PipeDump) GetMessageName

func (*PipeDump) GetMessageName() string

func (*PipeDump) GetMessageType

func (*PipeDump) GetMessageType() api.MessageType

func (*PipeDump) Reset

func (m *PipeDump) Reset()

type RPCService

type RPCService interface {
	DumpPipe(ctx context.Context, in *PipeDump) (RPCService_DumpPipeClient, error)
	PipeCreate(ctx context.Context, in *PipeCreate) (*PipeCreateReply, error)
	PipeDelete(ctx context.Context, in *PipeDelete) (*PipeDeleteReply, error)
}

RPCService represents RPC service API for pipe module.

func NewServiceClient

func NewServiceClient(ch api.Channel) RPCService

type RPCService_DumpPipeClient

type RPCService_DumpPipeClient interface {
	Recv() (*PipeDetails, error)
}