Skip to content

Commit

Permalink
adds doc string comments on read async
Browse files Browse the repository at this point in the history
  • Loading branch information
faiq committed Apr 18, 2016
1 parent 1271e42 commit c95371b
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions sdjournal/read.go
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,9 @@ process:
return
}

// FollowAsync asynchronously follows the JournalReader, writing each new journal entry to the provided receiving byte channel.
// The follow will continue until a single time.Time is received on the until channel.
// NOTE: The until channel, must be closed or this method will leak a Go routine
func (r *JournalReader) FollowAsync(until <-chan time.Time, recieve chan<- []byte) <-chan error {
errCh := make(chan error, 1)
go func() {
Expand Down

0 comments on commit c95371b

Please sign in to comment.