options.go

// Tideland Go Actor
//
// Copyright (C) 2019-2023 Frank Mueller / Tideland / Oldenburg / Germany
//
// All rights reserved. Use of this source code is governed
// by the new BSD license.

package actor // import "tideland.dev/go/actor"

//--------------------
// IMPORTS
//--------------------

import (
	"context"
)

//--------------------
// OPTIONS
//--------------------

// Option defines the signature of an option setting function.
type Option func(act *Actor) error

// WithContext sets the context for the actor.
func WithContext(ctx context.Context) Option {
	return func(act *Actor) error {
		act.ctx = ctx
		return nil
	}
}

// WithQueueCap defines the channel capacity for actions sent to an Actor.
func WithQueueCap(c int) Option {
	return func(act *Actor) error {
		if c < defaultQueueCap {
			c = defaultQueueCap
		}
		act.requests = make(chan *request, c)
		return nil
	}
}

// WithRecoverer sets a function for recovering from a panic
// during executing an action.
func WithRecoverer(recoverer Recoverer) Option {
	return func(act *Actor) error {
		act.recoverer = recoverer
		return nil
	}
}

// WithFinalizer sets a function for finalizing the
// work of a Loop.
func WithFinalizer(finalizer Finalizer) Option {
	return func(act *Actor) error {
		act.finalizer = finalizer
		return nil
	}
}

// EOF