Documentation
¶
Overview ¶
Package udp_ping contains generated bindings for API file udp_ping.api.
Contents:
5 aliases 4 enums 6 structs 1 union 4 messages
Index ¶
- Constants
- Variables
- func AllMessages() []api.Message
- type Address
- type AddressFamily
- type AddressUnion
- type AddressWithPrefix
- type IP4Address
- type IP4AddressWithPrefix
- type IP4Prefix
- type IP6Address
- type IP6AddressWithPrefix
- type IP6Prefix
- type IPDscp
- type IPEcn
- type IPProto
- type Mprefix
- type Prefix
- type PrefixMatcher
- type RPCService
- type UDPPingAddDel
- func (*UDPPingAddDel) GetCrcString() string
- func (*UDPPingAddDel) GetMessageName() string
- func (*UDPPingAddDel) GetMessageType() api.MessageType
- func (m *UDPPingAddDel) Marshal(b []byte) ([]byte, error)
- func (m *UDPPingAddDel) Reset()
- func (m *UDPPingAddDel) Size() (size int)
- func (m *UDPPingAddDel) Unmarshal(b []byte) error
- type UDPPingAddDelReply
- func (*UDPPingAddDelReply) GetCrcString() string
- func (*UDPPingAddDelReply) GetMessageName() string
- func (*UDPPingAddDelReply) GetMessageType() api.MessageType
- func (m *UDPPingAddDelReply) Marshal(b []byte) ([]byte, error)
- func (m *UDPPingAddDelReply) Reset()
- func (m *UDPPingAddDelReply) Size() (size int)
- func (m *UDPPingAddDelReply) Unmarshal(b []byte) error
- type UDPPingExport
- func (*UDPPingExport) GetCrcString() string
- func (*UDPPingExport) GetMessageName() string
- func (*UDPPingExport) GetMessageType() api.MessageType
- func (m *UDPPingExport) Marshal(b []byte) ([]byte, error)
- func (m *UDPPingExport) Reset()
- func (m *UDPPingExport) Size() (size int)
- func (m *UDPPingExport) Unmarshal(b []byte) error
- type UDPPingExportReply
- func (*UDPPingExportReply) GetCrcString() string
- func (*UDPPingExportReply) GetMessageName() string
- func (*UDPPingExportReply) GetMessageType() api.MessageType
- func (m *UDPPingExportReply) Marshal(b []byte) ([]byte, error)
- func (m *UDPPingExportReply) Reset()
- func (m *UDPPingExportReply) Size() (size int)
- func (m *UDPPingExportReply) Unmarshal(b []byte) error
Constants ¶
const ( APIFile = "udp_ping" APIVersion = "3.0.0" VersionCrc = 0x5a416f51 )
Variables ¶
var ( AddressFamily_name = map[uint32]string{ 0: "ADDRESS_IP4", 1: "ADDRESS_IP6", } AddressFamily_value = map[string]uint32{ "ADDRESS_IP4": 0, "ADDRESS_IP6": 1, } )
var ( IPDscp_name = map[uint8]string{ 0: "IP_API_DSCP_CS0", 8: "IP_API_DSCP_CS1", 10: "IP_API_DSCP_AF11", 12: "IP_API_DSCP_AF12", 14: "IP_API_DSCP_AF13", 16: "IP_API_DSCP_CS2", 18: "IP_API_DSCP_AF21", 20: "IP_API_DSCP_AF22", 22: "IP_API_DSCP_AF23", 24: "IP_API_DSCP_CS3", 26: "IP_API_DSCP_AF31", 28: "IP_API_DSCP_AF32", 30: "IP_API_DSCP_AF33", 32: "IP_API_DSCP_CS4", 34: "IP_API_DSCP_AF41", 36: "IP_API_DSCP_AF42", 38: "IP_API_DSCP_AF43", 40: "IP_API_DSCP_CS5", 46: "IP_API_DSCP_EF", 48: "IP_API_DSCP_CS6", 50: "IP_API_DSCP_CS7", } IPDscp_value = map[string]uint8{ "IP_API_DSCP_CS0": 0, "IP_API_DSCP_CS1": 8, "IP_API_DSCP_AF11": 10, "IP_API_DSCP_AF12": 12, "IP_API_DSCP_AF13": 14, "IP_API_DSCP_CS2": 16, "IP_API_DSCP_AF21": 18, "IP_API_DSCP_AF22": 20, "IP_API_DSCP_AF23": 22, "IP_API_DSCP_CS3": 24, "IP_API_DSCP_AF31": 26, "IP_API_DSCP_AF32": 28, "IP_API_DSCP_AF33": 30, "IP_API_DSCP_CS4": 32, "IP_API_DSCP_AF41": 34, "IP_API_DSCP_AF42": 36, "IP_API_DSCP_AF43": 38, "IP_API_DSCP_CS5": 40, "IP_API_DSCP_EF": 46, "IP_API_DSCP_CS6": 48, "IP_API_DSCP_CS7": 50, } )
var ( IPEcn_name = map[uint8]string{ 0: "IP_API_ECN_NONE", 1: "IP_API_ECN_ECT0", 2: "IP_API_ECN_ECT1", 3: "IP_API_ECN_CE", } IPEcn_value = map[string]uint8{ "IP_API_ECN_NONE": 0, "IP_API_ECN_ECT0": 1, "IP_API_ECN_ECT1": 2, "IP_API_ECN_CE": 3, } )
var ( IPProto_name = map[uint32]string{ 0: "IP_API_PROTO_HOPOPT", 1: "IP_API_PROTO_ICMP", 2: "IP_API_PROTO_IGMP", 6: "IP_API_PROTO_TCP", 17: "IP_API_PROTO_UDP", 47: "IP_API_PROTO_GRE", 50: "IP_API_PROTO_AH", 51: "IP_API_PROTO_ESP", 88: "IP_API_PROTO_EIGRP", 89: "IP_API_PROTO_OSPF", 132: "IP_API_PROTO_SCTP", 255: "IP_API_PROTO_RESERVED", } IPProto_value = map[string]uint32{ "IP_API_PROTO_HOPOPT": 0, "IP_API_PROTO_ICMP": 1, "IP_API_PROTO_IGMP": 2, "IP_API_PROTO_TCP": 6, "IP_API_PROTO_UDP": 17, "IP_API_PROTO_GRE": 47, "IP_API_PROTO_AH": 50, "IP_API_PROTO_ESP": 51, "IP_API_PROTO_EIGRP": 88, "IP_API_PROTO_OSPF": 89, "IP_API_PROTO_SCTP": 132, "IP_API_PROTO_RESERVED": 255, } )
Functions ¶
func AllMessages ¶
Messages returns list of all messages in this module.
Types ¶
type Address ¶
type Address struct { Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"` Un AddressUnion `binapi:"address_union,name=un" json:"un,omitempty"` }
Address defines type 'address'.
func ParseAddress ¶
func (*Address) MarshalText ¶
func (*Address) UnmarshalText ¶
type AddressFamily ¶
type AddressFamily uint32
AddressFamily defines enum 'address_family'.
const ( ADDRESS_IP4 AddressFamily = 0 ADDRESS_IP6 AddressFamily = 1 )
func (AddressFamily) String ¶
func (x AddressFamily) String() string
type AddressUnion ¶
type AddressUnion struct { // IP4 *IP4Address // IP6 *IP6Address XXX_UnionData [16]byte }
AddressUnion defines union 'address_union'.
func AddressUnionIP4 ¶
func AddressUnionIP4(a IP4Address) (u AddressUnion)
func AddressUnionIP6 ¶
func AddressUnionIP6(a IP6Address) (u AddressUnion)
func (*AddressUnion) GetIP4 ¶
func (u *AddressUnion) GetIP4() (a IP4Address)
func (*AddressUnion) GetIP6 ¶
func (u *AddressUnion) GetIP6() (a IP6Address)
func (*AddressUnion) SetIP4 ¶
func (u *AddressUnion) SetIP4(a IP4Address)
func (*AddressUnion) SetIP6 ¶
func (u *AddressUnion) SetIP6(a IP6Address)
type AddressWithPrefix ¶
type AddressWithPrefix Prefix
AddressWithPrefix defines alias 'address_with_prefix'.
func ParseAddressWithPrefix ¶
func ParseAddressWithPrefix(s string) (AddressWithPrefix, error)
func (*AddressWithPrefix) MarshalText ¶
func (x *AddressWithPrefix) MarshalText() ([]byte, error)
func (AddressWithPrefix) String ¶
func (x AddressWithPrefix) String() string
func (*AddressWithPrefix) UnmarshalText ¶
func (x *AddressWithPrefix) UnmarshalText(text []byte) error
type IP4Address ¶
type IP4Address [4]uint8
IP4Address defines alias 'ip4_address'.
func ParseIP4Address ¶
func ParseIP4Address(s string) (IP4Address, error)
func (*IP4Address) MarshalText ¶
func (x *IP4Address) MarshalText() ([]byte, error)
func (IP4Address) String ¶
func (x IP4Address) String() string
func (IP4Address) ToIP ¶
func (x IP4Address) ToIP() net.IP
func (*IP4Address) UnmarshalText ¶
func (x *IP4Address) UnmarshalText(text []byte) error
type IP4AddressWithPrefix ¶
type IP4AddressWithPrefix IP4Prefix
IP4AddressWithPrefix defines alias 'ip4_address_with_prefix'.
type IP4Prefix ¶
type IP4Prefix struct { Address IP4Address `binapi:"ip4_address,name=address" json:"address,omitempty"` Len uint8 `binapi:"u8,name=len" json:"len,omitempty"` }
IP4Prefix defines type 'ip4_prefix'.
func ParseIP4Prefix ¶
func (*IP4Prefix) MarshalText ¶
func (*IP4Prefix) UnmarshalText ¶
type IP6Address ¶
type IP6Address [16]uint8
IP6Address defines alias 'ip6_address'.
func ParseIP6Address ¶
func ParseIP6Address(s string) (IP6Address, error)
func (*IP6Address) MarshalText ¶
func (x *IP6Address) MarshalText() ([]byte, error)
func (IP6Address) String ¶
func (x IP6Address) String() string
func (IP6Address) ToIP ¶
func (x IP6Address) ToIP() net.IP
func (*IP6Address) UnmarshalText ¶
func (x *IP6Address) UnmarshalText(text []byte) error
type IP6AddressWithPrefix ¶
type IP6AddressWithPrefix IP6Prefix
IP6AddressWithPrefix defines alias 'ip6_address_with_prefix'.
type IP6Prefix ¶
type IP6Prefix struct { Address IP6Address `binapi:"ip6_address,name=address" json:"address,omitempty"` Len uint8 `binapi:"u8,name=len" json:"len,omitempty"` }
IP6Prefix defines type 'ip6_prefix'.
func ParseIP6Prefix ¶
func (*IP6Prefix) MarshalText ¶
func (*IP6Prefix) UnmarshalText ¶
type IPDscp ¶
type IPDscp uint8
IPDscp defines enum 'ip_dscp'.
const ( IP_API_DSCP_CS0 IPDscp = 0 IP_API_DSCP_CS1 IPDscp = 8 IP_API_DSCP_AF11 IPDscp = 10 IP_API_DSCP_AF12 IPDscp = 12 IP_API_DSCP_AF13 IPDscp = 14 IP_API_DSCP_CS2 IPDscp = 16 IP_API_DSCP_AF21 IPDscp = 18 IP_API_DSCP_AF22 IPDscp = 20 IP_API_DSCP_AF23 IPDscp = 22 IP_API_DSCP_CS3 IPDscp = 24 IP_API_DSCP_AF31 IPDscp = 26 IP_API_DSCP_AF32 IPDscp = 28 IP_API_DSCP_AF33 IPDscp = 30 IP_API_DSCP_CS4 IPDscp = 32 IP_API_DSCP_AF41 IPDscp = 34 IP_API_DSCP_AF42 IPDscp = 36 IP_API_DSCP_AF43 IPDscp = 38 IP_API_DSCP_CS5 IPDscp = 40 IP_API_DSCP_EF IPDscp = 46 IP_API_DSCP_CS6 IPDscp = 48 IP_API_DSCP_CS7 IPDscp = 50 )
type IPProto ¶
type IPProto uint32
IPProto defines enum 'ip_proto'.
const ( IP_API_PROTO_HOPOPT IPProto = 0 IP_API_PROTO_ICMP IPProto = 1 IP_API_PROTO_IGMP IPProto = 2 IP_API_PROTO_TCP IPProto = 6 IP_API_PROTO_UDP IPProto = 17 IP_API_PROTO_GRE IPProto = 47 IP_API_PROTO_AH IPProto = 50 IP_API_PROTO_ESP IPProto = 51 IP_API_PROTO_EIGRP IPProto = 88 IP_API_PROTO_OSPF IPProto = 89 IP_API_PROTO_SCTP IPProto = 132 IP_API_PROTO_RESERVED IPProto = 255 )
type Mprefix ¶
type Mprefix struct { Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"` GrpAddressLength uint16 `binapi:"u16,name=grp_address_length" json:"grp_address_length,omitempty"` GrpAddress AddressUnion `binapi:"address_union,name=grp_address" json:"grp_address,omitempty"` SrcAddress AddressUnion `binapi:"address_union,name=src_address" json:"src_address,omitempty"` }
Mprefix defines type 'mprefix'.
type Prefix ¶
type Prefix struct { Address Address `binapi:"address,name=address" json:"address,omitempty"` Len uint8 `binapi:"u8,name=len" json:"len,omitempty"` }
Prefix defines type 'prefix'.
func ParsePrefix ¶
func (*Prefix) MarshalText ¶
func (*Prefix) UnmarshalText ¶
type PrefixMatcher ¶
type PrefixMatcher struct { Le uint8 `binapi:"u8,name=le" json:"le,omitempty"` Ge uint8 `binapi:"u8,name=ge" json:"ge,omitempty"` }
PrefixMatcher defines type 'prefix_matcher'.
type RPCService ¶
type RPCService interface { UDPPingAddDel(ctx context.Context, in *UDPPingAddDel) (*UDPPingAddDelReply, error) UDPPingExport(ctx context.Context, in *UDPPingExport) (*UDPPingExportReply, error) }
RPCService defines RPC service udp_ping.
func NewServiceClient ¶
func NewServiceClient(conn api.Connection) RPCService
type UDPPingAddDel ¶
type UDPPingAddDel struct { SrcIPAddress Address `binapi:"address,name=src_ip_address" json:"src_ip_address,omitempty"` DstIPAddress Address `binapi:"address,name=dst_ip_address" json:"dst_ip_address,omitempty"` StartSrcPort uint16 `binapi:"u16,name=start_src_port" json:"start_src_port,omitempty"` EndSrcPort uint16 `binapi:"u16,name=end_src_port" json:"end_src_port,omitempty"` StartDstPort uint16 `binapi:"u16,name=start_dst_port" json:"start_dst_port,omitempty"` EndDstPort uint16 `binapi:"u16,name=end_dst_port" json:"end_dst_port,omitempty"` Interval uint16 `binapi:"u16,name=interval" json:"interval,omitempty"` Dis uint8 `binapi:"u8,name=dis" json:"dis,omitempty"` FaultDet uint8 `binapi:"u8,name=fault_det" json:"fault_det,omitempty"` Reserve []byte `binapi:"u8[3],name=reserve" json:"reserve,omitempty"` }
UDPPingAddDel defines message 'udp_ping_add_del'.
func (*UDPPingAddDel) GetCrcString ¶
func (*UDPPingAddDel) GetCrcString() string
func (*UDPPingAddDel) GetMessageName ¶
func (*UDPPingAddDel) GetMessageName() string
func (*UDPPingAddDel) GetMessageType ¶
func (*UDPPingAddDel) GetMessageType() api.MessageType
func (*UDPPingAddDel) Reset ¶
func (m *UDPPingAddDel) Reset()
func (*UDPPingAddDel) Size ¶
func (m *UDPPingAddDel) Size() (size int)
func (*UDPPingAddDel) Unmarshal ¶
func (m *UDPPingAddDel) Unmarshal(b []byte) error
type UDPPingAddDelReply ¶
type UDPPingAddDelReply struct {
Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}
UDPPingAddDelReply defines message 'udp_ping_add_del_reply'.
func (*UDPPingAddDelReply) GetCrcString ¶
func (*UDPPingAddDelReply) GetCrcString() string
func (*UDPPingAddDelReply) GetMessageName ¶
func (*UDPPingAddDelReply) GetMessageName() string
func (*UDPPingAddDelReply) GetMessageType ¶
func (*UDPPingAddDelReply) GetMessageType() api.MessageType
func (*UDPPingAddDelReply) Reset ¶
func (m *UDPPingAddDelReply) Reset()
func (*UDPPingAddDelReply) Size ¶
func (m *UDPPingAddDelReply) Size() (size int)
func (*UDPPingAddDelReply) Unmarshal ¶
func (m *UDPPingAddDelReply) Unmarshal(b []byte) error
type UDPPingExport ¶
type UDPPingExport struct {
Enable bool `binapi:"bool,name=enable" json:"enable,omitempty"`
}
UDPPingExport defines message 'udp_ping_export'.
func (*UDPPingExport) GetCrcString ¶
func (*UDPPingExport) GetCrcString() string
func (*UDPPingExport) GetMessageName ¶
func (*UDPPingExport) GetMessageName() string
func (*UDPPingExport) GetMessageType ¶
func (*UDPPingExport) GetMessageType() api.MessageType
func (*UDPPingExport) Reset ¶
func (m *UDPPingExport) Reset()
func (*UDPPingExport) Size ¶
func (m *UDPPingExport) Size() (size int)
func (*UDPPingExport) Unmarshal ¶
func (m *UDPPingExport) Unmarshal(b []byte) error
type UDPPingExportReply ¶
type UDPPingExportReply struct {
Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}
UDPPingExportReply defines message 'udp_ping_export_reply'.
func (*UDPPingExportReply) GetCrcString ¶
func (*UDPPingExportReply) GetCrcString() string
func (*UDPPingExportReply) GetMessageName ¶
func (*UDPPingExportReply) GetMessageName() string
func (*UDPPingExportReply) GetMessageType ¶
func (*UDPPingExportReply) GetMessageType() api.MessageType
func (*UDPPingExportReply) Reset ¶
func (m *UDPPingExportReply) Reset()
func (*UDPPingExportReply) Size ¶
func (m *UDPPingExportReply) Size() (size int)
func (*UDPPingExportReply) Unmarshal ¶
func (m *UDPPingExportReply) Unmarshal(b []byte) error