docs: define ServeWithTimeout timing contract - #256
Merged
Conversation
Document the supported whole-second duration domain, approximate retirement before WebSocket processing, and direct per-ping timeout behavior. Align related API and README terminology. Closes #248
State the exact supported timeout range and activity markers. Keep exported docs caller-facing while moving implementation terminology out of the rendered API contract.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ServeWithTimeout, fromtime.Secondthrough 2,147,483,646 secondsRequest.ServeHTTPfrom the duration passed directly to active keepalive pingsNewRequest, successfulUseRequest, andRequest.MarkWrittenCloses #248
Verification
go doc github.com/linkdata/jaws Jaws.ServeWithTimeoutgo doc github.com/linkdata/jaws Request.MarkWrittengo doc github.com/linkdata/jaws Jaws.UseRequestgo generate ./...go vet ./...gofmt -l .gofumpt -l .staticcheck ./...golangci-lint rungosec ./...JAWS_REQUIRE_NODE=1 go test -race -coverprofile=coverage.out ./...JAWS_REQUIRE_NODE=1 go test ./...go build -v ./...GOOS=linux GOARCH=386 CGO_ENABLED=0 go test -exec=/usr/bin/true ./lib/bind/...