doc.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 supports the simple creation of concurrent applications
// following the idea of actor models. The work to be done has to be defined
// as func() inside your public methods or functions and sent to the actor
// running in the background.
//
//		type Counter struct {
//			counter int
//			act     *actor.Actor
//		}
//
//		func NewCounter() (*Counter, error) {
//			act, err := actor.Go()
//			if err != nil {
//				return nil, err
//			}
//			c := &Counter{
//				counter: 0,
//				act:     act,
//			}
//		    // Increment the counter every second.
//			interval := 1 * time.Second
//	    	c.act.Repeat(interval, func() {
//	        	c.counter++
//	    	})
//			return c, nil
//		}
//
//		func (c *Counter) Incr() error {
//			return c.act.DoAsync(func() {
//				c.counter++
//			})
//		}
//
//		func (c *Counter) Get() (int, error) {
//			var counter int
//			if err := c.act.DoSync(func() {
//				counter = c.counter
//			}); err != nil {
//				return 0, err
//			}
//			return counter, nil
//		}
//
//		func (c *Counter) Stop() {
//			c.act.Stop()
//		}
//
// The options for the constructor allow to pass a context for the Actor, the capacity
// of the Action queue, a recoverer function in case of an Action panic and a finalizer
// function when the Actor stops.
package actor // import "tideland.dev/go/actor"

// EOF