span

package
v0.0.0-...-140e075 Latest Latest
Warning

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

Go to latest
Published: Aug 6, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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

Contents: - 1 enum - 4 messages

Index

Constants

View Source
const (
	APIFile    = "span"
	APIVersion = "2.0.0"
	VersionCrc = 0x34ee02b
)

Variables

View Source
var (
	SpanState_name = map[uint32]string{
		0: "SPAN_STATE_API_DISABLED",
		1: "SPAN_STATE_API_RX",
		2: "SPAN_STATE_API_TX",
		3: "SPAN_STATE_API_RX_TX",
	}
	SpanState_value = map[string]uint32{
		"SPAN_STATE_API_DISABLED": 0,
		"SPAN_STATE_API_RX":       1,
		"SPAN_STATE_API_TX":       2,
		"SPAN_STATE_API_RX_TX":    3,
	}
)

Functions

func AllMessages

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type RPCService

type RPCService interface {
	SwInterfaceSpanDump(ctx context.Context, in *SwInterfaceSpanDump) (RPCService_SwInterfaceSpanDumpClient, error)
	SwInterfaceSpanEnableDisable(ctx context.Context, in *SwInterfaceSpanEnableDisable) (*SwInterfaceSpanEnableDisableReply, error)
}

RPCService defines RPC service span.

func NewServiceClient

func NewServiceClient(conn api.Connection) RPCService

type RPCService_SwInterfaceSpanDumpClient

type RPCService_SwInterfaceSpanDumpClient interface {
	Recv() (*SwInterfaceSpanDetails, error)
	api.Stream
}

type SpanState

type SpanState uint32

SpanState defines enum 'span_state'.

const (
	SPAN_STATE_API_DISABLED SpanState = 0
	SPAN_STATE_API_RX       SpanState = 1
	SPAN_STATE_API_TX       SpanState = 2
	SPAN_STATE_API_RX_TX    SpanState = 3
)

func (SpanState) String

func (x SpanState) String() string

type SwInterfaceSpanDetails

type SwInterfaceSpanDetails struct {
	SwIfIndexFrom interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index_from" json:"sw_if_index_from,omitempty"`
	SwIfIndexTo   interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index_to" json:"sw_if_index_to,omitempty"`
	State         SpanState                      `binapi:"span_state,name=state" json:"state,omitempty"`
	IsL2          bool                           `binapi:"bool,name=is_l2" json:"is_l2,omitempty"`
}

Reply to SPAN dump request

  • sw_if_index_from - mirrored interface
  • sw_if_index_to - interface where the traffic is mirrored
  • state - 0 = disabled, 1 = rx enabled, 2 = tx enabled, 3 tx & rx enabled
  • is_l2 - 0 = mirrored at hw device level, 1 = mirrored at l2

SwInterfaceSpanDetails defines message 'sw_interface_span_details'.

func (*SwInterfaceSpanDetails) GetCrcString

func (*SwInterfaceSpanDetails) GetCrcString() string

func (*SwInterfaceSpanDetails) GetMessageName

func (*SwInterfaceSpanDetails) GetMessageName() string

func (*SwInterfaceSpanDetails) GetMessageType

func (*SwInterfaceSpanDetails) GetMessageType() api.MessageType

func (*SwInterfaceSpanDetails) Marshal

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

func (*SwInterfaceSpanDetails) Reset

func (m *SwInterfaceSpanDetails) Reset()

func (*SwInterfaceSpanDetails) Size

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

func (*SwInterfaceSpanDetails) Unmarshal

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

type SwInterfaceSpanDump

type SwInterfaceSpanDump struct {
	IsL2 bool `binapi:"bool,name=is_l2" json:"is_l2,omitempty"`
}

SPAN dump request

  • is_l2 - 0 = hw device level, 1 = L2

SwInterfaceSpanDump defines message 'sw_interface_span_dump'.

func (*SwInterfaceSpanDump) GetCrcString

func (*SwInterfaceSpanDump) GetCrcString() string

func (*SwInterfaceSpanDump) GetMessageName

func (*SwInterfaceSpanDump) GetMessageName() string

func (*SwInterfaceSpanDump) GetMessageType

func (*SwInterfaceSpanDump) GetMessageType() api.MessageType

func (*SwInterfaceSpanDump) Marshal

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

func (*SwInterfaceSpanDump) Reset

func (m *SwInterfaceSpanDump) Reset()

func (*SwInterfaceSpanDump) Size

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

func (*SwInterfaceSpanDump) Unmarshal

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

type SwInterfaceSpanEnableDisable

type SwInterfaceSpanEnableDisable struct {
	SwIfIndexFrom interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index_from" json:"sw_if_index_from,omitempty"`
	SwIfIndexTo   interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index_to" json:"sw_if_index_to,omitempty"`
	State         SpanState                      `binapi:"span_state,name=state" json:"state,omitempty"`
	IsL2          bool                           `binapi:"bool,name=is_l2" json:"is_l2,omitempty"`
}

Enable/Disable span to mirror traffic from one interface to another

  • sw_if_index_from - interface to be mirrored
  • sw_if_index_to - interface where the traffic is mirrored
  • state - 0 = disabled, 1 = rx enabled, 2 = tx enabled, 3 tx & rx enabled
  • is_l2 - 0 = mirror at hw device level, 1 = mirror at L2

SwInterfaceSpanEnableDisable defines message 'sw_interface_span_enable_disable'.

func (*SwInterfaceSpanEnableDisable) GetCrcString

func (*SwInterfaceSpanEnableDisable) GetCrcString() string

func (*SwInterfaceSpanEnableDisable) GetMessageName

func (*SwInterfaceSpanEnableDisable) GetMessageName() string

func (*SwInterfaceSpanEnableDisable) GetMessageType

func (*SwInterfaceSpanEnableDisable) GetMessageType() api.MessageType

func (*SwInterfaceSpanEnableDisable) Marshal

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

func (*SwInterfaceSpanEnableDisable) Reset

func (m *SwInterfaceSpanEnableDisable) Reset()

func (*SwInterfaceSpanEnableDisable) Size

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

func (*SwInterfaceSpanEnableDisable) Unmarshal

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

type SwInterfaceSpanEnableDisableReply

type SwInterfaceSpanEnableDisableReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSpanEnableDisableReply defines message 'sw_interface_span_enable_disable_reply'.

func (*SwInterfaceSpanEnableDisableReply) GetCrcString

func (*SwInterfaceSpanEnableDisableReply) GetCrcString() string

func (*SwInterfaceSpanEnableDisableReply) GetMessageName

func (*SwInterfaceSpanEnableDisableReply) GetMessageName() string

func (*SwInterfaceSpanEnableDisableReply) GetMessageType

func (*SwInterfaceSpanEnableDisableReply) Marshal

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

func (*SwInterfaceSpanEnableDisableReply) Reset

func (*SwInterfaceSpanEnableDisableReply) Size

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

func (*SwInterfaceSpanEnableDisableReply) Unmarshal

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL