eosswedenorg/thalos
1
0
Fork 0
mirror of https://github.com/eosswedenorg/thalos synced 2026-06-16 04:24:56 +02:00
Code Releases Activity

api/reader.go: Document io.EOF

Browse source
This commit is contained in:
Henrik Hautakoski 2024-02-07 17:30:19 +01:00
parent d789b6a294
commit daa89cf372
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
api/reader.go
View file

@ -8,10 +8,13 @@ type Reader interface {
// Read a message from a channel.
// Read may block until a message is ready or an error occured.
//
// io.EOF is returned from a reader when there is no more data to be read.
// If Read returns io.EOF all subsequent calls must also return io.EOF
//
// This function should be designed to handle concurrent calls. eg. thread safe.
Read(channel Channel) ([]byte, error)
// Close closes the reader
// Any blocked Read operations will be unblocked.
// Any blocked Read operations will be unblocked and return io.EOF
Close() error
}