closepool

Documentation

Overview

Package closepool allows pooling io.Closer instances and closing them in a single operation.

Index

• type CloserFunc
  • func (fx CloserFunc) Close() error
• type Pool
  • func (p *Pool) Add(conn io.Closer)
  • func (p *Pool) Close() error

Types

type CloserFunc

type CloserFunc func() error

CloserFunc allows to turn a suitable function into an io.Closer.

func (CloserFunc) Close

func (fx CloserFunc) Close() error

Close implements io.Closer.

type Pool

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

Pool allows pooling a set of io.Closer.

The zero value is ready to use.

func (*Pool) Add

func (p *Pool) Add(conn io.Closer)

Add adds a given io.Closer to the pool.

func (*Pool) Close

func (p *Pool) Close() error

Close closes all the io.Closer inside the pool iterating in backward order. Therefore, if one registers a TCP connection and then the corresponding TLS connection, the TLS connection is closed first. The returned error is the join of all the errors that occurred when closing connections.