actor

package
v0.0.0-...-013e33d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 20, 2018 License: MIT Imports: 18 Imported by: 0

Documentation

Overview

Package actor declares the types used to represent actors in the Actor Model.

The actors model provide a high level abstraction for writing concurrent and distributed systems. This approach simplifies the burden imposed on engineers, such as explicit locks and concurrent access to shared state, as actors receive messages synchronously.

The following quote from Wikipedia distills the definition of an actor down to its essence

In response to a message that it receives, an actor can: make local decisions, create more actors,
send more messages, and determine how to respond to the next message received.

Creating Actors

Props provide the building blocks for declaring how actors should be created. The following example defines an actor using a function literal to process messages:

var props Props = actor.FromFunc(func(c Context) {
	// process messages
})

Alternatively, a type which conforms to the Actor interface, by defining a single Receive method, can be used.

type MyActor struct {}

func (a *MyActor) Receive(c Context) {
	// process messages
}

var props Props = actor.FromInstance(&MyActor{})

Spawn and SpawnNamed use the given props to create a running instances of an actor. Once spawned, the actor is ready to process incoming messages. To spawn an actor with a unique name, use

pid := actor.Spawn(props)

The result of calling Spawn is a unique PID or process identifier.

Each time an actor is spawned, a new mailbox is created and associated with the PID. Messages are sent to the mailbox and then forwarded to the actor to process.

Processing Messages

An actor processes messages via its Receive handler. The signature of this function is:

Receive(c actor.Context)

The actor system guarantees that this method is called synchronously, therefore there is no requirement to protect shared state inside calls to this function. See the caution above

CAUTION: whilst spawning multiple actors from the same Props will have their own private mailbox, using FromInstance or FromFunc will reference the same instance or function and therefore should not modify shared state. Use FromProducer, which accepts a function that produces new Actor instances:

var props Props = actor.FromProducer(func() actor.Actor { return &MyActor{} })

Communicating With Actors

A PID is the primary interface for sending messages to actors. The PID.Tell method is used to send an asynchronous message to the actor associated with the PID:

pid.Tell("Hello World")

Depending on the requirements, communication between actors can take place synchronously or asynchronously. Regardless of the circumstances, actors always communicate via a PID.

When sending a message using PID.Request or PID.RequestFuture, the actor which receives the message will respond using the Context.Sender method, which returns the PID of of the sender.

For synchronous communication, an actor will use a Future and wait for the result before continuing. To send a message to an actor and wait for a response, use the RequestFuture method, which returns a Future:

f := actor.RequestFuture(pid,"Hello", 50 * time.Millisecond)
res, err := f.Result() // waits for pid to reply

Index

Examples

Constants

View Source
const PH = 1

Variables

View Source
var (
	ErrInvalidLengthProtos = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowProtos   = fmt.Errorf("proto: integer overflow")
)
View Source
var ErrNameExists = errors.New("spawn: name exists")

ErrNameExists is the error used when an existing name is used for spawning an actor.

View Source
var ErrTimeout = errors.New("future: timeout")

ErrTimeout is the error used when a future times out before receiving a result.

View Source
var ProcessRegistry = &ProcessRegistryValue{
	Address:   localAddress,
	LocalPIDs: cmap.New(),
}

ProcessRegistry is a registry of all active processes.

NOTE: This should only be used for advanced scenarios

Functions

func Request

func Request(pid *PID, message interface{}, respondTo *PID)

Request sends a messages asynchronously to the PID. The actor may send a response back via respondTo, which is available to the receiving actor via Context.Sender

func SetLogger

func SetLogger(l mylog.ILogger)

func SetOptions

func SetOptions(opts ...optionFn)

SetOptions is used to configure the actor system

func StopActor

func StopActor(pid *PID)

Stop the given PID

func StopGraceful

func StopGraceful(pid *PID, timeout time.Duration)

func Tell

func Tell(pid *PID, message interface{})

Tell sends a messages asynchronously to the PID

func WithDeadLetterSubscriber

func WithDeadLetterSubscriber(fn func(evt interface{})) optionFn

WithDeadLetterSubscriber option replaces the default DeadLetterEvent event subscriber with fn.

fn will only receive *DeadLetterEvent messages

Specifying nil will clear the existing.

func WithSupervisorSubscriber

func WithSupervisorSubscriber(fn func(evt interface{})) optionFn

WithSupervisorSubscriber option replaces the default SupervisorEvent event subscriber with fn.

fn will only receive *SupervisorEvent messages

Specifying nil will clear the existing.

Types

type Actor

type Actor interface {
	Receive(c Context)
}

Actor is the interface that defines the Receive method.

Receive is sent messages to be processed from the mailbox associated with the instance of the actor

type ActorFunc

type ActorFunc func(c Context)

The ActorFunc type is an adapter to allow the use of ordinary functions as actors to process messages

func (ActorFunc) Receive

func (f ActorFunc) Receive(c Context)

Receive calls f(c)

type AddressResolver

type AddressResolver func(*PID) (Process, bool)

An AddressResolver is used to resolve remote actors

type AutoReceiveMessage

type AutoReceiveMessage interface {
	AutoReceiveMessage()
}

An AutoReceiveMessage is a special kind of user message that will be handled in some way automatially by the actor

type Context

type Context interface {
	// Watch registers the actor as a monitor for the specified PID
	Watch(pid *PID)

	// Unwatch unregisters the actor as a monitor for the specified PID
	Unwatch(pid *PID)

	// Message returns the current message to be processed
	Message() interface{}

	// Sender returns the PID of actor that sent currently processed message
	Sender() *PID

	//MessageHeader returns the meta information for the currently processed message
	MessageHeader() ReadonlyMessageHeader

	//Tell sends a message to the given PID
	Tell(pid *PID, message interface{})

	//Request sends a message to the given PID and also provides a Sender PID
	Request(pid *PID, message interface{})

	// RequestFuture sends a message to a given PID and returns a Future
	RequestFuture(pid *PID, message interface{}, timeout time.Duration) *Future

	// SetReceiveTimeout sets the inactivity timeout, after which a ReceiveTimeout message will be sent to the actor.
	// A duration of less than 1ms will disable the inactivity timer.
	//
	// If a message is received before the duration d, the timer will be reset. If the message conforms to
	// the NotInfluenceReceiveTimeout interface, the timer will not be reset
	SetReceiveTimeout(d time.Duration)

	// ReceiveTimeout returns the current timeout
	ReceiveTimeout() time.Duration

	// SetBehavior replaces the actors current behavior stack with the new behavior
	SetBehavior(behavior ActorFunc)

	// PushBehavior pushes the current behavior on the stack and sets the current Receive handler to the new behavior
	PushBehavior(behavior ActorFunc)

	// PopBehavior reverts to the previous Receive handler
	PopBehavior()

	// Self returns the PID for the current actor
	Self() *PID

	// Parent returns the PID for the current actors parent
	Parent() *PID

	// Spawn starts a new child actor based on props and named with a unique id
	Spawn(props *Props) *PID

	// SpawnPrefix starts a new child actor based on props and named using a prefix followed by a unique id
	SpawnPrefix(props *Props, prefix string) *PID

	// SpawnNamed starts a new child actor based on props and named using the specified name
	//
	// ErrNameExists will be returned if id already exists
	SpawnNamed(props *Props, id string) (*PID, error)

	// Returns a slice of the actors children
	Children() []*PID

	// Returns a map of the actors children, the key is child pid id
	ChildrenMap() map[string]*PID

	// Stash stashes the current message on a stack for reprocessing when the actor restarts
	Stash()

	// Respond sends a response to the to the current `Sender`
	//
	// If the Sender is nil, the actor will panic
	Respond(response interface{})

	// Actor returns the actor associated with this context
	Actor() Actor

	AwaitFuture(f *Future, continuation func(res interface{}, err error))
}

Context contains contextual information for actors

Example (SetBehavior)

SetBehavior allows an actor to change its Receive handler, providing basic support for state machines

package main

import (
	"fmt"
	"sync"

	"gitee.com/lwj8507/light-protoactor-go/actor"
)

type setBehaviorActor struct {
	sync.WaitGroup
}

// Receive is the default message handler when an actor is started
func (f *setBehaviorActor) Receive(context actor.Context) {
	if msg, ok := context.Message().(string); ok && msg == "other" {
		// Change actor's receive message handler to Other
		context.SetBehavior(f.Other)
	}
}

func (f *setBehaviorActor) Other(context actor.Context) {
	if msg, ok := context.Message().(string); ok && msg == "foo" {
		fmt.Println(msg)
		f.Done()
	}
}

// SetBehavior allows an actor to change its Receive handler, providing basic support for state machines
func main() {
	a := &setBehaviorActor{}
	a.Add(1)
	pid := actor.Spawn(actor.FromInstance(a))
	defer actor.StopActor(pid)

	actor.Tell(pid, "other")
	actor.Tell(pid, "foo")
	a.Wait()

}
Output:

