system

package
v0.0.0-...-adeac23 Latest Latest
Warning

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

Go to latest
Published: Aug 14, 2026 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const (
	HookPreStart   = "preStart"
	HookPostStart  = "postStart"
	HookPoisoned   = "poisoned"
	HookTerminated = "terminated"
	HookCrash      = "crash"
)
View Source
const (
	PersistIntervalSeconds = 10
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Actor

type Actor interface {
	GetID() uuid.UUID
	GetKind() string

	Start(context.Context)
	Stop(context.Context) error
	HandleMessage(context.Context, *Message) HandleError

	Snapshot(context.Context) (database.Snapshot, error)
	RestoreFromSnapshot(context.Context, database.Snapshot) error

	Persist(context.Context, database.Store) error
	Restore(context.Context, database.Store) error
}

type ActorFactory

type ActorFactory func(ctx context.Context) Actor

type ActorHandler

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

func NewActorHandler

func NewActorHandler(sys *System, actor Actor, opts ...HandlerOpt) *ActorHandler

func (*ActorHandler) GetActor

func (h *ActorHandler) GetActor() Actor

func (*ActorHandler) GetAddress

func (h *ActorHandler) GetAddress() string

func (*ActorHandler) GetID

func (h *ActorHandler) GetID() uuid.UUID

func (*ActorHandler) GetKind

func (h *ActorHandler) GetKind() string

func (*ActorHandler) Persist

func (h *ActorHandler) Persist(ctx context.Context) error

func (*ActorHandler) Persist_

func (h *ActorHandler) Persist_(ctx context.Context, db Persister) error

func (*ActorHandler) Restore

func (h *ActorHandler) Restore(ctx context.Context) error

func (*ActorHandler) SendMessage

func (h *ActorHandler) SendMessage(ctx context.Context, msg *Message)

func (*ActorHandler) Start

func (h *ActorHandler) Start(ctx context.Context)

func (*ActorHandler) Stop

func (h *ActorHandler) Stop()

func (*ActorHandler) WaitForTermination

func (h *ActorHandler) WaitForTermination()

type Bus

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

func NewBus

func NewBus() *Bus

func (*Bus) GetSubscriptionGroups

func (b *Bus) GetSubscriptionGroups() map[uuid.UUID]*SubscriptionGroup

func (*Bus) Inbox

func (b *Bus) Inbox() chan any

func (*Bus) Publish

func (b *Bus) Publish(ctx context.Context, sender uuid.UUID, recipient Recipient, payload any) error

func (*Bus) Request

func (b *Bus) Request(ctx context.Context, sender uuid.UUID, recipient Recipient, payload any) (any, error)

func (*Bus) Route

func (b *Bus) Route(ctx context.Context, msg *Message) error

func (*Bus) SetRouteFunction

func (b *Bus) SetRouteFunction(routeFn func(actorID uuid.UUID, msg *Message) error)

func (*Bus) Start

func (b *Bus) Start()

func (*Bus) Stop

func (b *Bus) Stop()

func (*Bus) Subscribe

func (b *Bus) Subscribe(pattern string, actorID uuid.UUID) (uuid.UUID, error)

func (*Bus) Unsubscribe

func (b *Bus) Unsubscribe(subscriptionID uuid.UUID, actorID uuid.UUID) error

func (*Bus) UpdateSubscriptionGroup

func (b *Bus) UpdateSubscriptionGroup(group *SubscriptionGroup)

type Factory

type Factory struct {
	Fn    ActorFactory
	Hooks []HookOpt
}

type HandleError

type HandleError interface {
	IsRecoverable() bool
	Error() string
}

type HandlerOpt

type HandlerOpt func(*ActorHandler, *System)

func WithSubscription

func WithSubscription(pattern string) HandlerOpt

type Hook

type Hook func(context.Context, Actor) error

type HookCollection

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

func NewHookCollection

func NewHookCollection(name string, hooks ...Hook) *HookCollection

func (*HookCollection) Add

func (hc *HookCollection) Add(hook Hook)

type HookOpt

type HookOpt func(h *ActorHandler, sys *System)

func WithCrashHook

func WithCrashHook(hook Hook) HookOpt

func WithPoisonedHook

func WithPoisonedHook(hook Hook) HookOpt

func WithPostStartHook

func WithPostStartHook(hook Hook) HookOpt

func WithPreStartHook

func WithPreStartHook(hook Hook) HookOpt

func WithTerminatedHook

func WithTerminatedHook(hook Hook) HookOpt

type Message

type Message struct {
	ID              uuid.UUID
	Sender          uuid.UUID
	Payload         any
	Recipient       Recipient
	ResponseTo      uuid.UUID
	ResponseChannel chan *Message
}

Message represents a message that can be sent between actors.

func (*Message) GetBody

func (m *Message) GetBody() any

func (*Message) GetID

func (m *Message) GetID() uuid.UUID

func (*Message) GetRecipient

func (m *Message) GetRecipient() Recipient

func (*Message) GetResponseTo

func (m *Message) GetResponseTo() uuid.UUID

func (*Message) GetSender

func (m *Message) GetSender() uuid.UUID

func (*Message) IsRequest

func (m *Message) IsRequest() bool

func (*Message) Respond

func (m *Message) Respond(sender uuid.UUID, payload any) error

type MessageConsumer

type MessageConsumer interface {
	Publish(ctx context.Context, sender uuid.UUID, recipient Recipient, payload any) error
	Request(ctx context.Context, sender uuid.UUID, recipient Recipient, payload any) error
}

type MessageQueue

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

func NewMessageQueue

func NewMessageQueue() *MessageQueue

func (*MessageQueue) IsEmpty

func (q *MessageQueue) IsEmpty() bool

func (*MessageQueue) Len

func (q *MessageQueue) Len() int

func (*MessageQueue) Pop

func (q *MessageQueue) Pop() any

func (*MessageQueue) Push

func (q *MessageQueue) Push(msg any)

type Persister

type Persister interface {
	Persist(ctx context.Context, key string, value database.Snapshot) error
}

type Publisher

type Publisher interface {
	Subscribe(pattern string, actorID uuid.UUID) (uuid.UUID, error)
	Unsubscribe(subscriptionID uuid.UUID, actorID uuid.UUID) error
}

type Recipient

type Recipient struct {
	Kind    RecipientKind
	Subject string
}

func (Recipient) String

func (r Recipient) String() string

type RecipientKind

type RecipientKind string
const (
	RecipientKindTopic RecipientKind = "topic"
	RecipientKindActor RecipientKind = "actor"
)

type Registry

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

func NewRegistry

func NewRegistry() *Registry

func (*Registry) Clear

func (r *Registry) Clear()

func (*Registry) DeregisterFactory

func (r *Registry) DeregisterFactory(kind string)

func (*Registry) RegisterFactory

func (r *Registry) RegisterFactory(kind string, factory ActorFactory, opts ...HookOpt)

type Replayer

type Replayer interface {
	Replay(context.Context, int64)
}

type Restorer

type Restorer interface {
	Restore(ctx context.Context, key string) (database.Snapshot, error)
}

type SenderFunc

type SenderFunc func(ctx context.Context, request bool, sender uuid.UUID, recipient Recipient, payload any) (any, error)

type Subscription

type Subscription struct {
	ID uuid.UUID
	// contains filtered or unexported fields
}

func NewSubscription

func NewSubscription(pattern string, actorID uuid.UUID) (*Subscription, error)

func (*Subscription) GetPattern

func (s *Subscription) GetPattern() *regexp.Regexp

type SubscriptionGroup

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

func NewSubscriptionGroup

func NewSubscriptionGroup(pattern string) (*SubscriptionGroup, error)

func (*SubscriptionGroup) AddActor

func (g *SubscriptionGroup) AddActor(actorID uuid.UUID)

func (*SubscriptionGroup) GetActors

func (g *SubscriptionGroup) GetActors() map[uuid.UUID]struct{}

func (*SubscriptionGroup) GetID

func (g *SubscriptionGroup) GetID() uuid.UUID

func (*SubscriptionGroup) GetPattern

func (g *SubscriptionGroup) GetPattern() *regexp.Regexp

type System

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

func MustNewSystem

func MustNewSystem(registry *Registry, store database.Store, kv database.KeyValue) *System

func NewSystem

func NewSystem(registry *Registry, store database.Store, kv database.KeyValue) (*System, error)

func (*System) AttemptRestoreActor

func (s *System) AttemptRestoreActor(ctx context.Context, kind string, params model.IDParam, opts ...HandlerOpt) (*ActorHandler, error)

func (*System) GetName

func (s *System) GetName() string

func (*System) GetSystemID

func (s *System) GetSystemID() uuid.UUID

func (*System) IsActorSpawned

func (s *System) IsActorSpawned(ctx context.Context, actorID uuid.UUID) model.ActorState

func (*System) Publish

func (s *System) Publish(ctx context.Context, sender uuid.UUID, recipient Recipient, payload any) error

func (*System) Request

func (s *System) Request(ctx context.Context, sender uuid.UUID, recipient Recipient, payload any) (any, error)

func (*System) Route

func (s *System) Route(ctx context.Context, msg *Message) error

func (*System) Send

func (s *System) Send(ctx context.Context, msg *Message)

func (*System) Shutdown

func (s *System) Shutdown(ctx context.Context) error

func (*System) Spawn

func (s *System) Spawn(ctx context.Context, kind string, opts ...HandlerOpt) (*ActorHandler, error)

TODO Unexpose this method once we have better communication options.

func (*System) SpawnWithParams

func (s *System) SpawnWithParams(ctx context.Context, kind string, params any, opts ...HandlerOpt) (*ActorHandler, error)

func (*System) Subscribe

func (s *System) Subscribe(pattern string, actorID uuid.UUID) (uuid.UUID, error)

func (*System) Unsubscribe

func (s *System) Unsubscribe(subscriptionID uuid.UUID, actorID uuid.UUID) error

Jump to

Keyboard shortcuts

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