ctxconn

Documentation

Overview

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

Index

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

Types

type CancelFunc

type CancelFunc func()

CancelFunc can be used to shut down context watchers. It is safe to call the cancel function multiple times.

func CloseConnOnDone

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

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. Calling this function does not guarantee that the connection has been closed. It is not safe to call the returned function multiple times at the same time.

type DeadlineCloser

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