vlib

package
v3.28.0 Latest Latest
Warning

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

 Go to latest Published: May 31, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

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

Contents: - 1 struct - 18 messages

Index

Constants

View Source 
const (
	APIFile    = "vlib"
	APIVersion = "1.0.0"
	VersionCrc = 0x9a9e84e4
)

Variables

This section is empty.

Functions

func AllMessages 

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type AddNodeNext 

type AddNodeNext struct {
	NodeName string `binapi:"string[64],name=node_name" json:"node_name,omitempty"`
	NextName string `binapi:"string[64],name=next_name" json:"next_name,omitempty"`
}

Set the next node for a given node request

  • node_name[] - node to add the next node to
  • next_name[] - node to add as the next node

AddNodeNext defines message 'add_node_next'.

func (*AddNodeNext) GetCrcString 

func (*AddNodeNext) GetCrcString() string

func (*AddNodeNext) GetMessageName 

func (*AddNodeNext) GetMessageName() string

func (*AddNodeNext) GetMessageType 

func (*AddNodeNext) GetMessageType() api.MessageType

func (*AddNodeNext) Marshal 

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

func (*AddNodeNext) Reset 

func (m *AddNodeNext) Reset()

func (*AddNodeNext) Size 

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

func (*AddNodeNext) Unmarshal 

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

type AddNodeNextReply 

type AddNodeNextReply struct {
	Retval    int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	NextIndex uint32 `binapi:"u32,name=next_index" json:"next_index,omitempty"`
}

IP Set the next node for a given node response

  • retval - return code for the add next node request
  • next_index - the index of the next node if success, else ~0

AddNodeNextReply defines message 'add_node_next_reply'.

func (*AddNodeNextReply) GetCrcString 

func (*AddNodeNextReply) GetCrcString() string

func (*AddNodeNextReply) GetMessageName 

func (*AddNodeNextReply) GetMessageName() string

func (*AddNodeNextReply) GetMessageType 

func (*AddNodeNextReply) GetMessageType() api.MessageType

func (*AddNodeNextReply) Marshal 

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

func (*AddNodeNextReply) Reset 

func (m *AddNodeNextReply) Reset()

func (*AddNodeNextReply) Size 

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

func (*AddNodeNextReply) Unmarshal 

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

type Cli 

type Cli struct {
	CmdInShmem uint64 `binapi:"u64,name=cmd_in_shmem" json:"cmd_in_shmem,omitempty"`
}

Process a vpe parser cli string request

  • cmd_in_shmem - pointer to cli command string

Cli defines message 'cli'.

func (*Cli) GetCrcString 

func (*Cli) GetCrcString() string

func (*Cli) GetMessageName 

func (*Cli) GetMessageName() string

func (*Cli) GetMessageType 

func (*Cli) GetMessageType() api.MessageType

func (*Cli) Marshal 

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

func (*Cli) Reset 

func (m *Cli) Reset()

func (*Cli) Size 

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

func (*Cli) Unmarshal 

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

type CliInband 

type CliInband struct {
	Cmd string `binapi:"string[],name=cmd" json:"cmd,omitempty"`
}

CliInband defines message 'cli_inband'.

func (*CliInband) GetCrcString 

func (*CliInband) GetCrcString() string

func (*CliInband) GetMessageName 

func (*CliInband) GetMessageName() string

func (*CliInband) GetMessageType 

func (*CliInband) GetMessageType() api.MessageType

func (*CliInband) Marshal 

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

func (*CliInband) Reset 

func (m *CliInband) Reset()

func (*CliInband) Size 

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

func (*CliInband) Unmarshal 

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

type CliInbandReply 

type CliInbandReply struct {
	Retval int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	Reply  string `binapi:"string[],name=reply" json:"reply,omitempty"`
}

CliInbandReply defines message 'cli_inband_reply'.

func (*CliInbandReply) GetCrcString 

func (*CliInbandReply) GetCrcString() string

func (*CliInbandReply) GetMessageName 

func (*CliInbandReply) GetMessageName() string

func (*CliInbandReply) GetMessageType 

func (*CliInbandReply) GetMessageType() api.MessageType

func (*CliInbandReply) Marshal 

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

func (*CliInbandReply) Reset 

func (m *CliInbandReply) Reset()

func (*CliInbandReply) Size 

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

func (*CliInbandReply) Unmarshal 

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

type CliReply 

type CliReply struct {
	Retval       int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	ReplyInShmem uint64 `binapi:"u64,name=reply_in_shmem" json:"reply_in_shmem,omitempty"`
}

vpe parser cli string response

  • retval - return code for request
  • reply_in_shmem - Reply string from cli processing if any

CliReply defines message 'cli_reply'.

func (*CliReply) GetCrcString 

func (*CliReply) GetCrcString() string

func (*CliReply) GetMessageName 

func (*CliReply) GetMessageName() string

func (*CliReply) GetMessageType 

func (*CliReply) GetMessageType() api.MessageType

func (*CliReply) Marshal 

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

func (*CliReply) Reset 

func (m *CliReply) Reset()

func (*CliReply) Size 

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

func (*CliReply) Unmarshal 

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

type GetF64EndianValue 

type GetF64EndianValue struct {
	F64One float64 `binapi:"f64,name=f64_one,default=1" json:"f64_one,omitempty"`
}

f64 types are not standardized across the wire. Sense wire format in each direction by sending the f64 value 1.0.

  • f64_one - The constant of 1.0. If you send a different value, expect an rv=VNET_API_ERROR_API_ENDIAN_FAILED.

GetF64EndianValue defines message 'get_f64_endian_value'.

func (*GetF64EndianValue) GetCrcString 

func (*GetF64EndianValue) GetCrcString() string

func (*GetF64EndianValue) GetMessageName 

func (*GetF64EndianValue) GetMessageName() string

func (*GetF64EndianValue) GetMessageType 

func (*GetF64EndianValue) GetMessageType() api.MessageType

func (*GetF64EndianValue) Marshal 

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

func (*GetF64EndianValue) Reset 

func (m *GetF64EndianValue) Reset()

func (*GetF64EndianValue) Size 

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

func (*GetF64EndianValue) Unmarshal 

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

type GetF64EndianValueReply 

type GetF64EndianValueReply struct {
	Retval       uint32  `binapi:"u32,name=retval" json:"retval,omitempty"`
	F64OneResult float64 `binapi:"f64,name=f64_one_result" json:"f64_one_result,omitempty"`
}

get_f64_endian_value reply message

  • retval - return value - VNET_API_ERROR_API_ENDIAN_FAILED if f64_one != 1.0
  • f64_one_result - The value of 'f64 1.0'

GetF64EndianValueReply defines message 'get_f64_endian_value_reply'.

func (*GetF64EndianValueReply) GetCrcString 

func (*GetF64EndianValueReply) GetCrcString() string

func (*GetF64EndianValueReply) GetMessageName 

func (*GetF64EndianValueReply) GetMessageName() string

func (*GetF64EndianValueReply) GetMessageType 

func (*GetF64EndianValueReply) GetMessageType() api.MessageType

func (*GetF64EndianValueReply) Marshal 

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

func (*GetF64EndianValueReply) Reset 

func (m *GetF64EndianValueReply) Reset()

func (*GetF64EndianValueReply) Size 

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

func (*GetF64EndianValueReply) Unmarshal 

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

type GetF64IncrementByOne 

type GetF64IncrementByOne struct {
	F64Value float64 `binapi:"f64,name=f64_value,default=1" json:"f64_value,omitempty"`
}

Verify f64 wire format by sending a value and receiving the value + 1.0

  • f64_value - The value you want to test. Default: 1.0.

GetF64IncrementByOne defines message 'get_f64_increment_by_one'.

func (*GetF64IncrementByOne) GetCrcString 

func (*GetF64IncrementByOne) GetCrcString() string

func (*GetF64IncrementByOne) GetMessageName 

func (*GetF64IncrementByOne) GetMessageName() string

func (*GetF64IncrementByOne) GetMessageType 

func (*GetF64IncrementByOne) GetMessageType() api.MessageType

func (*GetF64IncrementByOne) Marshal 

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

func (*GetF64IncrementByOne) Reset 

func (m *GetF64IncrementByOne) Reset()

func (*GetF64IncrementByOne) Size 

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

func (*GetF64IncrementByOne) Unmarshal 

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

type GetF64IncrementByOneReply 

type GetF64IncrementByOneReply struct {
	Retval   uint32  `binapi:"u32,name=retval" json:"retval,omitempty"`
	F64Value float64 `binapi:"f64,name=f64_value" json:"f64_value,omitempty"`
}

get_f64_increment_by_one reply

  • f64_value - The input f64_value incremented by 1.0.

GetF64IncrementByOneReply defines message 'get_f64_increment_by_one_reply'.

func (*GetF64IncrementByOneReply) GetCrcString 

func (*GetF64IncrementByOneReply) GetCrcString() string

func (*GetF64IncrementByOneReply) GetMessageName 

func (*GetF64IncrementByOneReply) GetMessageName() string

func (*GetF64IncrementByOneReply) GetMessageType 

func (*GetF64IncrementByOneReply) GetMessageType() api.MessageType

func (*GetF64IncrementByOneReply) Marshal 

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

