1
0
mirror of https://github.com/golang/go synced 2024-11-23 21:50:08 -07:00

Updated Pusher.Push() source documentation

This will clarify that the resources are not completely pushed yet when `Push` returns.
This commit is contained in:
Eduard Urbach 2018-04-24 00:20:19 +02:00 committed by GitHub
parent 22115859a5
commit 1f46eb9a08
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -135,6 +135,10 @@ type Pusher interface {
// data that may trigger a request for URL X. This avoids a race where the
// client issues requests for X before receiving the PUSH_PROMISE for X.
//
// Push will run in a separate goroutine making the order of arrival
// non-deterministic. Any required synchronization needs to be implemented
// by the caller.
//
// Push returns ErrNotSupported if the client has disabled push or if push
// is not supported on the underlying connection.
Push(target string, opts *PushOptions) error