foo
Example (SetReceiveTimeout)

SetReceiveTimeout allows an actor to be notified repeatedly if it does not receive any messages for a specified duration

package main

import (
	"fmt"
	"sync"
	"time"

	"gitee.com/lwj8507/light-protoactor-go/actor"
)

type setReceiveTimeoutActor struct {
	sync.WaitGroup
}

// Receive is the default message handler when an actor is started
func (f *setReceiveTimeoutActor) Receive(context actor.Context) {
	switch context.Message().(type) {

	case *actor.Started:
		// when the actor starts, set the receive timeout to 10 milliseconds.
		//
		// the system will send an *actor.ReceiveTimeout message every time the timeout
		// expires until SetReceiveTimeout is called again with a duration < 1 ms
		context.SetReceiveTimeout(10 * time.Millisecond)

	case *actor.ReceiveTimeout:
		fmt.Println("timed out")
		f.Done()
	}
}

// SetReceiveTimeout allows an actor to be notified repeatedly if it does not receive any messages
// for a specified duration
func main() {
	a := &setReceiveTimeoutActor{}
	a.Add(1)

	pid := actor.Spawn(actor.FromInstance(a))
	defer actor.StopActor(pid)

	a.Wait() // wait for the ReceiveTimeout message

}
Output:

timed out

type DeadLetterEvent

type DeadLetterEvent struct {
	PID     *PID        // The invalid process, to which the message was sent
	Message interface{} // The message that could not be delivered
	Sender  *PID        // the process that sent the Message
}

A DeadLetterEvent is published via event.Publish when a message is sent to a nonexistent PID

type DeciderFunc

type DeciderFunc func(reason interface{}) Directive

DeciderFunc is a function which is called by a SupervisorStrategy

type Directive

type Directive int

Directive is an enum for supervision actions

const (
	// ResumeDirective instructs the supervisor to resume the actor and continue processing messages
	ResumeDirective Directive = iota

	// RestartDirective instructs the supervisor to discard the actor, replacing it with a new instance,
	// before processing additional messages
	RestartDirective

	// StopDirective instructs the supervisor to stop the actor
	StopDirective

	// EscalateDirective instructs the supervisor to escalate handling of the failure to the actor's parent supervisor
	EscalateDirective
)

Directive determines how a supervisor should handle a faulting actor

func DefaultDecider

func DefaultDecider(_ interface{}) Directive

DefaultDecider is a decider that will always restart the failing child actor

func (Directive) String

func (i Directive) String() string

type ErrActorStopped

type ErrActorStopped struct {
}

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

func (ErrActorStopped) Error

func (ErrActorStopped) Error() string

type Failure

type Failure struct {
	Who          *PID
	Reason       interface{}
	RestartStats *RestartStatistics
	Message      interface{}
}

func (*Failure) SystemMessage

func (*Failure) SystemMessage()

type Future

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

func NewFuture

func NewFuture(d time.Duration) *Future

NewFuture creates and returns a new actor.Future with a timeout of duration d

func RequestFuture

func RequestFuture(pid *PID, message interface{}, timeout time.Duration) *Future

RequestFuture sends a message to a given PID and returns a Future

func StopFuture

func StopFuture(pid *PID, timeout time.Duration) *Future

func (*Future) PID

func (f *Future) PID() *PID

PID to the backing actor for the Future result

func (*Future) PipeTo

func (f *Future) PipeTo(pids ...*PID)

PipeTo forwards the result or error of the future to the specified pids

Example
package main

import (
	"fmt"
	"sync"
	"time"

	"gitee.com/lwj8507/light-protoactor-go/actor"
)

func main() {
	var wg sync.WaitGroup
	wg.Add(1)

	// test actor that will be the target of the future PipeTo
	pid := actor.Spawn(actor.FromFunc(func(ctx actor.Context) {
		// check if the message is a string and therefore
		// the "hello world" message piped from the future
		if m, ok := ctx.Message().(string); ok {
			fmt.Println(m)
			wg.Done()
		}
	}))

	f := actor.NewFuture(50 * time.Millisecond)
	f.PipeTo(pid)
	// resolve the future and pipe to waiting actor
	actor.Tell(f.PID(), "hello world")
	wg.Wait()

}
Output:

hello world

func (*Future) Result

func (f *Future) Result() (interface{}, error)

Result waits for the future to resolve

func (*Future) Wait

func (f *Future) Wait() error

type IWork

type IWork interface {
	Do(inputs ...interface{}) ([]interface{}, error)
}

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

type NotInfluenceReceiveTimeout

