Documentation ¶
Overview ¶
Package flow contains generated bindings for API file flow.api.
Contents: - 10 messages
Index ¶
- Constants
- func AllMessages() []api.Message
- type FlowAdd
- type FlowAddReply
- func (*FlowAddReply) GetCrcString() string
- func (*FlowAddReply) GetMessageName() string
- func (*FlowAddReply) GetMessageType() api.MessageType
- func (m *FlowAddReply) Marshal(b []byte) ([]byte, error)
- func (m *FlowAddReply) Reset()
- func (m *FlowAddReply) Size() (size int)
- func (m *FlowAddReply) Unmarshal(b []byte) error
- type FlowAddV2
- type FlowAddV2Reply
- func (*FlowAddV2Reply) GetCrcString() string
- func (*FlowAddV2Reply) GetMessageName() string
- func (*FlowAddV2Reply) GetMessageType() api.MessageType
- func (m *FlowAddV2Reply) Marshal(b []byte) ([]byte, error)
- func (m *FlowAddV2Reply) Reset()
- func (m *FlowAddV2Reply) Size() (size int)
- func (m *FlowAddV2Reply) Unmarshal(b []byte) error
- type FlowDel
- type FlowDelReply
- func (*FlowDelReply) GetCrcString() string
- func (*FlowDelReply) GetMessageName() string
- func (*FlowDelReply) GetMessageType() api.MessageType
- func (m *FlowDelReply) Marshal(b []byte) ([]byte, error)
- func (m *FlowDelReply) Reset()
- func (m *FlowDelReply) Size() (size int)
- func (m *FlowDelReply) Unmarshal(b []byte) error
- type FlowDisable
- func (*FlowDisable) GetCrcString() string
- func (*FlowDisable) GetMessageName() string
- func (*FlowDisable) GetMessageType() api.MessageType
- func (m *FlowDisable) Marshal(b []byte) ([]byte, error)
- func (m *FlowDisable) Reset()
- func (m *FlowDisable) Size() (size int)
- func (m *FlowDisable) Unmarshal(b []byte) error
- type FlowDisableReply
- func (*FlowDisableReply) GetCrcString() string
- func (*FlowDisableReply) GetMessageName() string
- func (*FlowDisableReply) GetMessageType() api.MessageType
- func (m *FlowDisableReply) Marshal(b []byte) ([]byte, error)
- func (m *FlowDisableReply) Reset()
- func (m *FlowDisableReply) Size() (size int)
- func (m *FlowDisableReply) Unmarshal(b []byte) error
- type FlowEnable
- func (*FlowEnable) GetCrcString() string
- func (*FlowEnable) GetMessageName() string
- func (*FlowEnable) GetMessageType() api.MessageType
- func (m *FlowEnable) Marshal(b []byte) ([]byte, error)
- func (m *FlowEnable) Reset()
- func (m *FlowEnable) Size() (size int)
- func (m *FlowEnable) Unmarshal(b []byte) error
- type FlowEnableReply
- func (*FlowEnableReply) GetCrcString() string
- func (*FlowEnableReply) GetMessageName() string
- func (*FlowEnableReply) GetMessageType() api.MessageType
- func (m *FlowEnableReply) Marshal(b []byte) ([]byte, error)
- func (m *FlowEnableReply) Reset()
- func (m *FlowEnableReply) Size() (size int)
- func (m *FlowEnableReply) Unmarshal(b []byte) error
- type RPCService
Constants ¶
const ( APIFile = "flow" APIVersion = "0.0.3" VersionCrc = 0xe17512 )
Variables ¶
This section is empty.
Functions ¶
func AllMessages ¶
Messages returns list of all messages in this module.
Types ¶
type FlowAdd ¶
type FlowAdd struct {
Flow flow_types.FlowRule `binapi:"flow_rule,name=flow" json:"flow,omitempty"`
}
flow add request
- flow - flow rule
FlowAdd defines message 'flow_add'. Deprecated: the message will be removed in the future versions
func (*FlowAdd) GetCrcString ¶
func (*FlowAdd) GetMessageName ¶
func (*FlowAdd) GetMessageType ¶
func (*FlowAdd) GetMessageType() api.MessageType
type FlowAddReply ¶
type FlowAddReply struct { Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"` FlowIndex uint32 `binapi:"u32,name=flow_index" json:"flow_index,omitempty"` }
reply for adding flow
- retval - return code
- flow_index - flow index, can be used for flow del/enable/disable
FlowAddReply defines message 'flow_add_reply'. Deprecated: the message will be removed in the future versions
func (*FlowAddReply) GetCrcString ¶
func (*FlowAddReply) GetCrcString() string
func (*FlowAddReply) GetMessageName ¶
func (*FlowAddReply) GetMessageName() string
func (*FlowAddReply) GetMessageType ¶
func (*FlowAddReply) GetMessageType() api.MessageType
func (*FlowAddReply) Reset ¶
func (m *FlowAddReply) Reset()
func (*FlowAddReply) Size ¶
func (m *FlowAddReply) Size() (size int)
func (*FlowAddReply) Unmarshal ¶
func (m *FlowAddReply) Unmarshal(b []byte) error
type FlowAddV2 ¶
type FlowAddV2 struct {
Flow flow_types.FlowRuleV2 `binapi:"flow_rule_v2,name=flow" json:"flow,omitempty"`
}
flow add request v2
- flow - flow rule v2
FlowAddV2 defines message 'flow_add_v2'.
func (*FlowAddV2) GetCrcString ¶
func (*FlowAddV2) GetMessageName ¶
func (*FlowAddV2) GetMessageType ¶
func (*FlowAddV2) GetMessageType() api.MessageType
type FlowAddV2Reply ¶
type FlowAddV2Reply struct { Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"` FlowIndex uint32 `binapi:"u32,name=flow_index" json:"flow_index,omitempty"` }
reply for adding flow v2
- retval - return code
- flow_index - flow index, can be used for flow del/enable/disable
FlowAddV2Reply defines message 'flow_add_v2_reply'.
func (*FlowAddV2Reply) GetCrcString ¶
func (*FlowAddV2Reply) GetCrcString() string
func (*FlowAddV2Reply) GetMessageName ¶
func (*FlowAddV2Reply) GetMessageName() string
func (*FlowAddV2Reply) GetMessageType ¶
func (*FlowAddV2Reply) GetMessageType() api.MessageType
func (*FlowAddV2Reply) Reset ¶
func (m *FlowAddV2Reply) Reset()
func (*FlowAddV2Reply) Size ¶
func (m *FlowAddV2Reply) Size() (size int)
func (*FlowAddV2Reply) Unmarshal ¶
func (m *FlowAddV2Reply) Unmarshal(b []byte) error
type FlowDel ¶
type FlowDel struct {
FlowIndex uint32 `binapi:"u32,name=flow_index" json:"flow_index,omitempty"`
}
flow del request
- flow_index - flow index
FlowDel defines message 'flow_del'.
func (*FlowDel) GetCrcString ¶
func (*FlowDel) GetMessageName ¶
func (*FlowDel) GetMessageType ¶
func (*FlowDel) GetMessageType() api.MessageType
type FlowDelReply ¶
type FlowDelReply struct {
Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}
FlowDelReply defines message 'flow_del_reply'.
func (*FlowDelReply) GetCrcString ¶
func (*FlowDelReply) GetCrcString() string
func (*FlowDelReply) GetMessageName ¶
func (*FlowDelReply) GetMessageName() string
func (*FlowDelReply) GetMessageType ¶
func (*FlowDelReply) GetMessageType() api.MessageType
func (*FlowDelReply) Reset ¶
func (m *FlowDelReply) Reset()
func (*FlowDelReply) Size ¶
func (m *FlowDelReply) Size() (size int)
func (*FlowDelReply) Unmarshal ¶
func (m *FlowDelReply) Unmarshal(b []byte) error
type FlowDisable ¶
type FlowDisable struct { FlowIndex uint32 `binapi:"u32,name=flow_index" json:"flow_index,omitempty"` HwIfIndex uint32 `binapi:"u32,name=hw_if_index" json:"hw_if_index,omitempty"` }
flow disable request
- flow_index - flow index
- hw_if_index - hardware interface index
FlowDisable defines message 'flow_disable'.
func (*FlowDisable) GetCrcString ¶
func (*FlowDisable) GetCrcString() string
func (*FlowDisable) GetMessageName ¶
func (*FlowDisable) GetMessageName() string
func (*FlowDisable) GetMessageType ¶
func (*FlowDisable) GetMessageType() api.MessageType
func (*FlowDisable) Reset ¶
func (m *FlowDisable) Reset()
func (*FlowDisable) Size ¶
func (m *FlowDisable) Size() (size int)
func (*FlowDisable) Unmarshal ¶
func (m *FlowDisable) Unmarshal(b []byte) error
type FlowDisableReply ¶
type FlowDisableReply struct {
Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}
FlowDisableReply defines message 'flow_disable_reply'.
func (*FlowDisableReply) GetCrcString ¶
func (*FlowDisableReply) GetCrcString() string
func (*FlowDisableReply) GetMessageName ¶
func (*FlowDisableReply) GetMessageName() string
func (*FlowDisableReply) GetMessageType ¶
func (*FlowDisableReply) GetMessageType() api.MessageType
func (*FlowDisableReply) Reset ¶
func (m *FlowDisableReply) Reset()
func (*FlowDisableReply) Size ¶
func (m *FlowDisableReply) Size() (size int)
func (*FlowDisableReply) Unmarshal ¶
func (m *FlowDisableReply) Unmarshal(b []byte) error
type FlowEnable ¶
type FlowEnable struct { FlowIndex uint32 `binapi:"u32,name=flow_index" json:"flow_index,omitempty"` HwIfIndex uint32 `binapi:"u32,name=hw_if_index" json:"hw_if_index,omitempty"` }
flow enable request
- flow_index - flow index
- hw_if_index - hardware interface index
FlowEnable defines message 'flow_enable'.
func (*FlowEnable) GetCrcString ¶
func (*FlowEnable) GetCrcString() string
func (*FlowEnable) GetMessageName ¶
func (*FlowEnable) GetMessageName() string
func (*FlowEnable) GetMessageType ¶
func (*FlowEnable) GetMessageType() api.MessageType
func (*FlowEnable) Reset ¶
func (m *FlowEnable) Reset()
func (*FlowEnable) Size ¶
func (m *FlowEnable) Size() (size int)
func (*FlowEnable) Unmarshal ¶
func (m *FlowEnable) Unmarshal(b []byte) error
type FlowEnableReply ¶
type FlowEnableReply struct {
Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}
FlowEnableReply defines message 'flow_enable_reply'.
func (*FlowEnableReply) GetCrcString ¶
func (*FlowEnableReply) GetCrcString() string
func (*FlowEnableReply) GetMessageName ¶
func (*FlowEnableReply) GetMessageName() string
func (*FlowEnableReply) GetMessageType ¶
func (*FlowEnableReply) GetMessageType() api.MessageType
func (*FlowEnableReply) Reset ¶
func (m *FlowEnableReply) Reset()
func (*FlowEnableReply) Size ¶
func (m *FlowEnableReply) Size() (size int)
func (*FlowEnableReply) Unmarshal ¶
func (m *FlowEnableReply) Unmarshal(b []byte) error
type RPCService ¶
type RPCService interface { FlowAdd(ctx context.Context, in *FlowAdd) (*FlowAddReply, error) FlowAddV2(ctx context.Context, in *FlowAddV2) (*FlowAddV2Reply, error) FlowDel(ctx context.Context, in *FlowDel) (*FlowDelReply, error) FlowDisable(ctx context.Context, in *FlowDisable) (*FlowDisableReply, error) FlowEnable(ctx context.Context, in *FlowEnable) (*FlowEnableReply, error) }
RPCService defines RPC service flow.
func NewServiceClient ¶
func NewServiceClient(conn api.Connection) RPCService