mactime

package
v0.0.0-...-e98bd18 Latest Latest
Warning

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

 Go to latest Published: Feb 7, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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

Contents: - 2 structs - 7 messages

Index

Constants

View Source 
const (
	APIFile    = "mactime"
	APIVersion = "2.0.0"
	VersionCrc = 0xc72e296e
)

Variables

This section is empty.

Functions

func AllMessages 

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type MactimeAddDelRange 

type MactimeAddDelRange struct {
	IsAdd      bool                      `binapi:"bool,name=is_add" json:"is_add,omitempty"`
	Drop       bool                      `binapi:"bool,name=drop" json:"drop,omitempty"`
	Allow      bool                      `binapi:"bool,name=allow" json:"allow,omitempty"`
	AllowQuota uint8                     `binapi:"u8,name=allow_quota" json:"allow_quota,omitempty"`
	NoUDP10001 bool                      `binapi:"bool,name=no_udp_10001" json:"no_udp_10001,omitempty"`
	DataQuota  uint64                    `binapi:"u64,name=data_quota" json:"data_quota,omitempty"`
	MacAddress ethernet_types.MacAddress `binapi:"mac_address,name=mac_address" json:"mac_address,omitempty"`
	DeviceName string                    `binapi:"string[64],name=device_name" json:"device_name,omitempty"`
	Count      uint32                    `binapi:"u32,name=count" json:"-"`
	Ranges     []TimeRange               `binapi:"time_range[count],name=ranges" json:"ranges,omitempty"`
}

@brief configure per src-mac time ranges 

*
* Usage:
*  to create a static allow entry:
*   set mac_address, device_name, is_add=1, and allow=1.
*
*  to create a static drop entry:
*   set mac_address, device_name, is_add=1, and drop=1.
*
*  to create a (time-range-based) dynamic allow entry:
*   set mac_address, device_name, is_add=1, set allow=1.
*   set count = number of ranges
*   set each range start/end in seconds since Sunday began
*   As in: start/end >= 0.0 && start/end < 7.0 *86400.0
*
*  to create a (time-range-based) dynamic allow entry with quota:
*   Outside of stated time ranges, such entries revert to allow with no quota.
*   previous setup, s/allow=1/allow_quota=1/
*
*  to create a (time-range-based) dynamic drop entry:
*   Same procedure to create a dynamic allow entry,
*   set drop=1 instead of allow=1
*
*  to delete a per src-mac entry (of any kind)
*   set mac_address, is_add=0
*   note: deletes all ranges.
*
* See mactime_test.c:api_mactime_add_del_range(...) for
* a working example.

MactimeAddDelRange defines message 'mactime_add_del_range'.

func (*MactimeAddDelRange) GetCrcString 

func (*MactimeAddDelRange) GetCrcString() string

func (*MactimeAddDelRange) GetMessageName 

func (*MactimeAddDelRange) GetMessageName() string

func (*MactimeAddDelRange) GetMessageType 

func (*MactimeAddDelRange) GetMessageType() api.MessageType

func (*MactimeAddDelRange) Marshal 

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

func (*MactimeAddDelRange) Reset 

func (m *MactimeAddDelRange) Reset()

func (*MactimeAddDelRange) Size 

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

func (*MactimeAddDelRange) Unmarshal 

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

type MactimeAddDelRangeReply 

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

MactimeAddDelRangeReply defines message 'mactime_add_del_range_reply'.

func (*MactimeAddDelRangeReply) GetCrcString 

func (*MactimeAddDelRangeReply) GetCrcString() string

func (*MactimeAddDelRangeReply) GetMessageName 

func (*MactimeAddDelRangeReply) GetMessageName() string

func (*MactimeAddDelRangeReply) GetMessageType 

func (*MactimeAddDelRangeReply) GetMessageType() api.MessageType

func (*MactimeAddDelRangeReply) Marshal 

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

func (*MactimeAddDelRangeReply) Reset 

func (m *MactimeAddDelRangeReply) Reset()

func (*MactimeAddDelRangeReply) Size 

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

func (*MactimeAddDelRangeReply) Unmarshal 

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

type MactimeDetails 

type MactimeDetails struct {
	PoolIndex       uint32                    `binapi:"u32,name=pool_index" json:"pool_index,omitempty"`
	MacAddress      ethernet_types.MacAddress `binapi:"mac_address,name=mac_address" json:"mac_address,omitempty"`
	DataQuota       uint64                    `binapi:"u64,name=data_quota" json:"data_quota,omitempty"`
	DataUsedInRange uint64                    `binapi:"u64,name=data_used_in_range" json:"data_used_in_range,omitempty"`
	Flags           uint32                    `binapi:"u32,name=flags" json:"flags,omitempty"`
	DeviceName      string                    `binapi:"string[64],name=device_name" json:"device_name,omitempty"`
	Nranges         uint32                    `binapi:"u32,name=nranges" json:"-"`
	Ranges          []MactimeTimeRange        `binapi:"mactime_time_range[nranges],name=ranges" json:"ranges,omitempty"`
}

@brief mactime table entry details MactimeDetails defines message 'mactime_details'.

func (*MactimeDetails) GetCrcString 

func (*MactimeDetails) GetCrcString() string

func (*MactimeDetails) GetMessageName 

func (*MactimeDetails) GetMessageName() string

func (*MactimeDetails) GetMessageType 