type NotInfluenceReceiveTimeout interface {
	NotInfluenceReceiveTimeout()
}

NotInfluenceReceiveTimeout messages will not reset the ReceiveTimeout timer of an actor that receives the message

type PID

type PID struct {
	Address string `protobuf:"bytes,1,opt,name=Address,proto3" json:"Address,omitempty"`
	Id      string `protobuf:"bytes,2,opt,name=Id,proto3" json:"Id,omitempty"`
	// contains filtered or unexported fields
}

func ClonePIDSlice

func ClonePIDSlice(dst []*PID, src []*PID) []*PID

func NewLocalPID

func NewLocalPID(id string) *PID

NewLocalPID returns a new instance of the PID struct with the address preset

func NewPID

func NewPID(address, id string) *PID

NewPID returns a new instance of the PID struct

func Spawn

func Spawn(props *Props) *PID

Spawn starts a new actor based on props and named with a unique id

Example

Spawn creates instances of actors, similar to 'new' or 'make' but for actors.

package main

import (
	"fmt"
	"sync"

	"gitee.com/lwj8507/light-protoactor-go/actor"
)

func main() {
	var wg sync.WaitGroup
	wg.Add(1)

	//define the actor props
	//props define the creation process of an actor
	props := actor.FromFunc(func(ctx actor.Context) {
		// check if the message is a *actor.Started message
		// this is the first message all actors get
		// actor.Started is received async and can be used
		// to initialize your actors initial state
		if _, ok := ctx.Message().(*actor.Started); ok {
			fmt.Println("hello world")
			wg.Done()
		}
	})

	// spawn the actor based on the props
	actor.Spawn(props)
	wg.Wait()
}
Output:

hello world

func SpawnNamed

func SpawnNamed(props *Props, name string) (*PID, error)

SpawnNamed starts a new actor based on props and named using the specified name

If name exists, error will be ErrNameExists

Example

Spawn creates instances of actors, similar to 'new' or 'make' but for actors.

package main

import (
	"fmt"
	"log"
	"sync"

	"gitee.com/lwj8507/light-protoactor-go/actor"
)

func main() {
	var wg sync.WaitGroup
	wg.Add(1)

	//define the actor props
	//props define the creation process of an actor
	props := actor.FromFunc(func(ctx actor.Context) {
		// check if the message is a *actor.Started message
		// this is the first message all actors get
		// actor.Started is received async and can be used
		// to initialize your actors initial state
		if _, ok := ctx.Message().(*actor.Started); ok {
			fmt.Println("hello world")
			wg.Done()
		}
	})

	// spawn the actor based on the props
	_, err := actor.SpawnNamed(props, "my-actor")
	if err != nil {
		log.Fatal("The actor name is already in use")
	}
	wg.Wait()
}
Output:

hello world

func SpawnPrefix

func SpawnPrefix(props *Props, prefix string) (*PID, error)

SpawnPrefix starts a new actor based on props and named using a prefix followed by a unique id

func (PID) Clone

func (m PID) Clone() *PID

func (*PID) Descriptor

func (*PID) Descriptor() ([]byte, []int)

func (*PID) Equal

func (this *PID) Equal(that interface{}) bool

func (*PID) Marshal

func (m *PID) Marshal() (dAtA []byte, err error)

func (*PID) MarshalTo

func (m *PID) MarshalTo(dAtA []byte) (int, error)

func (*PID) ProtoMessage

func (*PID) ProtoMessage()

func (*PID) Reset

func (m *PID) Reset()

func (*PID) ResetEx

func (m *PID) ResetEx()

func (*PID) Size

func (m *PID) Size() (n int)

func (*PID) String

func (pid *PID) String() string

func (*PID) Unmarshal

func (m *PID) Unmarshal(dAtA []byte) error

type PIDSet

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

func NewPIDSet

func NewPIDSet(pids ...*PID) *PIDSet

NewPIDSet returns a new PIDSet with the given pids.

func (*PIDSet) Add

func (p *PIDSet) Add(v *PID)

Add adds the element v to the set

func (*PIDSet) Clear

func (p *PIDSet) Clear()

Clear removes all the elements in the set

func (*PIDSet) Contains

func (p *PIDSet) Contains(v *PID) bool

Contains reports whether v is an element of the set

func (*PIDSet) Empty

func (p *PIDSet) Empty() bool

Empty reports whether the set is empty

func (*PIDSet) ForEach

func (p *PIDSet) ForEach(f func(i int, pid PID))

ForEach invokes f for every element of the set

func (*PIDSet) Len

func (p *PIDSet) Len() int

Len returns the number of elements in the set

func (*PIDSet) Remove

func (p *PIDSet) Remove(v *PID) bool

Remove removes v from the set and returns true if them element existed

func (*PIDSet) Values

func (p *PIDSet) Values() []PID

Values returns all the elements of the set as a slice

type PoisonPill

type PoisonPill struct {
}

user messages

func (*PoisonPill) AutoReceiveMessage

func (*PoisonPill) AutoReceiveMessage()

func (*PoisonPill) Descriptor

func (*PoisonPill) Descriptor() ([]byte, []int)

func (*PoisonPill) Equal

func (this *PoisonPill) Equal(that interface{}) bool

func (*PoisonPill) Marshal

func (m *PoisonPill) Marshal() (dAtA []byte, err error)

func (*PoisonPill) MarshalTo

func (m *PoisonPill) MarshalTo(dAtA []byte) (int, error)

func (*PoisonPill) ProtoMessage

func (*PoisonPill) ProtoMessage()

func (*PoisonPill) Reset

func (m *PoisonPill) Reset()

func (*PoisonPill) Size

func (m *PoisonPill) Size() (n int)

func (*PoisonPill) String

func (this *PoisonPill) String() string

func (*PoisonPill) Unmarshal

func (m *PoisonPill) Unmarshal(dAtA []byte) error

type Process

type Process interface {
	SendUserMessage(pid *PID, message interface{}, sender *PID)
	SendSystemMessage(pid *PID, message interface{})
	Stop(pid *PID)
}

A Process is an interface that defines the base contract for interaction of actors

type ProcessRegistryValue

type ProcessRegistryValue struct {
	Address        string
	LocalPIDs      cmap.ConcurrentMap
	RemoteHandlers []AddressResolver
	SequenceID     uint64
}

func (*ProcessRegistryValue) Add

func (pr *ProcessRegistryValue) Add(process Process, id string) (*PID, bool)

func (*ProcessRegistryValue) Get

func (pr *ProcessRegistryValue) Get(pid *PID) (Process, bool)

func (*ProcessRegistryValue) GetLocal

func (pr *ProcessRegistryValue) GetLocal(id string) (Process, bool)

func (*ProcessRegistryValue) NextId

func (pr *ProcessRegistryValue) NextId() string

func (*ProcessRegistryValue) RegisterAddressResolver

func (pr *ProcessRegistryValue) RegisterAddressResolver(handler AddressResolver)

func (*ProcessRegistryValue) Remove

func (pr *ProcessRegistryValue) Remove(pid *PID)

type Producer

type Producer func() Actor

The Producer type is a function that creates a new actor

type Props

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

Props represents configuration to define how an actor should be created

func FromFunc

func FromFunc(f ActorFunc) *Props

FromFunc creates a props with the given receive func assigned as the actor producer

func FromInstance

func FromInstance(template Actor) *Props

FromInstance creates a props with the given instance assigned as the actor producer

func FromProducer

func FromProducer(actorProducer Producer) *Props

FromProducer creates a props whith the given actor producer assigned

func FromSpawnFunc

func FromSpawnFunc(spawn SpawnFunc) *Props

func (*Props) WithDispatcher

func (props *Props) WithDispatcher(dispatcher mailbox.Dispatcher) *Props

WithDispatcher assigns a dispatcher to the props

func (*Props) WithFunc

func (props *Props) WithFunc(f ActorFunc) *Props

WithFunc assigns a receive func to the props

func (*Props) WithInstance

func (props *Props) WithInstance(a Actor) *Props

WithInstance creates a custom actor producer from a given instance and assigns it to the props

func (*Props) WithMailbox

func (props *Props) WithMailbox(mailbox mailbox.Producer) *Props

WithMailbox assigns the desired mailbox producer to the props

func (*Props) WithMiddleware

func (props *Props) WithMiddleware(middleware ...func(ActorFunc) ActorFunc) *Props

WithMiddleware assigns one or more middlewares to the props

func (*Props) WithMiddleware2

func (props *Props) WithMiddleware2(middleware ...func(SenderFunc) SenderFunc) *Props

func (*Props) WithProducer

func (props *Props) WithProducer(p Producer) *Props

WithProducer assigns a actor producer to the props

func (*Props) WithSpawnFunc

func (props *Props) WithSpawnFunc(spawn SpawnFunc) *Props

WithSpawnFunc assigns a custom spawn func to the props, this is mainly for internal usage

func (*Props) WithSupervisor

func (props *Props) WithSupervisor(supervisor SupervisorStrategy) *Props

WithSupervisor assigns a supervision strategy to the props

type ReadonlyMessageHeader

type ReadonlyMessageHeader interface {
	Get(key string) string
	Keys() []string
}

type ReceiveTimeout

type ReceiveTimeout struct{}

A ReceiveTimeout message is sent to an actor after the Context.ReceiveTimeout duration has expired

type Restart

type Restart struct{}

Restart is message sent by the actor system to control the lifecycle of an actor

func (*Restart) SystemMessage

func (*Restart) SystemMessage()

type RestartStatistics

type RestartStatistics struct {
	FailureCount    int
	LastFailureTime time.Time
}

RestartStatistics keeps track of how many times an actor have restarted and when

func (*RestartStatistics) Fail

func (rs *RestartStatistics) Fail()

Fail increases the associated actors failure count

func (*RestartStatistics) IsWithinDuration

func (rs *RestartStatistics) IsWithinDuration(withinDuration time.Duration) bool

IsWithinDuration checks if a given duration is within the timespan from now to the last falure timestamp

func (*RestartStatistics) Reset

func (rs *RestartStatistics) Reset()

Reset the associated actors failure count

func (*RestartStatistics) Restart

func (rs *RestartStatistics) Restart()

Restart sets the last failure timestamp for the associated actor

type Restarting

type Restarting struct{}

A Restarting message is sent to an actor when the actor is being restarted by the system due to a failure

func (*Restarting) AutoReceiveMessage

func (*Restarting) AutoReceiveMessage()

type SenderContext

type SenderContext interface {
	// Tell sends a messages asynchronously to the PID
	Tell(pid *PID, message interface{})

	// Request sends a messages asynchronously to the PID. The actor may send a response back via respondTo, which is
	// available to the receiving actor via Context.Sender
	Request(pid *PID, message interface{}, respondTo *PID)

	// RequestFuture sends a message to a given PID and returns a Future
	RequestFuture(pid *PID, message interface{}, timeout time.Duration) *Future
}

func EmptyContext

func EmptyContext() SenderContext

type SenderFunc

type SenderFunc func(c Context, target *PID, envelope messageEnvelope)

type SpawnFunc

type SpawnFunc func(id string, props *Props, parent *PID) (*PID, error)
var DefaultSpawner SpawnFunc = spawn

DefaultSpawner conforms to Spawner and is used to spawn a local actor

type Started

type Started struct{}

A Started message is sent to an actor once it has been started and ready to begin receiving messages.

func (*Started) SystemMessage

func (*Started) SystemMessage()

type Stop

type Stop struct {
}

func (*Stop) Descriptor

func (*Stop) Descriptor() ([]byte, []int)

func (*Stop) Equal

func (this *Stop) Equal(that interface{}) bool

func (*Stop) Marshal

func (m *Stop) Marshal() (dAtA []byte, err error)

func (*Stop) MarshalTo

func (m *Stop) MarshalTo(dAtA []byte) (int, error)

func (*Stop) ProtoMessage

func (*Stop) ProtoMessage()

func (*Stop) Reset

func (m *Stop) Reset()

func (*Stop) Size

func (m *Stop) Size() (n int)

func (*Stop) String

func (this *Stop) String() string

func (*Stop) SystemMessage

func (*Stop) SystemMessage()

func (*Stop) Unmarshal

func (m *Stop) Unmarshal(dAtA []byte) error

type Stopped

type Stopped struct{}

A Stopped message is sent to the actor once it has been stopped. A stopped actor will receive no further messages

func (*Stopped) AutoReceiveMessage

func (*Stopped) AutoReceiveMessage()

type Stopping

type Stopping struct{}

A Stopping message is sent to an actor prior to the actor being stopped

func (*Stopping) AutoReceiveMessage

func (*Stopping) AutoReceiveMessage()

type Super

type Super struct {
	PID       *PID
	ParentPID *PID
	// contains filtered or unexported fields
}

func NewSuper

func NewSuper(
	vfOnStarted VFOnStarted,
	vfOnStopping VFOnStopping,
	vfOnStopped VFOnStopped,
	vfOnReceiveMessage VFOnReceiveMessage,
	vfOnActorTerminated VFOnActorTerminated,
	vfOnRestarting VFOnRestarting,
	vfOnRestarted VFOnRestarted,
	startedWg *sync.WaitGroup,
	stoppedWg *sync.WaitGroup,
) *Super

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

func (*Super) IsStopped

func (s *Super) IsStopped() bool

