Documentation
¶
Overview ¶
Package quicping implements the quicping network experiment. This implements, in particular, v0.1.0 of the spec.
See https://github.com/ooni/spec/blob/master/nettests/ts-031-quicping.md.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrInputRequired indicates that no richer-input target was provided. ErrInputRequired = targetloading.ErrInputRequired // ErrInvalidInputType indicates that the richer-input target has the wrong type. ErrInvalidInputType = targetloading.ErrInvalidInputType )
Functions ¶
func NewExperimentMeasurer ¶
func NewExperimentMeasurer() model.ExperimentMeasurer
NewExperimentMeasurer creates a new ExperimentMeasurer.
func NewLoader ¶ added in v3.31.0
func NewLoader(loader *targetloading.Loader, gopts any) model.ExperimentTargetLoader
NewLoader constructs a new model.ExperimentTargetLoader instance.
This function PANICS if options is not an instance of *quicping.Config.
Types ¶
type Config ¶
type Config struct {
// Repetitions is the number of repetitions for each ping.
Repetitions int64 `json:"repetitions,omitempty" ooni:"number of times to repeat the measurement"`
// Port is the port to test.
Port int64 `json:"port,omitempty" ooni:"port is the port to test"`
// contains filtered or unexported fields
}
Config contains the experiment configuration.
type Measurer ¶
type Measurer struct{}
Measurer performs the measurement.
func (*Measurer) ExperimentName ¶
ExperimentName implements ExperimentMeasurer.ExperimentName.
func (*Measurer) ExperimentVersion ¶
ExperimentVersion implements ExperimentMeasurer.ExperimentVersion.
type SinglePing ¶
type SinglePing struct {
ConnIdDst string `json:"conn_id_dst"`
ConnIdSrc string `json:"conn_id_src"`
Failure *string `json:"failure"`
Request *legacymodel.ArchivalMaybeBinaryData `json:"request"`
T float64 `json:"t"`
Responses []*SinglePingResponse `json:"responses"`
}
SinglePing is a result of a single ping operation.
type SinglePingResponse ¶
type SinglePingResponse struct {
Data *legacymodel.ArchivalMaybeBinaryData `json:"response_data"`
Failure *string `json:"failure"`
T float64 `json:"t"`
SupportedVersions []uint32 `json:"supported_versions"`
}
type Target ¶ added in v3.31.0
type Target struct {
// Config contains the configuration.
Config *Config
// URL is the input URL.
URL string
}
Target is a richer-input target that this experiment should measure.
func (*Target) Category ¶ added in v3.31.0
Category implements model.ExperimentTarget.
func (*Target) Country ¶ added in v3.31.0
Country implements model.ExperimentTarget.
func (*Target) Input ¶ added in v3.31.0
Input implements model.ExperimentTarget.
func (*Target) Options ¶ added in v3.31.0
Options implements model.ExperimentTarget.
func (*Target) String ¶ added in v3.31.0
String implements model.ExperimentTarget.
type TestKeys ¶
type TestKeys struct {
Domain string `json:"domain"`
Pings []*SinglePing `json:"pings"`
UnexpectedResponses []*SinglePingResponse `json:"unexpected_responses"`
Repetitions int64 `json:"repetitions"`
}
TestKeys contains the experiment results.