package taskloop

Import Path
	github.com/pion/ice/v4/internal/taskloop (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	  d taskloop.go
		Package taskloop implements a task loop to run
		tasks sequentially in a separate Goroutine.
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Loop (struct)
		Loop runs submitted task serially in a dedicated Goroutine.

		Methods (total 6)
			(*Loop) Close()
				Close stops the loop after finishing the execution of the current task.
				Other pending tasks will not be executed.

			(*Loop) Deadline() (deadline time.Time, ok bool)
				Deadline returns the no valid time as task loops have no deadline.

			(*Loop) Done() <-chan struct{}
				Done returns a channel that's closed when the task loop has been stopped.

			(*Loop) Err() error
				Err returns nil if the task loop is still running.
				Otherwise it return errClosed if the loop has been closed/stopped.

			(*Loop) Run(ctx context.Context, t func(context.Context)) error
				Run serially executes the submitted callback.
				Blocking tasks must be cancelable by context.

			(*Loop) Value(interface{}) interface{}
				Value is not supported for task loops.

		Implements (at least one exported)
			*Loop : context.Context
		As Outputs Of (at least one exported)
			func New(onClose func()) *Loop


Package-Level Functions (only one)

	 func New(onClose func()) *Loop
		New creates and starts a new task loop.


Package-Level Variables (only one)

	  var ErrClosed error
		ErrClosed indicates that the loop has been stopped.

The pages are generated with Golds v0.8.2. (GOOS=linux 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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.