webconnectivity

Documentation

Index

• func DNSDo(ctx context.Context, config *DNSConfig)
• func HTTPDo(ctx context.Context, config *HTTPConfig)
• func TCPDo(ctx context.Context, config *TCPConfig)
• type CtrlDNSResult
• type CtrlHTTPResponse
• type CtrlRequest
• type CtrlResponse
  • func Measure(ctx context.Context, config MeasureConfig, creq *CtrlRequest) (*CtrlResponse, error)
• type CtrlTCPResult
• type DNSConfig
• type HTTPConfig
• type Handler
  • func (h Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type MeasureConfig
• type TCPConfig
• type TCPResultPair

Functions

func DNSDo

func DNSDo(ctx context.Context, config *DNSConfig)

DNSDo performs the DNS check.

func HTTPDo

func HTTPDo(ctx context.Context, config *HTTPConfig)

HTTPDo performs the HTTP check.

func TCPDo

func TCPDo(ctx context.Context, config *TCPConfig)

TCPDo performs the TCP check.

Types

type CtrlDNSResult

type CtrlDNSResult = webconnectivity.ControlDNSResult

CtrlDNSResult is the result of the DNS check performed by the Web Connectivity test helper.

type CtrlHTTPResponse

type CtrlHTTPResponse = webconnectivity.ControlHTTPRequestResult

CtrlHTTPResponse is the result of the HTTP check performed by the Web Connectivity test helper.

type CtrlRequest

type CtrlRequest = webconnectivity.ControlRequest

CtrlRequest is the request sent to the test helper

type CtrlResponse

type CtrlResponse = webconnectivity.ControlResponse

CtrlResponse is the response from the test helper

func Measure

func Measure(ctx context.Context, config MeasureConfig, creq *CtrlRequest) (*CtrlResponse, error)

Measure performs the measurement described by the request and returns the corresponding response or an error.

type CtrlTCPResult

type CtrlTCPResult = webconnectivity.ControlTCPConnectResult

CtrlTCPResult is the result of the TCP check performed by the test helper.

type DNSConfig

type DNSConfig struct {
	Domain   string
	Out      chan CtrlDNSResult
	Resolver model.Resolver
	Wg       *sync.WaitGroup
}

DNSConfig configures the DNS check.

type HTTPConfig

type HTTPConfig struct {
	Client            *http.Client
	Headers           map[string][]string
	MaxAcceptableBody int64
	Out               chan CtrlHTTPResponse
	URL               string
	Wg                *sync.WaitGroup
}

HTTPConfig configures the HTTP check.

type Handler

type Handler struct {
	Client            *http.Client
	Dialer            model.Dialer
	MaxAcceptableBody int64
	Resolver          model.Resolver
}

Handler implements the Web Connectivity test helper HTTP API.

func (Handler) ServeHTTP

func (h Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)

type MeasureConfig

type MeasureConfig struct {
	Client            *http.Client
	Dialer            model.Dialer
	MaxAcceptableBody int64
	Resolver          model.Resolver
}

MeasureConfig contains configuration for Measure.

type TCPConfig

type TCPConfig struct {
	Dialer   model.Dialer
	Endpoint string
	Out      chan TCPResultPair
	Wg       *sync.WaitGroup
}

TCPConfig configures the TCP connect check.

type TCPResultPair

type TCPResultPair struct {
	Endpoint string
	Result   CtrlTCPResult
}

TCPResultPair contains the endpoint and the corresponding result.