Documentation
¶
Overview ¶
Package pipe contains generated bindings for API file pipe.api.
Contents:
1 alias 6 enums 6 messages
Index ¶
- Constants
- Variables
- func AllMessages() []api.Message
- type IfStatusFlags
- type IfType
- type InterfaceIndex
- type LinkDuplex
- type MtuProto
- type PipeCreate
- func (*PipeCreate) GetCrcString() string
- func (*PipeCreate) GetMessageName() string
- func (*PipeCreate) GetMessageType() api.MessageType
- func (m *PipeCreate) Marshal(b []byte) ([]byte, error)
- func (m *PipeCreate) Reset()
- func (m *PipeCreate) Size() (size int)
- func (m *PipeCreate) Unmarshal(b []byte) error
- type PipeCreateReply
- func (*PipeCreateReply) GetCrcString() string
- func (*PipeCreateReply) GetMessageName() string
- func (*PipeCreateReply) GetMessageType() api.MessageType
- func (m *PipeCreateReply) Marshal(b []byte) ([]byte, error)
- func (m *PipeCreateReply) Reset()
- func (m *PipeCreateReply) Size() (size int)
- func (m *PipeCreateReply) Unmarshal(b []byte) error
- type PipeDelete
- func (*PipeDelete) GetCrcString() string
- func (*PipeDelete) GetMessageName() string
- func (*PipeDelete) GetMessageType() api.MessageType
- func (m *PipeDelete) Marshal(b []byte) ([]byte, error)
- func (m *PipeDelete) Reset()
- func (m *PipeDelete) Size() (size int)
- func (m *PipeDelete) Unmarshal(b []byte) error
- type PipeDeleteReply
- func (*PipeDeleteReply) GetCrcString() string
- func (*PipeDeleteReply) GetMessageName() string
- func (*PipeDeleteReply) GetMessageType() api.MessageType
- func (m *PipeDeleteReply) Marshal(b []byte) ([]byte, error)
- func (m *PipeDeleteReply) Reset()
- func (m *PipeDeleteReply) Size() (size int)
- func (m *PipeDeleteReply) Unmarshal(b []byte) error
- type PipeDetails
- func (*PipeDetails) GetCrcString() string
- func (*PipeDetails) GetMessageName() string
- func (*PipeDetails) GetMessageType() api.MessageType
- func (m *PipeDetails) Marshal(b []byte) ([]byte, error)
- func (m *PipeDetails) Reset()
- func (m *PipeDetails) Size() (size int)
- func (m *PipeDetails) Unmarshal(b []byte) error
- type PipeDump
- type RPCService
- type RPCService_PipeDumpClient
- type RxMode
- type SubIfFlags
Constants ¶
View Source
const ( APIFile = "pipe" APIVersion = "1.0.1" VersionCrc = 0x1d68f11 )
Variables ¶
View Source
var ( IfStatusFlags_name = map[uint32]string{ 1: "IF_STATUS_API_FLAG_ADMIN_UP", 2: "IF_STATUS_API_FLAG_LINK_UP", } IfStatusFlags_value = map[string]uint32{ "IF_STATUS_API_FLAG_ADMIN_UP": 1, "IF_STATUS_API_FLAG_LINK_UP": 2, } )
View Source
var ( IfType_name = map[uint32]string{ 1: "IF_API_TYPE_HARDWARE", 2: "IF_API_TYPE_SUB", 3: "IF_API_TYPE_P2P", 4: "IF_API_TYPE_PIPE", } IfType_value = map[string]uint32{ "IF_API_TYPE_HARDWARE": 1, "IF_API_TYPE_SUB": 2, "IF_API_TYPE_P2P": 3, "IF_API_TYPE_PIPE": 4, } )
View Source
var ( LinkDuplex_name = map[uint32]string{ 0: "LINK_DUPLEX_API_UNKNOWN", 1: "LINK_DUPLEX_API_HALF", 2: "LINK_DUPLEX_API_FULL", } LinkDuplex_value = map[string]uint32{ "LINK_DUPLEX_API_UNKNOWN": 0, "LINK_DUPLEX_API_HALF": 1, "LINK_DUPLEX_API_FULL": 2, } )
View Source
var ( MtuProto_name = map[uint32]string{ 1: "MTU_PROTO_API_L3", 2: "MTU_PROTO_API_IP4", 3: "MTU_PROTO_API_IP6", 4: "MTU_PROTO_API_MPLS", 5: "MTU_PROTO_API_N", } MtuProto_value = map[string]uint32{ "MTU_PROTO_API_L3": 1, "MTU_PROTO_API_IP4": 2, "MTU_PROTO_API_IP6": 3, "MTU_PROTO_API_MPLS": 4, "MTU_PROTO_API_N": 5, } )
View Source
var ( RxMode_name = map[uint32]string{ 0: "RX_MODE_API_UNKNOWN", 1: "RX_MODE_API_POLLING", 2: "RX_MODE_API_INTERRUPT", 3: "RX_MODE_API_ADAPTIVE", 4: "RX_MODE_API_DEFAULT", } RxMode_value = map[string]uint32{ "RX_MODE_API_UNKNOWN": 0, "RX_MODE_API_POLLING": 1, "RX_MODE_API_INTERRUPT": 2, "RX_MODE_API_ADAPTIVE": 3, "RX_MODE_API_DEFAULT": 4, } )
View Source
var ( SubIfFlags_name = map[uint32]string{ 1: "SUB_IF_API_FLAG_NO_TAGS", 2: "SUB_IF_API_FLAG_ONE_TAG", 4: "SUB_IF_API_FLAG_TWO_TAGS", 8: "SUB_IF_API_FLAG_DOT1AD", 16: "SUB_IF_API_FLAG_EXACT_MATCH", 32: "SUB_IF_API_FLAG_DEFAULT", 64: "SUB_IF_API_FLAG_OUTER_VLAN_ID_ANY", 128: "SUB_IF_API_FLAG_INNER_VLAN_ID_ANY", 254: "SUB_IF_API_FLAG_MASK_VNET", 256: "SUB_IF_API_FLAG_DOT1AH", } SubIfFlags_value = map[string]uint32{ "SUB_IF_API_FLAG_NO_TAGS": 1, "SUB_IF_API_FLAG_ONE_TAG": 2, "SUB_IF_API_FLAG_TWO_TAGS": 4, "SUB_IF_API_FLAG_DOT1AD": 8, "SUB_IF_API_FLAG_EXACT_MATCH": 16, "SUB_IF_API_FLAG_DEFAULT": 32, "SUB_IF_API_FLAG_OUTER_VLAN_ID_ANY": 64, "SUB_IF_API_FLAG_INNER_VLAN_ID_ANY": 128, "SUB_IF_API_FLAG_MASK_VNET": 254, "SUB_IF_API_FLAG_DOT1AH": 256, } )
Functions ¶
func AllMessages ¶
Messages returns list of all messages in this module.
Types ¶
type IfStatusFlags ¶
type IfStatusFlags uint32
IfStatusFlags defines enum 'if_status_flags'.
const ( IF_STATUS_API_FLAG_ADMIN_UP IfStatusFlags = 1 IF_STATUS_API_FLAG_LINK_UP IfStatusFlags = 2 )
func (IfStatusFlags) String ¶
func (x IfStatusFlags) String() string
type LinkDuplex ¶
type LinkDuplex uint32
LinkDuplex defines enum 'link_duplex'.
const ( LINK_DUPLEX_API_UNKNOWN LinkDuplex = 0 LINK_DUPLEX_API_HALF LinkDuplex = 1 LINK_DUPLEX_API_FULL LinkDuplex = 2 )
func (LinkDuplex) String ¶
func (x LinkDuplex) String() string
type PipeCreate ¶
type PipeCreate struct {
IsSpecified bool `binapi:"bool,name=is_specified" json:"is_specified,omitempty"`
UserInstance uint32 `binapi:"u32,name=user_instance" json:"user_instance,omitempty"`
}
PipeCreate defines message 'pipe_create'.
func (*PipeCreate) GetCrcString ¶
func (*PipeCreate) GetCrcString() string
func (*PipeCreate) GetMessageName ¶
func (*PipeCreate) GetMessageName() string
func (*PipeCreate) GetMessageType ¶
func (*PipeCreate) GetMessageType() api.MessageType
func (*PipeCreate) Reset ¶
func (m *PipeCreate) Reset()
func (*PipeCreate) Size ¶
func (m *PipeCreate) Size() (size int)
func (*PipeCreate) Unmarshal ¶
func (m *PipeCreate) Unmarshal(b []byte) error
type PipeCreateReply ¶
type PipeCreateReply struct {
Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
SwIfIndex InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
PipeSwIfIndex [2]InterfaceIndex `binapi:"interface_index[2],name=pipe_sw_if_index" json:"pipe_sw_if_index,omitempty"`
}
PipeCreateReply defines message 'pipe_create_reply'.
func (*PipeCreateReply) GetCrcString ¶
func (*PipeCreateReply) GetCrcString() string
func (*PipeCreateReply) GetMessageName ¶
func (*PipeCreateReply) GetMessageName() string
func (*PipeCreateReply) GetMessageType ¶
func (*PipeCreateReply) GetMessageType() api.MessageType
func (*PipeCreateReply) Reset ¶
func (m *PipeCreateReply) Reset()
func (*PipeCreateReply) Size ¶
func (m *PipeCreateReply) Size() (size int)
func (*PipeCreateReply) Unmarshal ¶
func (m *PipeCreateReply) Unmarshal(b []byte) error
type PipeDelete ¶
type PipeDelete struct {
SwIfIndex InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}
PipeDelete defines message 'pipe_delete'.
func (*PipeDelete) GetCrcString ¶
func (*PipeDelete) GetCrcString() string
func (*PipeDelete) GetMessageName ¶
func (*PipeDelete) GetMessageName() string
func (*PipeDelete) GetMessageType ¶
func (*PipeDelete) GetMessageType() api.MessageType
func (*PipeDelete) Reset ¶
func (m *PipeDelete) Reset()
func (*PipeDelete) Size ¶
func (m *PipeDelete) Size() (size int)
func (*PipeDelete) Unmarshal ¶
func (m *PipeDelete) Unmarshal(b []byte) error
type PipeDeleteReply ¶
type PipeDeleteReply struct {
Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}
PipeDeleteReply defines message 'pipe_delete_reply'.
func (*PipeDeleteReply) GetCrcString ¶
func (*PipeDeleteReply) GetCrcString() string
func (*PipeDeleteReply) GetMessageName ¶
func (*PipeDeleteReply) GetMessageName() string
func (*PipeDeleteReply) GetMessageType ¶
func (*PipeDeleteReply) GetMessageType() api.MessageType
func (*PipeDeleteReply) Reset ¶
func (m *PipeDeleteReply) Reset()
func (*PipeDeleteReply) Size ¶
func (m *PipeDeleteReply) Size() (size int)
func (*PipeDeleteReply) Unmarshal ¶
func (m *PipeDeleteReply) Unmarshal(b []byte) error
type PipeDetails ¶
type PipeDetails struct {
SwIfIndex InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
PipeSwIfIndex [2]InterfaceIndex `binapi:"interface_index[2],name=pipe_sw_if_index" json:"pipe_sw_if_index,omitempty"`
Instance uint32 `binapi:"u32,name=instance" json:"instance,omitempty"`
}
PipeDetails defines message 'pipe_details'.
func (*PipeDetails) GetCrcString ¶
func (*PipeDetails) GetCrcString() string
func (*PipeDetails) GetMessageName ¶
func (*PipeDetails) GetMessageName() string
func (*PipeDetails) GetMessageType ¶
func (*PipeDetails) GetMessageType() api.MessageType
func (*PipeDetails) Reset ¶
func (m *PipeDetails) Reset()
func (*PipeDetails) Size ¶
func (m *PipeDetails) Size() (size int)
func (*PipeDetails) Unmarshal ¶
func (m *PipeDetails) Unmarshal(b []byte) error
type PipeDump ¶
type PipeDump struct{}
PipeDump defines message 'pipe_dump'.
func (*PipeDump) GetCrcString ¶
func (*PipeDump) GetMessageName ¶
func (*PipeDump) GetMessageType ¶
func (*PipeDump) GetMessageType() api.MessageType
type RPCService ¶
type RPCService interface {
PipeCreate(ctx context.Context, in *PipeCreate) (*PipeCreateReply, error)
PipeDelete(ctx context.Context, in *PipeDelete) (*PipeDeleteReply, error)
PipeDump(ctx context.Context, in *PipeDump) (RPCService_PipeDumpClient, error)
}
RPCService defines RPC service pipe.
func NewServiceClient ¶
func NewServiceClient(conn api.Connection) RPCService
type RPCService_PipeDumpClient ¶
type RPCService_PipeDumpClient interface {
Recv() (*PipeDetails, error)
api.Stream
}
type SubIfFlags ¶
type SubIfFlags uint32
SubIfFlags defines enum 'sub_if_flags'.
const ( SUB_IF_API_FLAG_NO_TAGS SubIfFlags = 1 SUB_IF_API_FLAG_ONE_TAG SubIfFlags = 2 SUB_IF_API_FLAG_TWO_TAGS SubIfFlags = 4 SUB_IF_API_FLAG_DOT1AD SubIfFlags = 8 SUB_IF_API_FLAG_EXACT_MATCH SubIfFlags = 16 SUB_IF_API_FLAG_DEFAULT SubIfFlags = 32 SUB_IF_API_FLAG_OUTER_VLAN_ID_ANY SubIfFlags = 64 SUB_IF_API_FLAG_INNER_VLAN_ID_ANY SubIfFlags = 128 SUB_IF_API_FLAG_MASK_VNET SubIfFlags = 254 SUB_IF_API_FLAG_DOT1AH SubIfFlags = 256 )
func (SubIfFlags) String ¶
func (x SubIfFlags) String() string
Click to show internal directories.
Click to hide internal directories.