func (*Super) NewLoopTimer

func (s *Super) NewLoopTimer(interval time.Duration, cb TimerCallback) TimerID

func (*Super) NewTimer

func (s *Super) NewTimer(dur time.Duration, cb TimerCallback) TimerID

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

func (*Super) Receive

func (s *Super) Receive(ctx Context)

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

func (Super) Sign

func (s Super) Sign() string

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

func (*Super) Stop

func (s *Super) Stop() error

func (*Super) StopTimer

func (s *Super) StopTimer(id TimerID) error

type Supervisor

type Supervisor interface {
	Children() []*PID
	EscalateFailure(reason interface{}, message interface{})
	RestartChildren(pids ...*PID)
	StopChildren(pids ...*PID)
	ResumeChildren(pids ...*PID)
}

Supervisor is an interface that is used by the SupervisorStrategy to manage child actor lifecycle

type SupervisorEvent

type SupervisorEvent struct {
	Child     *PID
	Reason    interface{}
	Directive Directive
}

SupervisorEvent is sent on the EventStream when a supervisor have applied a directive to a failing child actor

type SupervisorStrategy

type SupervisorStrategy interface {
	HandleFailure(supervisor Supervisor, child *PID, rs *RestartStatistics, reason interface{}, message interface{})
}

SupervisorStrategy is an interface that decides how to handle failing child actors

func DefaultSupervisorStrategy

func DefaultSupervisorStrategy() SupervisorStrategy

func NewAllForOneStrategy

func NewAllForOneStrategy(maxNrOfRetries int, withinDuration time.Duration, decider DeciderFunc) SupervisorStrategy

NewAllForOneStrategy returns a new SupervisorStrategy which applies the given fault Directive from the decider to the failing child and all its children.

This strategy is appropriate when the children have a strong dependency, such that and any single one failing would place them all into a potentially invalid state.

func NewExponentialBackoffStrategy

func NewExponentialBackoffStrategy(backoffWindow time.Duration, initialBackoff time.Duration) SupervisorStrategy

NewExponentialBackoffStrategy creates a new Supervisor strategy that restarts a faulting child using an exponential back off algorithm:

delay =

func NewOneForOneStrategy

func NewOneForOneStrategy(maxNrOfRetries int, withinDuration time.Duration, decider DeciderFunc) SupervisorStrategy

NewOneForOneStrategy returns a new Supervisor strategy which applies the fault Directive from the decider to the failing child process.

This strategy is applicable if it is safe to handle a single child in isolation from its peers or dependents

func NewRestartingStrategy

func NewRestartingStrategy() SupervisorStrategy

func RestartingSupervisorStrategy

func RestartingSupervisorStrategy() SupervisorStrategy

type SystemMessage

type SystemMessage interface {
	SystemMessage()
}

A SystemMessage message is reserved for specific lifecycle messages used by the actor system

type Terminated

type Terminated struct {
	Who               *PID `protobuf:"bytes,1,opt,name=who" json:"who,omitempty"`
	AddressTerminated bool `protobuf:"varint,2,opt,name=AddressTerminated,proto3" json:"AddressTerminated,omitempty"`
}

func (*Terminated) Descriptor

func (*Terminated) Descriptor() ([]byte, []int)

func (*Terminated) Equal

func (this *Terminated) Equal(that interface{}) bool

func (*Terminated) GetWho

func (m *Terminated) GetWho() *PID

func (*Terminated) Marshal

func (m *Terminated) Marshal() (dAtA []byte, err error)

func (*Terminated) MarshalTo

func (m *Terminated) MarshalTo(dAtA []byte) (int, error)

func (*Terminated) ProtoMessage

func (*Terminated) ProtoMessage()

func (*Terminated) Reset

func (m *Terminated) Reset()

func (*Terminated) Size

func (m *Terminated) Size() (n int)

func (*Terminated) String

func (this *Terminated) String() string

func (*Terminated) SystemMessage

func (*Terminated) SystemMessage()

func (*Terminated) Unmarshal

func (m *Terminated) Unmarshal(dAtA []byte) error

type TimerCallback

type TimerCallback func(TimerID)

type TimerID

type TimerID = uint64

type TimerManager

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

func NewTimerManager

func NewTimerManager(pid *PID) *TimerManager

func (*TimerManager) NewLoopTimer

func (m *TimerManager) NewLoopTimer(dur time.Duration, callback TimerCallback) TimerID

func (*TimerManager) NewTimer

func (m *TimerManager) NewTimer(dur time.Duration, callback TimerCallback) TimerID

func (*TimerManager) Stop

