thread

Documentation

Index

• type NoopThread
  • func NewNoopThread() *NoopThread
  • func (t *NoopThread) Call(f func())
  • func (t *NoopThread) CallAsync(f func())
  • func (t *NoopThread) Loop(ctx context.Context) error
• type OSThread
  • func NewOSThread() *OSThread
  • func (t *OSThread) Call(f func())
  • func (t *OSThread) CallAsync(f func())
  • func (t *OSThread) Loop(ctx context.Context) error
• type Thread

Types

type NoopThread

type NoopThread struct{}

NoopThread is used to disable threading.

func NewNoopThread

func NewNoopThread() *NoopThread

NewNoopThread creates a new thread that does no threading.

func (*NoopThread) Call

func (t *NoopThread) Call(f func())

Call executes the func immediately.

func (*NoopThread) CallAsync

func (t *NoopThread) CallAsync(f func())

CallAsync executes the func immediately.

func (*NoopThread) Loop

func (t *NoopThread) Loop(ctx context.Context) error

Loop does nothing.

type OSThread

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

OSThread represents an OS thread.

func NewOSThread

func NewOSThread() *OSThread

NewOSThread creates a new thread.

func (*OSThread) Call

func (t *OSThread) Call(f func())

Call calls f on the thread.

Do not call Call from the same thread. Call would block forever.

Call blocks if Loop is not called.

func (*OSThread) CallAsync

func (t *OSThread) CallAsync(f func())

CallAsync tries to queue f. CallAsync returns immediately if f can be queued. CallAsync blocks if f cannot be queued.

Do not call CallAsync from the same thread. CallAsync would block forever.

func (*OSThread) Loop

func (t *OSThread) Loop(ctx context.Context) error

Loop starts the thread loop until Stop is called on the current OS thread.

Loop returns ctx's error if exists.

Loop must be called on the OS thread.

type Thread

type Thread interface {
	Loop(ctx context.Context) error
	Call(f func())
	CallAsync(f func())
	// contains filtered or unexported methods
}