qos

package
v0.11.0 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

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

Contents: - 1 enum - 5 structs - 19 messages

Index

Constants

View Source
const (
	APIFile    = "qos"
	APIVersion = "1.1.1"
	VersionCrc = 0x7b7b5955
)

Variables

View Source
var (
	QosSource_name = map[uint8]string{
		0: "QOS_API_SOURCE_EXT",
		1: "QOS_API_SOURCE_VLAN",
		2: "QOS_API_SOURCE_MPLS",
		3: "QOS_API_SOURCE_IP",
	}
	QosSource_value = map[string]uint8{
		"QOS_API_SOURCE_EXT":  0,
		"QOS_API_SOURCE_VLAN": 1,
		"QOS_API_SOURCE_MPLS": 2,
		"QOS_API_SOURCE_IP":   3,
	}
)

Functions

func AllMessages

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type QosEgressMap

type QosEgressMap struct {
	ID   uint32             `binapi:"u32,name=id" json:"id,omitempty"`
	Rows [4]QosEgressMapRow `binapi:"qos_egress_map_row[4],name=rows" json:"rows,omitempty"`
}

QosEgressMap defines type 'qos_egress_map'.

type QosEgressMapDelete

type QosEgressMapDelete struct {
	ID uint32 `binapi:"u32,name=id" json:"id,omitempty"`
}

* @brief Delete a Qos Map

  • - map_id - ID of the map to delete

QosEgressMapDelete defines message 'qos_egress_map_delete'.

func (*QosEgressMapDelete) GetCrcString

func (*QosEgressMapDelete) GetCrcString() string

func (*QosEgressMapDelete) GetMessageName

func (*QosEgressMapDelete) GetMessageName() string

func (*QosEgressMapDelete) GetMessageType

func (*QosEgressMapDelete) GetMessageType() api.MessageType

func (*QosEgressMapDelete) Marshal

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

func (*QosEgressMapDelete) Reset

func (m *QosEgressMapDelete) Reset()

func (*QosEgressMapDelete) Size

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

func (*QosEgressMapDelete) Unmarshal

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

type QosEgressMapDeleteReply

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

QosEgressMapDeleteReply defines message 'qos_egress_map_delete_reply'.

func (*QosEgressMapDeleteReply) GetCrcString

func (*QosEgressMapDeleteReply) GetCrcString() string

func (*QosEgressMapDeleteReply) GetMessageName

func (*QosEgressMapDeleteReply) GetMessageName() string

func (*QosEgressMapDeleteReply) GetMessageType

func (*QosEgressMapDeleteReply) GetMessageType() api.MessageType

func (*QosEgressMapDeleteReply) Marshal

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

func (*QosEgressMapDeleteReply) Reset

func (m *QosEgressMapDeleteReply) Reset()

func (*QosEgressMapDeleteReply) Size

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

func (*QosEgressMapDeleteReply) Unmarshal

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

type QosEgressMapDetails

type QosEgressMapDetails struct {
	Map QosEgressMap `binapi:"qos_egress_map,name=map" json:"map,omitempty"`
}

* QoS map details QosEgressMapDetails defines message 'qos_egress_map_details'.

func (*QosEgressMapDetails) GetCrcString

func (*QosEgressMapDetails) GetCrcString() string

func (*QosEgressMapDetails) GetMessageName

func (*QosEgressMapDetails) GetMessageName() string

func (*QosEgressMapDetails) GetMessageType

func (*QosEgressMapDetails) GetMessageType() api.MessageType

func (*QosEgressMapDetails) Marshal

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

func (*QosEgressMapDetails) Reset

func (m *QosEgressMapDetails) Reset()

func (*QosEgressMapDetails) Size

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

func (*QosEgressMapDetails) Unmarshal

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

type QosEgressMapDump

type QosEgressMapDump struct{}

* Dump the QoS egress maps QosEgressMapDump defines message 'qos_egress_map_dump'.

func (*QosEgressMapDump) GetCrcString

func (*QosEgressMapDump) GetCrcString() string

func (*QosEgressMapDump) GetMessageName

func (*QosEgressMapDump) GetMessageName() string

func (*QosEgressMapDump) GetMessageType

func (*QosEgressMapDump) GetMessageType() api.MessageType

func (*QosEgressMapDump) Marshal

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

func (*QosEgressMapDump) Reset

func (m *QosEgressMapDump) Reset()

func (*QosEgressMapDump) Size

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

func (*QosEgressMapDump) Unmarshal

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

type QosEgressMapRow

type QosEgressMapRow struct {
	Outputs []byte `binapi:"u8[256],name=outputs" json:"outputs,omitempty"`
}

QosEgressMapRow defines type 'qos_egress_map_row'.

type QosEgressMapUpdate

type QosEgressMapUpdate struct {
	Map QosEgressMap `binapi:"qos_egress_map,name=map" json:"map,omitempty"`
}

* @brief Update a QoS Map

  • A QoS map, translates from the QoS value in the packet set by the 'record'
  • feature, to the value used for output in the 'mark' feature.
  • There is one row in the map for each input/record source.
  • The MAP is then applied to the egress interface at for a given output source
  • - map - The Map

QosEgressMapUpdate defines message 'qos_egress_map_update'.

func (*QosEgressMapUpdate) GetCrcString

func (*QosEgressMapUpdate) GetCrcString() string

func (*QosEgressMapUpdate) GetMessageName

func (*QosEgressMapUpdate) GetMessageName() string

func (*QosEgressMapUpdate) GetMessageType

func (*QosEgressMapUpdate) GetMessageType() api.MessageType

func (*QosEgressMapUpdate) Marshal

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

func (*QosEgressMapUpdate) Reset

func (m *QosEgressMapUpdate) Reset()

func (*QosEgressMapUpdate) Size

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

func (*QosEgressMapUpdate) Unmarshal

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

type QosEgressMapUpdateReply

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

QosEgressMapUpdateReply defines message 'qos_egress_map_update_reply'.

func (*QosEgressMapUpdateReply) GetCrcString

func (*QosEgressMapUpdateReply) GetCrcString() string

func (*QosEgressMapUpdateReply) GetMessageName

func (*QosEgressMapUpdateReply) GetMessageName() string

func (*QosEgressMapUpdateReply) GetMessageType

func (*QosEgressMapUpdateReply) GetMessageType() api.MessageType

func (*QosEgressMapUpdateReply) Marshal

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

func (*QosEgressMapUpdateReply) Reset

func (m *QosEgressMapUpdateReply) Reset()

func (*QosEgressMapUpdateReply) Size

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

func (*QosEgressMapUpdateReply) Unmarshal

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

type QosMark

type QosMark struct {
	SwIfIndex    uint32    `binapi:"u32,name=sw_if_index" json:"sw_if_index,omitempty"`
	MapID        uint32    `binapi:"u32,name=map_id" json:"map_id,omitempty"`
	OutputSource QosSource `binapi:"qos_source,name=output_source" json:"output_source,omitempty"`
}

QosMark defines type 'qos_mark'.

type QosMarkDetails

type QosMarkDetails struct {
	Mark QosMark `binapi:"qos_mark,name=mark" json:"mark,omitempty"`
}

* QoS marking details QosMarkDetails defines message 'qos_mark_details'.

func (*QosMarkDetails) GetCrcString

func (*QosMarkDetails) GetCrcString() string

func (*QosMarkDetails) GetMessageName

func (*QosMarkDetails) GetMessageName() string

func (*QosMarkDetails) GetMessageType

func (*QosMarkDetails) GetMessageType() api.MessageType

func (*QosMarkDetails) Marshal

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

func (*QosMarkDetails) Reset

func (m *QosMarkDetails) Reset()

func (*QosMarkDetails) Size

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

func (*QosMarkDetails) Unmarshal

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

type QosMarkDetailsReply

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

QosMarkDetailsReply defines message 'qos_mark_details_reply'.

func (*QosMarkDetailsReply) GetCrcString

func (*QosMarkDetailsReply) GetCrcString() string

func (*QosMarkDetailsReply) GetMessageName

func (*QosMarkDetailsReply) GetMessageName() string

func (*QosMarkDetailsReply) GetMessageType

func (*QosMarkDetailsReply) GetMessageType() api.MessageType

func (*QosMarkDetailsReply) Marshal

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

func (*QosMarkDetailsReply) Reset

func (m *QosMarkDetailsReply) Reset()

func (*QosMarkDetailsReply) Size

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

func (*QosMarkDetailsReply) Unmarshal

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

type QosMarkDump

type QosMarkDump struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

* Dump QoS marking configs QosMarkDump defines message 'qos_mark_dump'.

func (*QosMarkDump) GetCrcString

func (*QosMarkDump) GetCrcString() string

func (*QosMarkDump) GetMessageName

func (*QosMarkDump) GetMessageName() string

func (*QosMarkDump) GetMessageType

func (*QosMarkDump) GetMessageType() api.MessageType

func (*QosMarkDump) Marshal

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

func (*QosMarkDump) Reset

func (m *QosMarkDump) Reset()

func (*QosMarkDump) Size

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

func (*QosMarkDump) Unmarshal

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

type QosMarkEnableDisable

type QosMarkEnableDisable struct {
	Enable bool    `binapi:"bool,name=enable,default=true" json:"enable,omitempty"`
	Mark   QosMark `binapi:"qos_mark,name=mark" json:"mark,omitempty"`
}

* @brief Enable/Disable QoS marking

  • - enable - enable=1 or disable the feature
  • - mark - Marking config

QosMarkEnableDisable defines message 'qos_mark_enable_disable'.

func (*QosMarkEnableDisable) GetCrcString

func (*QosMarkEnableDisable) GetCrcString() string

func (*QosMarkEnableDisable) GetMessageName

func (*QosMarkEnableDisable) GetMessageName() string

func (*QosMarkEnableDisable) GetMessageType

func (*QosMarkEnableDisable) GetMessageType() api.MessageType

func (*QosMarkEnableDisable) Marshal

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

func (*QosMarkEnableDisable) Reset

func (m *QosMarkEnableDisable) Reset()

func (*QosMarkEnableDisable) Size

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

func (*QosMarkEnableDisable) Unmarshal

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

type QosMarkEnableDisableReply

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

QosMarkEnableDisableReply defines message 'qos_mark_enable_disable_reply'.

func (*QosMarkEnableDisableReply) GetCrcString

func (*QosMarkEnableDisableReply) GetCrcString() string

func (*QosMarkEnableDisableReply) GetMessageName

func (*QosMarkEnableDisableReply) GetMessageName() string

func (*QosMarkEnableDisableReply) GetMessageType

func (*QosMarkEnableDisableReply) GetMessageType() api.MessageType

func (*QosMarkEnableDisableReply) Marshal

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

func (*QosMarkEnableDisableReply) Reset

func (m *QosMarkEnableDisableReply) Reset()

func (*QosMarkEnableDisableReply) Size

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

func (*QosMarkEnableDisableReply) Unmarshal

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

type QosRecord

type QosRecord struct {
	SwIfIndex   interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	InputSource QosSource                      `binapi:"qos_source,name=input_source" json:"input_source,omitempty"`
}

QosRecord defines type 'qos_record'.

type QosRecordDetails

type QosRecordDetails struct {
	Record QosRecord `binapi:"qos_record,name=record" json:"record,omitempty"`
}

* Details of QoS recording configs QosRecordDetails defines message 'qos_record_details'.

func (*QosRecordDetails) GetCrcString

func (*QosRecordDetails) GetCrcString() string

func (*QosRecordDetails) GetMessageName

func (*QosRecordDetails) GetMessageName() string

func (*QosRecordDetails) GetMessageType

func (*QosRecordDetails) GetMessageType() api.MessageType

func (*QosRecordDetails) Marshal

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

func (*QosRecordDetails) Reset

func (m *QosRecordDetails) Reset()

func (*QosRecordDetails) Size

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

func (*QosRecordDetails) Unmarshal

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

type QosRecordDump

type QosRecordDump struct{}

* Dump the QoS record configs QosRecordDump defines message 'qos_record_dump'.

func (*QosRecordDump) GetCrcString

func (*QosRecordDump) GetCrcString() string

func (*QosRecordDump) GetMessageName

func (*QosRecordDump) GetMessageName() string

func (*QosRecordDump) GetMessageType

func (*QosRecordDump) GetMessageType() api.MessageType

func (*QosRecordDump) Marshal

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

func (*QosRecordDump) Reset

func (m *QosRecordDump) Reset()

func (*QosRecordDump) Size

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

func (*QosRecordDump) Unmarshal

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

type QosRecordEnableDisable

type QosRecordEnableDisable struct {
	Enable bool      `binapi:"bool,name=enable,default=true" json:"enable,omitempty"`
	Record QosRecord `binapi:"qos_record,name=record" json:"record,omitempty"`
}

* Enable/Disable QoS recording

  • The QoS bits from the packet at the specified input layer are copied
  • into the packet. Recording should be used in conjunction with marking
  • - enable - enable=1 or disable the feature
  • - record - Recording configuration

QosRecordEnableDisable defines message 'qos_record_enable_disable'.

func (*QosRecordEnableDisable) GetCrcString

func (*QosRecordEnableDisable) GetCrcString() string

func (*QosRecordEnableDisable) GetMessageName

func (*QosRecordEnableDisable) GetMessageName() string

func (*QosRecordEnableDisable) GetMessageType

func (*QosRecordEnableDisable) GetMessageType() api.MessageType

func (*QosRecordEnableDisable) Marshal

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

func (*QosRecordEnableDisable) Reset

func (m *QosRecordEnableDisable) Reset()

func (*QosRecordEnableDisable) Size

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

func (*QosRecordEnableDisable) Unmarshal

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

type QosRecordEnableDisableReply

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

QosRecordEnableDisableReply defines message 'qos_record_enable_disable_reply'.

func (*QosRecordEnableDisableReply) GetCrcString

func (*QosRecordEnableDisableReply) GetCrcString() string

func (*QosRecordEnableDisableReply) GetMessageName

func (*QosRecordEnableDisableReply) GetMessageName() string

func (*QosRecordEnableDisableReply) GetMessageType

func (*QosRecordEnableDisableReply) GetMessageType() api.MessageType

func (*QosRecordEnableDisableReply) Marshal

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

func (*QosRecordEnableDisableReply) Reset

func (m *QosRecordEnableDisableReply) Reset()

func (*QosRecordEnableDisableReply) Size

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

func (*QosRecordEnableDisableReply) Unmarshal

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

type QosSource

type QosSource uint8

QosSource defines enum 'qos_source'.

const (
	QOS_API_SOURCE_EXT  QosSource = 0
	QOS_API_SOURCE_VLAN QosSource = 1
	QOS_API_SOURCE_MPLS QosSource = 2
	QOS_API_SOURCE_IP   QosSource = 3
)

func (QosSource) String

func (x QosSource) String() string

type QosStore

type QosStore struct {
	SwIfIndex   interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	InputSource QosSource                      `binapi:"qos_source,name=input_source" json:"input_source,omitempty"`
	Value       uint8                          `binapi:"u8,name=value" json:"value,omitempty"`
}

QosStore defines type 'qos_store'.

type QosStoreDetails

type QosStoreDetails struct {
	Store QosStore `binapi:"qos_store,name=store" json:"store,omitempty"`
}

* Details of QoS recording configs QosStoreDetails defines message 'qos_store_details'.

func (*QosStoreDetails) GetCrcString

func (*QosStoreDetails) GetCrcString() string

func (*QosStoreDetails) GetMessageName

func (*QosStoreDetails) GetMessageName() string

func (*QosStoreDetails) GetMessageType

func (*QosStoreDetails) GetMessageType() api.MessageType

func (*QosStoreDetails) Marshal

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

func (*QosStoreDetails) Reset

func (m *QosStoreDetails) Reset()

func (*QosStoreDetails) Size

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

func (*QosStoreDetails) Unmarshal

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

type QosStoreDump

type QosStoreDump struct{}

* Dump the QoS store configs QosStoreDump defines message 'qos_store_dump'.

func (*QosStoreDump) GetCrcString

func (*QosStoreDump) GetCrcString() string

func (*QosStoreDump) GetMessageName

func (*QosStoreDump) GetMessageName() string

func (*QosStoreDump) GetMessageType

func (*QosStoreDump) GetMessageType() api.MessageType

func (*QosStoreDump) Marshal

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

func (*QosStoreDump) Reset

func (m *QosStoreDump) Reset()

func (*QosStoreDump) Size

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

func (*QosStoreDump) Unmarshal

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

type QosStoreEnableDisable

type QosStoreEnableDisable struct {
	Enable bool     `binapi:"bool,name=enable,default=true" json:"enable,omitempty"`
	Store  QosStore `binapi:"qos_store,name=store" json:"store,omitempty"`
}

* Enable/Disable QoS storing

  • The QoS bits from the packet at the specified input layer are copied
  • into the packet. Storing should be used in conjunction with marking
  • - enable - enable=1 or disable the feature
  • - store - Store configuration

QosStoreEnableDisable defines message 'qos_store_enable_disable'.

func (*QosStoreEnableDisable) GetCrcString

func (*QosStoreEnableDisable) GetCrcString() string

func (*QosStoreEnableDisable) GetMessageName

func (*QosStoreEnableDisable) GetMessageName() string

func (*QosStoreEnableDisable) GetMessageType

func (*QosStoreEnableDisable) GetMessageType() api.MessageType

func (*QosStoreEnableDisable) Marshal

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

func (*QosStoreEnableDisable) Reset

func (m *QosStoreEnableDisable) Reset()

func (*QosStoreEnableDisable) Size

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

func (*QosStoreEnableDisable) Unmarshal

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

type QosStoreEnableDisableReply

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

QosStoreEnableDisableReply defines message 'qos_store_enable_disable_reply'.

func (*QosStoreEnableDisableReply) GetCrcString

func (*QosStoreEnableDisableReply) GetCrcString() string

func (*QosStoreEnableDisableReply) GetMessageName

func (*QosStoreEnableDisableReply) GetMessageName() string

func (*QosStoreEnableDisableReply) GetMessageType

func (*QosStoreEnableDisableReply) GetMessageType() api.MessageType

func (*QosStoreEnableDisableReply) Marshal

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

func (*QosStoreEnableDisableReply) Reset

func (m *QosStoreEnableDisableReply) Reset()

func (*QosStoreEnableDisableReply) Size

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

func (*QosStoreEnableDisableReply) Unmarshal

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

type RPCService

RPCService defines RPC service qos.

func NewServiceClient

func NewServiceClient(conn api.Connection) RPCService

type RPCService_QosEgressMapDumpClient

type RPCService_QosEgressMapDumpClient interface {
	Recv() (*QosEgressMapDetails, error)
	api.Stream
}

type RPCService_QosMarkDumpClient

type RPCService_QosMarkDumpClient interface {
	Recv() (*QosMarkDetails, error)
	api.Stream
}

type RPCService_QosRecordDumpClient

type RPCService_QosRecordDumpClient interface {
	Recv() (*QosRecordDetails, error)
	api.Stream
}

type RPCService_QosStoreDumpClient

type RPCService_QosStoreDumpClient interface {
	Recv() (*QosStoreDetails, error)
	api.Stream
}

Jump to

Keyboard shortcuts

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