func (*MactimeDetails) GetMessageType() api.MessageType

func (*MactimeDetails) Marshal 

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

func (*MactimeDetails) Reset 

func (m *MactimeDetails) Reset()

func (*MactimeDetails) Size 

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

func (*MactimeDetails) Unmarshal 

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

type MactimeDump 

type MactimeDump struct {
	MyTableEpoch uint32 `binapi:"u32,name=my_table_epoch" json:"my_table_epoch,omitempty"`
}

@brief dump mactime table 

*
* Request a mactime client pool dump
* Sequence:
* client send vl_api_mactime_dump to vpp
* vpp replies with zero or more vl_api_mactime_entry_t's
* vpp replies with a vl_api_mactime_dump_reply_t
* - my_table_epoch dump table only if update needed, 0 => full dump

MactimeDump defines message 'mactime_dump'.

func (*MactimeDump) GetCrcString 

func (*MactimeDump) GetCrcString() string

func (*MactimeDump) GetMessageName 

func (*MactimeDump) GetMessageName() string

func (*MactimeDump) GetMessageType 

func (*MactimeDump) GetMessageType() api.MessageType

func (*MactimeDump) Marshal 

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

func (*MactimeDump) Reset 

func (m *MactimeDump) Reset()

func (*MactimeDump) Size 

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

func (*MactimeDump) Unmarshal 

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

type MactimeDumpReply 

type MactimeDumpReply struct {
	Retval     int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	TableEpoch uint32 `binapi:"u32,name=table_epoch" json:"table_epoch,omitempty"`
}

@brief dump mactime table reply

  • Includes the vpp table epoch, needed to optimize API traffic

MactimeDumpReply defines message 'mactime_dump_reply'.

func (*MactimeDumpReply) GetCrcString 

func (*MactimeDumpReply) GetCrcString() string

func (*MactimeDumpReply) GetMessageName 

func (*MactimeDumpReply) GetMessageName() string

func (*MactimeDumpReply) GetMessageType 

func (*MactimeDumpReply) GetMessageType() api.MessageType

func (*MactimeDumpReply) Marshal 

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

func (*MactimeDumpReply) Reset 

func (m *MactimeDumpReply) Reset()

func (*MactimeDumpReply) Size 

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

func (*MactimeDumpReply) Unmarshal 

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

type MactimeEnableDisable 

type MactimeEnableDisable struct {
	EnableDisable bool                           `binapi:"bool,name=enable_disable" json:"enable_disable,omitempty"`
	SwIfIndex     interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

@brief api to enable or disable the time-based src mac filter on 

an interface

MactimeEnableDisable defines message 'mactime_enable_disable'.

func (*MactimeEnableDisable) GetCrcString 

func (*MactimeEnableDisable) GetCrcString() string

func (*MactimeEnableDisable) GetMessageName 

func (*MactimeEnableDisable) GetMessageName() string

func (*MactimeEnableDisable) GetMessageType 

func (*MactimeEnableDisable) GetMessageType() api.MessageType

func (*MactimeEnableDisable) Marshal 

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

func (*MactimeEnableDisable) Reset 

func (m *MactimeEnableDisable) Reset()

func (*MactimeEnableDisable) Size 

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

func (*MactimeEnableDisable) Unmarshal 

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

type MactimeEnableDisableReply 

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

MactimeEnableDisableReply defines message 'mactime_enable_disable_reply'.

func (*MactimeEnableDisableReply) GetCrcString 

func (*MactimeEnableDisableReply) GetCrcString() string

func (*MactimeEnableDisableReply) GetMessageName 

func (*MactimeEnableDisableReply) GetMessageName() string

func (*MactimeEnableDisableReply) GetMessageType 

func (*MactimeEnableDisableReply) GetMessageType() api.MessageType

func (*MactimeEnableDisableReply) Marshal 

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

func (*MactimeEnableDisableReply) Reset 

func (m *MactimeEnableDisableReply) Reset()

func (*MactimeEnableDisableReply) Size 

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

func (*MactimeEnableDisableReply) Unmarshal 

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

type MactimeTimeRange 

type MactimeTimeRange struct {
	Start float64 `binapi:"f64,name=start" json:"start,omitempty"`
	End   float64 `binapi:"f64,name=end" json:"end,omitempty"`
}

MactimeTimeRange defines type 'mactime_time_range'.

type RPCService 

type RPCService interface {
	MactimeAddDelRange(ctx context.Context, in *MactimeAddDelRange) (*MactimeAddDelRangeReply, error)
	MactimeDump(ctx context.Context, in *MactimeDump) (RPCService_MactimeDumpClient, error)
	MactimeEnableDisable(ctx context.Context, in *MactimeEnableDisable) (*MactimeEnableDisableReply, error)
}

RPCService defines RPC service mactime.

func NewServiceClient 

func NewServiceClient(conn api.Connection) RPCService

type RPCService_MactimeDumpClient 

type RPCService_MactimeDumpClient interface {
	Recv() (*MactimeDetails, error)
	api.Stream
}

type TimeRange 

type TimeRange struct {
	Start float64 `binapi:"f64,name=start" json:"start,omitempty"`
	End   float64 `binapi:"f64,name=end" json:"end,omitempty"`
}

TimeRange defines type 'time_range'.

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.
JackTT - Gopher 🇻🇳