udp

Documentation

Overview

Package udp is a generated protocol buffer package.

It is generated from these files:

github.com/google/cloudprober/probes/udp/config.proto

It has these top-level messages:

ProbeConf

Package udp implements a UDP prober. It sends UDP queries to a list of targets and reports statistics on queries sent, queries received, and latency experienced.

Queries to each target are sent in parallel.

Index

• Constants
• type Probe
  • func (p *Probe) Init(name string, opts *options.Options) error
  • func (p *Probe) Start(ctx context.Context, dataChan chan *metrics.EventMetrics)
• type ProbeConf
  • func (*ProbeConf) Descriptor() ([]byte, []int)
  • func (m *ProbeConf) GetIpVersion() int32
  • func (m *ProbeConf) GetMaxLength() int32
  • func (m *ProbeConf) GetNumTxPorts() int32
  • func (m *ProbeConf) GetPort() int32
  • func (m *ProbeConf) GetStatsExportIntervalMsec() int32
  • func (*ProbeConf) ProtoMessage()
  • func (m *ProbeConf) Reset()
  • func (m *ProbeConf) String() string

Constants

const Default_ProbeConf_IpVersion int32 = 4

const Default_ProbeConf_MaxLength int32 = 1300

const Default_ProbeConf_NumTxPorts int32 = 16

const Default_ProbeConf_Port int32 = 31122

const Default_ProbeConf_StatsExportIntervalMsec int32 = 10000

Types

type Probe

type Probe struct {
	// contains filtered or unexported fields
}

Probe holds aggregate information about all probe runs, per-target.

func (*Probe) Init

func (p *Probe) Init(name string, opts *options.Options) error

Init initializes the probe with the given params.

func (*Probe) Start

func (p *Probe) Start(ctx context.Context, dataChan chan *metrics.EventMetrics)

Start starts and runs the probe indefinitely.

type ProbeConf

type ProbeConf struct {
	// Export stats after these many milliseconds
	StatsExportIntervalMsec *int32 `` /* 138-byte string literal not displayed */
	// Port to send UDP Ping to (UDP Echo).  Should be same as
	// ProberConfig.udp_echo_server_port.
	// TODO: Can we just read this from ProberConfig?
	Port *int32 `protobuf:"varint,3,opt,name=port,def=31122" json:"port,omitempty"`
	// Number of sending side ports to use.
	NumTxPorts *int32 `protobuf:"varint,4,opt,name=num_tx_ports,json=numTxPorts,def=16" json:"num_tx_ports,omitempty"`
	// message max to account for MTU.
	MaxLength *int32 `protobuf:"varint,5,opt,name=max_length,json=maxLength,def=1300" json:"max_length,omitempty"`
	// IP proto: v4|v6. Temporary workaround till we add support in base probe proto.
	IpVersion        *int32 `protobuf:"varint,6,opt,name=ip_version,json=ipVersion,def=4" json:"ip_version,omitempty"`
	XXX_unrecognized []byte `json:"-"`
}

func (*ProbeConf) Descriptor

func (*ProbeConf) Descriptor() ([]byte, []int)

func (*ProbeConf) GetIpVersion

func (m *ProbeConf) GetIpVersion() int32

func (*ProbeConf) GetMaxLength

func (m *ProbeConf) GetMaxLength() int32

func (*ProbeConf) GetNumTxPorts

func (m *ProbeConf) GetNumTxPorts() int32

func (*ProbeConf) GetPort

func (m *ProbeConf) GetPort() int32

func (*ProbeConf) GetStatsExportIntervalMsec

func (m *ProbeConf) GetStatsExportIntervalMsec() int32

func (*ProbeConf) ProtoMessage

func (*ProbeConf) ProtoMessage()

func (*ProbeConf) Reset

func (m *ProbeConf) Reset()

func (*ProbeConf) String

func (m *ProbeConf) String() string