func (*GetF64IncrementByOneReply) Reset 

func (m *GetF64IncrementByOneReply) Reset()

func (*GetF64IncrementByOneReply) Size 

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

func (*GetF64IncrementByOneReply) Unmarshal 

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

type GetNextIndex 

type GetNextIndex struct {
	NodeName string `binapi:"string[64],name=node_name" json:"node_name,omitempty"`
	NextName string `binapi:"string[64],name=next_name" json:"next_name,omitempty"`
}

Query relative index via node names

  • node_name - name of node to find relative index from
  • next_name - next node from node_name to find relative index of

GetNextIndex defines message 'get_next_index'.

func (*GetNextIndex) GetCrcString 

func (*GetNextIndex) GetCrcString() string

func (*GetNextIndex) GetMessageName 

func (*GetNextIndex) GetMessageName() string

func (*GetNextIndex) GetMessageType 

func (*GetNextIndex) GetMessageType() api.MessageType

func (*GetNextIndex) Marshal 

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

func (*GetNextIndex) Reset 

func (m *GetNextIndex) Reset()

func (*GetNextIndex) Size 

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

func (*GetNextIndex) Unmarshal 

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

type GetNextIndexReply 

type GetNextIndexReply struct {
	Retval    int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	NextIndex uint32 `binapi:"u32,name=next_index" json:"next_index,omitempty"`
}

Reply for get next node index

  • retval - return value
  • next_index - index of the next_node

GetNextIndexReply defines message 'get_next_index_reply'.

func (*GetNextIndexReply) GetCrcString 

func (*GetNextIndexReply) GetCrcString() string

func (*GetNextIndexReply) GetMessageName 

func (*GetNextIndexReply) GetMessageName() string

func (*GetNextIndexReply) GetMessageType 

func (*GetNextIndexReply) GetMessageType() api.MessageType

func (*GetNextIndexReply) Marshal 

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

func (*GetNextIndexReply) Reset 

func (m *GetNextIndexReply) Reset()

func (*GetNextIndexReply) Size 

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

func (*GetNextIndexReply) Unmarshal 

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

type GetNodeGraph 

type GetNodeGraph struct{}

GetNodeGraph defines message 'get_node_graph'.

func (*GetNodeGraph) GetCrcString 

func (*GetNodeGraph) GetCrcString() string

func (*GetNodeGraph) GetMessageName 

func (*GetNodeGraph) GetMessageName() string

func (*GetNodeGraph) GetMessageType 

func (*GetNodeGraph) GetMessageType() api.MessageType

func (*GetNodeGraph) Marshal 

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

func (*GetNodeGraph) Reset 

func (m *GetNodeGraph) Reset()

func (*GetNodeGraph) Size 

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

func (*GetNodeGraph) Unmarshal 

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

type GetNodeGraphReply 

type GetNodeGraphReply struct {
	Retval       int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	ReplyInShmem uint64 `binapi:"u64,name=reply_in_shmem" json:"reply_in_shmem,omitempty"`
}

get_node_graph_reply

  • retval - return code
  • reply_in_shmem - result from vlib_node_serialize, in shared memory. Process with vlib_node_unserialize, remember to switch heaps and free the result.

GetNodeGraphReply defines message 'get_node_graph_reply'.

func (*GetNodeGraphReply) GetCrcString 

func (*GetNodeGraphReply) GetCrcString() string

func (*GetNodeGraphReply) GetMessageName 

func (*GetNodeGraphReply) GetMessageName() string

func (*GetNodeGraphReply) GetMessageType 

func (*GetNodeGraphReply) GetMessageType() api.MessageType

func (*GetNodeGraphReply) Marshal 

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

func (*GetNodeGraphReply) Reset 

func (m *GetNodeGraphReply) Reset()

func (*GetNodeGraphReply) Size 

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

func (*GetNodeGraphReply) Unmarshal 

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

type GetNodeIndex 

type GetNodeIndex struct {
	NodeName string `binapi:"string[64],name=node_name" json:"node_name,omitempty"`
}

Get node index using name request

  • node_name[] - name of the node

GetNodeIndex defines message 'get_node_index'.

func (*GetNodeIndex) GetCrcString 

func (*GetNodeIndex) GetCrcString() string

func (*GetNodeIndex) GetMessageName 

func (*GetNodeIndex) GetMessageName() string

func (*GetNodeIndex) GetMessageType 

func (*GetNodeIndex) GetMessageType() api.MessageType

func (*GetNodeIndex) Marshal 

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

func (*GetNodeIndex) Reset 

func (m *GetNodeIndex) Reset()

func (*GetNodeIndex) Size 

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

func (*GetNodeIndex) Unmarshal 

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

type GetNodeIndexReply 

type GetNodeIndexReply struct {
	Retval    int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	NodeIndex uint32 `binapi:"u32,name=node_index" json:"node_index,omitempty"`
}

Get node index using name request

  • retval - return code for the request
  • node_index - index of the desired node if found, else ~0

GetNodeIndexReply defines message 'get_node_index_reply'.

func (*GetNodeIndexReply) GetCrcString 

func (*GetNodeIndexReply) GetCrcString() string

func (*GetNodeIndexReply) GetMessageName 

func (*GetNodeIndexReply) GetMessageName() string

func (*GetNodeIndexReply) GetMessageType 

func (*GetNodeIndexReply) GetMessageType() api.MessageType

func (*GetNodeIndexReply) Marshal 

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

func (*GetNodeIndexReply) Reset 

func (m *GetNodeIndexReply) Reset()

func (*GetNodeIndexReply) Size 

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

func (*GetNodeIndexReply) Unmarshal 

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

type RPCService 

type RPCService interface {
	AddNodeNext(ctx context.Context, in *AddNodeNext) (*AddNodeNextReply, error)
	Cli(ctx context.Context, in *Cli) (*CliReply, error)
	CliInband(ctx context.Context, in *CliInband) (*CliInbandReply, error)
	GetF64EndianValue(ctx context.Context, in *GetF64EndianValue) (*GetF64EndianValueReply, error)
	GetF64IncrementByOne(ctx context.Context, in *GetF64IncrementByOne) (*GetF64IncrementByOneReply, error)
	GetNextIndex(ctx context.Context, in *GetNextIndex) (*GetNextIndexReply, error)
	GetNodeGraph(ctx context.Context, in *GetNodeGraph) (*GetNodeGraphReply, error)
	GetNodeIndex(ctx context.Context, in *GetNodeIndex) (*GetNodeIndexReply, error)
	ShowThreads(ctx context.Context, in *ShowThreads) (*ShowThreadsReply, error)
}

RPCService defines RPC service vlib.

func NewServiceClient 

func NewServiceClient(conn api.Connection) RPCService

type ShowThreads 

type ShowThreads struct{}

show_threads display the information about vpp 

threads running on system along with their process id,
cpu id, physical core and cpu socket.

ShowThreads defines message 'show_threads'.

func (*ShowThreads) GetCrcString 

func (*ShowThreads) GetCrcString() string

func (*ShowThreads) GetMessageName 

func (*ShowThreads) GetMessageName() string

func (*ShowThreads) GetMessageType 

func (*ShowThreads) GetMessageType() api.MessageType

func (*ShowThreads) Marshal 

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

func (*ShowThreads) Reset 

func (m *ShowThreads) Reset()

func (*ShowThreads) Size 

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

func (*ShowThreads) Unmarshal 

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

type ShowThreadsReply 

type ShowThreadsReply struct {
	Retval     int32        `binapi:"i32,name=retval" json:"retval,omitempty"`
	Count      uint32       `binapi:"u32,name=count" json:"-"`
	ThreadData []ThreadData `binapi:"thread_data[count],name=thread_data" json:"thread_data,omitempty"`
}

show_threads_reply

  • retval - return code
  • count - number of threads in thread_data array
  • thread_data - array of thread data

ShowThreadsReply defines message 'show_threads_reply'.

func (*ShowThreadsReply) GetCrcString 

func (*ShowThreadsReply) GetCrcString() string

func (*ShowThreadsReply) GetMessageName 

func (*ShowThreadsReply) GetMessageName() string

func (*ShowThreadsReply) GetMessageType 

func (*ShowThreadsReply) GetMessageType() api.MessageType

func (*ShowThreadsReply) Marshal 

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

func (*ShowThreadsReply) Reset 

func (m *ShowThreadsReply) Reset()

func (*ShowThreadsReply) Size 

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

func (*ShowThreadsReply) Unmarshal 

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

type ThreadData 

type ThreadData struct {
	ID        uint32 `binapi:"u32,name=id" json:"id,omitempty"`
	Name      string `binapi:"string[64],name=name" json:"name,omitempty"`
	Type      string `binapi:"string[64],name=type" json:"type,omitempty"`
	PID       uint32 `binapi:"u32,name=pid" json:"pid,omitempty"`
	CPUID     uint32 `binapi:"u32,name=cpu_id" json:"cpu_id,omitempty"`
	Core      uint32 `binapi:"u32,name=core" json:"core,omitempty"`
	CPUSocket uint32 `binapi:"u32,name=cpu_socket" json:"cpu_socket,omitempty"`
}

ThreadData defines type 'thread_data'.

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.