httpc

Documentation

Overview

Package httpc sends requests built from core domain types and captures per-phase timings via httptrace. It has no TUI dependencies.

Index

• type Event
• type Response
  • func Send(ctx context.Context, req *core.Request) (*Response, error)
  • func (r *Response) Size() int
• type Timings

Types

type Event

type Event struct {
	Name string
	At   time.Duration
	Took time.Duration
}

Event is one httptrace point: when it happened relative to the request start, and how long the phase it closes took (zero for instants).

type Response

type Response struct {
	Status     string
	StatusCode int
	Proto      string
	Headers    http.Header
	Body       []byte
	// Truncated is set when the body exceeded the in-memory cap.
	Truncated bool
	Timings   Timings
}

func Send

func Send(ctx context.Context, req *core.Request) (*Response, error)

Send honors context cancellation at any phase, including body download.

func (*Response) Size

func (r *Response) Size() int

type Timings

type Timings struct {
	DNS     time.Duration
	Connect time.Duration
	TLS     time.Duration
	// TTFB is measured from the start of the round trip to the first
	// response byte.
	TTFB  time.Duration
	Total time.Duration

	// Events are the trace points in order, each offset from the start of
	// the round trip, so a caller can draw a waterfall rather than a set of
	// bars that all begin at zero.
	Events []Event
}

Timings leaves phases that did not happen (e.g. reused connection, plain HTTP) at zero.