httpwire

package
v0.10.0-dev.31 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 6, 2026 License: AGPL-3.0 Imports: 7 Imported by: 0

Documentation

Overview

Package httpwire holds subflux's own HTTP wire policy: the byte bounds it will read from a peer, and the vocabulary it classifies a peer's response with. Behavioural logic is delegated to github.com/cplieger/go/httpclient; what stays here is application-specific — the caps, the User-Agent, and the thin adapters bridging httpclient error types to the internal subflux.* errors.

Named for the wire rather than as an httputil: the bounds and the classification are one concern (every export is about reading a response safely — the caps bound it, CheckHTTPStatus/IsTransient/ParseRetryAfter/ LimitedBody judge it), so splitting them would put a cap in one package and the reader that applies it in another. Most consumers are providers, but search, manualops and synchandlers read the caps too, which is why the name is not provider-specific.

Index

Constants

View Source
const ContentTypeJSON = "application/json"

ContentTypeJSON is the MIME type for JSON request/response bodies.

View Source
const HeaderContentType = "Content-Type"

HeaderContentType is the canonical HTTP header name for content type.

View Source
const MaxDownloadBytes = 10 << 20

MaxDownloadBytes is the maximum response body size for subtitle/archive downloads (10 MB).

View Source
const MaxErrorBodyBytes = 1 << 20

MaxErrorBodyBytes is the maximum size for reading error response bodies (1 MB).

View Source
const MaxJSONResponseBytes = 5 << 20

MaxJSONResponseBytes is the maximum size for a JSON API response body (5 MB).

View Source
const MaxListResponseBytes = 2 << 20

MaxListResponseBytes is the maximum size for a list/detail JSON response (2 MB).

View Source
const MaxSearchResponseBytes = 1 << 20

MaxSearchResponseBytes is the maximum size for a search/lookup JSON response (1 MB).

View Source
const MaxSingleSubtitleBytes = 5 << 20

MaxSingleSubtitleBytes is the maximum size for a single subtitle file download (5 MB).

View Source
const UserAgent = "Subflux/1.0"

UserAgent is the default User-Agent header sent by all providers.

Variables

This section is empty.

Functions

func CheckHTTPStatus

func CheckHTTPStatus(resp *http.Response) error

CheckHTTPStatus returns nil for a 2xx, *subflux.AuthError for a 401 or 403, *subflux.RateLimitError for a 429 and *HTTPStatusError for any other code.

func IsTransient

func IsTransient(err error) bool

IsTransient returns true for errors likely caused by temporary server or network issues worth retrying. Bridges subflux.AuthError and subflux.RateLimitError exclusion with httpclient.IsTransient for network checks.

func LimitedBody

func LimitedBody(resp *http.Response) io.ReadCloser

LimitedBody wraps resp.Body with a read cap while preserving Close.

func ParseRetryAfter

func ParseRetryAfter(resp *http.Response) time.Duration

ParseRetryAfter parses the Retry-After header from a response. Delegates to httpclient.ParseRetryAfterResponse (uncapped, matching original behavior).

func RetryOnRateLimit

func RetryOnRateLimit(ctx context.Context, maxAttempts int, maxWait time.Duration, fn func() error) error

RetryOnRateLimit retries fn up to maxAttempts times when it returns a *subflux.RateLimitError. It hands that error to httpclient's rate-limit-only retry mode (httpclient's Do + WithRateLimitOnly) as the 429 *httpclient.StatusError the mode matches: only rate limits are retried, waiting min(hint, maxWait), and every other error, transient included, returns immediately (transient retry is the caller's outer wrapper's job). Once the attempts run out, the caller gets fn's own *subflux.RateLimitError.

Types

type HTTPStatusError

type HTTPStatusError = httpclient.StatusError

HTTPStatusError represents a non-2xx HTTP response that is not already covered by a more specific typed error. Delegates to httpclient.StatusError.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL