package ctxwatch

Import Path
	github.com/jackc/pgconn/internal/ctxwatch (on go.dev)

Dependency Relation
	imports one package, and imported by one package

Involved Source Files

	      context_watcher.go
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type ContextWatcher (struct)
		ContextWatcher watches a context and performs an action when the context is canceled. It can watch one context at a
		time.

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			onCancel func()
			onCancelWasCalled bool
			onUnwatchAfterCancel func()
			unwatchChan chan struct{}
			watchInProgress bool
		Methods (total 2, both are exported)
			(*T) Unwatch()
				Unwatch stops watching the previously watched context. If the onCancel function passed to NewContextWatcher was
				called then onUnwatchAfterCancel will also be called.

			(*T) Watch(ctx context.Context)
				Watch starts watching ctx. If ctx is canceled then the onCancel function passed to NewContextWatcher will be called.

		As Outputs Of (at least one exported)
			func NewContextWatcher(onCancel func(), onUnwatchAfterCancel func()) *ContextWatcher


Package-Level Functions (only one, which is exported)

	 func NewContextWatcher(onCancel func(), onUnwatchAfterCancel func()) *ContextWatcher
		NewContextWatcher returns a ContextWatcher. onCancel will be called when a watched context is canceled.
		OnUnwatchAfterCancel will be called when Unwatch is called and the watched context had already been canceled and
		onCancel called.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.