func (m *TimerManager) Stop(id TimerID) error

func (*TimerManager) StopAll

func (m *TimerManager) StopAll()

func (*TimerManager) Trigger

func (m *TimerManager) Trigger(id TimerID) error

type Unwatch

type Unwatch struct {
	Watcher *PID `protobuf:"bytes,1,opt,name=watcher" json:"watcher,omitempty"`
}

func (*Unwatch) Descriptor

func (*Unwatch) Descriptor() ([]byte, []int)

func (*Unwatch) Equal

func (this *Unwatch) Equal(that interface{}) bool

func (*Unwatch) GetWatcher

func (m *Unwatch) GetWatcher() *PID

func (*Unwatch) Marshal

func (m *Unwatch) Marshal() (dAtA []byte, err error)

func (*Unwatch) MarshalTo

func (m *Unwatch) MarshalTo(dAtA []byte) (int, error)

func (*Unwatch) ProtoMessage

func (*Unwatch) ProtoMessage()

func (*Unwatch) Reset

func (m *Unwatch) Reset()

func (*Unwatch) Size

func (m *Unwatch) Size() (n int)

func (*Unwatch) String

func (this *Unwatch) String() string

func (*Unwatch) SystemMessage

func (*Unwatch) SystemMessage()

func (*Unwatch) Unmarshal

func (m *Unwatch) Unmarshal(dAtA []byte) error

type VFOnActorTerminated

type VFOnActorTerminated func(who *PID, ctx Context)

type VFOnReceiveMessage

type VFOnReceiveMessage func(ctx Context)

type VFOnRestarted

type VFOnRestarted func(ctx Context)

type VFOnRestarting

type VFOnRestarting func(ctx Context)

type VFOnStarted

type VFOnStarted func(ctx Context)

type VFOnStopped

type VFOnStopped func(ctx Context)

type VFOnStopping

type VFOnStopping func(ctx Context)

type Watch

type Watch struct {
	Watcher *PID `protobuf:"bytes,1,opt,name=watcher" json:"watcher,omitempty"`
}

system messages

func (*Watch) Descriptor

func (*Watch) Descriptor() ([]byte, []int)

func (*Watch) Equal

func (this *Watch) Equal(that interface{}) bool

func (*Watch) GetWatcher

func (m *Watch) GetWatcher() *PID

func (*Watch) Marshal

func (m *Watch) Marshal() (dAtA []byte, err error)

func (*Watch) MarshalTo

func (m *Watch) MarshalTo(dAtA []byte) (int, error)

func (*Watch) ProtoMessage

func (*Watch) ProtoMessage()

func (*Watch) Reset

func (m *Watch) Reset()

func (*Watch) Size

func (m *Watch) Size() (n int)

func (*Watch) String

func (this *Watch) String() string

func (*Watch) SystemMessage

func (*Watch) SystemMessage()

func (*Watch) Unmarshal

func (m *Watch) Unmarshal(dAtA []byte) error

type WorkCallback

type WorkCallback func(err error, outputs ...interface{})

type WorkFunc

type WorkFunc func(inputs ...interface{}) ([]interface{}, error)

func (WorkFunc) Do

func (f WorkFunc) Do(inputs ...interface{}) ([]interface{}, error)

type WorkRequest

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

func (*WorkRequest) Post

func (wr *WorkRequest) Post(cb WorkCallback)

func (*WorkRequest) WaitForResult

func (wr *WorkRequest) WaitForResult(timeout time.Duration) ([]interface{}, error)

type WorkResult

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

type Worker

type Worker struct {
	*Super
	// contains filtered or unexported fields
}

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

func NewWorker

func NewWorker(
	vfOnStarted VFOnStarted,
	vfOnStopping VFOnStopping,
	vfOnStopped VFOnStopped,
	vfOnReceiveMessage VFOnReceiveMessage,
	vfOnActorTerminated VFOnActorTerminated,
	vfOnRestarting VFOnRestarting,
	vfOnRestarted VFOnRestarted,
	startedWg *sync.WaitGroup,
	stoppedWg *sync.WaitGroup,
) *Worker

func (*Worker) IsStopping

func (w *Worker) IsStopping() bool

func (*Worker) NewRequest

func (w *Worker) NewRequest(iWork IWork, inputs ...interface{}) (*WorkRequest, error)

func (*Worker) Receive

func (w *Worker) Receive(ctx Context)

func (*Worker) Stop

func (w *Worker) Stop()

func (*Worker) WorkNum

func (w *Worker) WorkNum() int64

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL