github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Clean up client Subscribe docs; remove a typo

Browse Source 
Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
This commit is contained in:
Phil Estes 2018-02-15 17:14:06 -05:00
parent aa82d17d1d
commit 18be82118d
No known key found for this signature in database
GPG Key ID: 0F386284C03A1162
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
client.go
View File

@ -338,11 +338,11 @@ func (c *Client) ListImages(ctx context.Context, filters ...string) ([]Image, er
// Subscribe to events that match one or more of the provided filters. // Subscribe to events that match one or more of the provided filters.
// //
// Callers should listen on both the envelope channel and errs channel. If the // Callers should listen on both the envelope and errs channels. If the errs
// errs channel returns nil or an error, the subscriber should terminate. // channel returns nil or an error, the subscriber should terminate.
// //
// To cancel shutdown reciept of events, cancel the provided context. The errs // The subscriber can stop receiving events by canceling the provided context.
// channel will be closed and return a nil error. // The errs channel will be closed and return a nil error.
func (c *Client) Subscribe(ctx context.Context, filters ...string) (ch <-chan *eventsapi.Envelope, errs <-chan error) { func (c *Client) Subscribe(ctx context.Context, filters ...string) (ch <-chan *eventsapi.Envelope, errs <-chan error) {
var ( var (
evq = make(chan *eventsapi.Envelope) evq = make(chan *eventsapi.Envelope)