ctxconn

Documentation

Overview

Package ctxconn provides a helper function to track context cancellation when working with connections.

Index

• func CloseConnOnDone(ctx context.Context, conn DeadlineCloser) func() error
• type DeadlineCloser

Functions

func CloseConnOnDone

func CloseConnOnDone(ctx context.Context, conn DeadlineCloser) func() error

CloseConnOnDone closes conn whenever ctx is Done. This includes if ctx is canceled via its cancellation function.

Call the returned cancellation function to free up resources and closing the connection. The cancellation function returns any error from closing the connection.

Types

type DeadlineCloser

type DeadlineCloser interface {
	SetDeadline(t time.Time) error
	io.Closer
}