stn

Documentation

Overview

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

Contents: - 4 messages

Index

• Constants
• func AllMessages() []api.Message
• type RPCService
  • func NewServiceClient(conn api.Connection) RPCService
• type RPCService_StnRulesDumpClient
• type StnAddDelRule
  • func (*StnAddDelRule) GetCrcString() string
  • func (*StnAddDelRule) GetMessageName() string
  • func (*StnAddDelRule) GetMessageType() api.MessageType
  • func (m *StnAddDelRule) Marshal(b []byte) ([]byte, error)
  • func (m *StnAddDelRule) Reset()
  • func (m *StnAddDelRule) Size() (size int)
  • func (m *StnAddDelRule) Unmarshal(b []byte) error
• type StnAddDelRuleReply
  • func (*StnAddDelRuleReply) GetCrcString() string
  • func (*StnAddDelRuleReply) GetMessageName() string
  • func (*StnAddDelRuleReply) GetMessageType() api.MessageType
  • func (m *StnAddDelRuleReply) Marshal(b []byte) ([]byte, error)
  • func (m *StnAddDelRuleReply) Reset()
  • func (m *StnAddDelRuleReply) Size() (size int)
  • func (m *StnAddDelRuleReply) Unmarshal(b []byte) error
• type StnRulesDetails
  • func (*StnRulesDetails) GetCrcString() string
  • func (*StnRulesDetails) GetMessageName() string
  • func (*StnRulesDetails) GetMessageType() api.MessageType
  • func (m *StnRulesDetails) Marshal(b []byte) ([]byte, error)
  • func (m *StnRulesDetails) Reset()
  • func (m *StnRulesDetails) Size() (size int)
  • func (m *StnRulesDetails) Unmarshal(b []byte) error
• type StnRulesDump
  • func (*StnRulesDump) GetCrcString() string
  • func (*StnRulesDump) GetMessageName() string
  • func (*StnRulesDump) GetMessageType() api.MessageType
  • func (m *StnRulesDump) Marshal(b []byte) ([]byte, error)
  • func (m *StnRulesDump) Reset()
  • func (m *StnRulesDump) Size() (size int)
  • func (m *StnRulesDump) Unmarshal(b []byte) error

Constants

const (
	APIFile    = "stn"
	APIVersion = "2.0.0"
	VersionCrc = 0x9cfaef64
)

Functions

func AllMessages

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type RPCService

type RPCService interface {
	StnAddDelRule(ctx context.Context, in *StnAddDelRule) (*StnAddDelRuleReply, error)
	StnRulesDump(ctx context.Context, in *StnRulesDump) (RPCService_StnRulesDumpClient, error)
}

RPCService defines RPC service stn.

func NewServiceClient

func NewServiceClient(conn api.Connection) RPCService

type RPCService_StnRulesDumpClient

type RPCService_StnRulesDumpClient interface {
	Recv() (*StnRulesDetails, error)
	api.Stream
}

type StnAddDelRule

type StnAddDelRule struct {
	IPAddress ip_types.Address               `binapi:"address,name=ip_address" json:"ip_address,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	IsAdd     bool                           `binapi:"bool,name=is_add" json:"is_add,omitempty"`
}

Add/del STN rules

• ip_address - STN rule IP address
• sw_if_index - Interface index
• is_add - 1 if add, 0 if delete

StnAddDelRule defines message 'stn_add_del_rule'.

func (*StnAddDelRule) GetCrcString

func (*StnAddDelRule) GetCrcString() string

func (*StnAddDelRule) GetMessageName

func (*StnAddDelRule) GetMessageName() string

func (*StnAddDelRule) GetMessageType

func (*StnAddDelRule) GetMessageType() api.MessageType

func (*StnAddDelRule) Marshal

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

func (*StnAddDelRule) Reset

func (m *StnAddDelRule) Reset()

func (*StnAddDelRule) Size

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

func (*StnAddDelRule) Unmarshal

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

type StnAddDelRuleReply

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

StnAddDelRuleReply defines message 'stn_add_del_rule_reply'.

func (*StnAddDelRuleReply) GetCrcString

func (*StnAddDelRuleReply) GetCrcString() string

func (*StnAddDelRuleReply) GetMessageName

func (*StnAddDelRuleReply) GetMessageName() string

func (*StnAddDelRuleReply) GetMessageType

func (*StnAddDelRuleReply) GetMessageType() api.MessageType

func (*StnAddDelRuleReply) Marshal

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

func (*StnAddDelRuleReply) Reset

func (m *StnAddDelRuleReply) Reset()

func (*StnAddDelRuleReply) Size

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

func (*StnAddDelRuleReply) Unmarshal

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

type StnRulesDetails

type StnRulesDetails struct {
	IPAddress ip_types.Address               `binapi:"address,name=ip_address" json:"ip_address,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

STN response to rules request

• is_ip4 - 1 if address type is IPv4
• ip_address - IP address
• sw_if_index - Interface index

StnRulesDetails defines message 'stn_rules_details'.

func (*StnRulesDetails) GetCrcString

func (*StnRulesDetails) GetCrcString() string

func (*StnRulesDetails) GetMessageName

func (*StnRulesDetails) GetMessageName() string

func (*StnRulesDetails) GetMessageType

func (*StnRulesDetails) GetMessageType() api.MessageType

func (*StnRulesDetails) Marshal

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

func (*StnRulesDetails) Reset

func (m *StnRulesDetails) Reset()

func (*StnRulesDetails) Size

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

func (*StnRulesDetails) Unmarshal

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

type StnRulesDump

type StnRulesDump struct{}

Dump STN rules StnRulesDump defines message 'stn_rules_dump'.

func (*StnRulesDump) GetCrcString

func (*StnRulesDump) GetCrcString() string

func (*StnRulesDump) GetMessageName

func (*StnRulesDump) GetMessageName() string

func (*StnRulesDump) GetMessageType

func (*StnRulesDump) GetMessageType() api.MessageType

func (*StnRulesDump) Marshal

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

func (*StnRulesDump) Reset

func (m *StnRulesDump) Reset()

func (*StnRulesDump) Size

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

func (*StnRulesDump) Unmarshal

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