timeoutreader

Documentation

Index

• Variables
• type TimeoutReader
  • func NewTimeoutReader(reader io.ReadCloser, timeout time.Duration, closeOnTimeout bool) *TimeoutReader
  • func NewTimeoutReaderSize(reader io.ReadCloser, timeout time.Duration, closeOnTimeout bool, ...) *TimeoutReader
  • func (tr *TimeoutReader) Close() (err error)
  • func (tr *TimeoutReader) Read(p []byte) (int, error)

Variables

var ErrReadTimeout = errors.New("read timed out")

ErrReadTimeout is the error used when a read times out before completing.

Types

type TimeoutReader

type TimeoutReader struct {
	// contains filtered or unexported fields
}

An io.ReadCloser that has a timeout for each underlying Read() function and optionally closes the underlying Reader on timeout.

func NewTimeoutReader

func NewTimeoutReader(reader io.ReadCloser, timeout time.Duration, closeOnTimeout bool) *TimeoutReader

Create a new TimeoutReader.

func NewTimeoutReaderSize

func NewTimeoutReaderSize(reader io.ReadCloser, timeout time.Duration, closeOnTimeout bool, maxReadSize int) *TimeoutReader

func (*TimeoutReader) Close

func (tr *TimeoutReader) Close() (err error)

Closes the TimeoutReader. Also closes the underlying Reader if it was not closed already at timeout.

func (*TimeoutReader) Read

func (tr *TimeoutReader) Read(p []byte) (int, error)

Read from the underlying reader. If the underlying Read() does not return within the timeout, ErrReadTimeout is returned.