Skip to content

Clarify that a blocked channel will discard results #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
codesoap wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify that a blocked channel will discard results #129

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,19 +65,21 @@ func DefaultParams(service string) *QueryParam {
}
}

// Query looks up a given service, in a domain, waiting at most
// for a timeout before finishing the query. The results are streamed
// to a channel. Sends will not block, so clients should make sure to
// either read or buffer.
// Query looks up a given service, in a domain, waiting at most for
// a timeout before finishing the query. The results are sent to the
// params.Entries channel. If a result cannot be sent to params.Entries
// immediately, it will be discarded. A large buffer on the channel can
// ensure that no result is lost.
func Query(params *QueryParam) error {
return QueryContext(context.Background(), params)
}

// QueryContext looks up a given service, in a domain, waiting at most
// for a timeout before finishing the query. The results are streamed
// to a channel. Sends will not block, so clients should make sure to
// either read or buffer. QueryContext will attempt to stop the query
// on cancellation.
// for a timeout before finishing the query. The results are sent to the
// params.Entries channel. If a result cannot be sent to params.Entries
// immediately, it will be discarded. A large buffer on the channel can
// ensure that no result is lost. QueryContext will attempt to stop the
// query on cancellation.
func QueryContext(ctx context.Context, params *QueryParam) error {
if params.Logger == nil {
params.Logger = log.Default()
Expand Down