diode

Documentation

Index

• type Alerter
• type Writer
  • func NewWriter(w io.Writer, size int, poolInterval time.Duration, f Alerter) *Writer
  • func (dw *Writer) Close() error
  • func (dw *Writer) Write(p []byte) (n int, err error)

Types

type Alerter

type Alerter func(missed int)

type Writer

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

Writer is a io.Writer wrapper that uses a diode to make Write lock-free, non-blocking and thread safe.

func NewWriter

func NewWriter(w io.Writer, size int, poolInterval time.Duration, f Alerter) *Writer

NewWriter creates a writer wrapping w with a many-to-one diode in order to never block the producers and drop writes if the underlying writer can't keep up with the flow of data.

Use a diode.Writer when

wr := diode.NewWriter(w, 1000, 0, func(missed int) {
    log.Printf("Dropped %d writes", missed)
})
wr.Write([]byte("Hello, World!"))

If pollInterval is greater than 0, a poller is used otherwise a waiter is used.

See code.cloudfoundry.org/go-diodes for more info on diode.

func (*Writer) Close

func (dw *Writer) Close() error

Close releases the diode poller and call Close on the wrapped writer if io.Closer is implemented.

func (*Writer) Write

func (dw *Writer) Write(p []byte) (n int, err error)