actor

Documentation

Index

• Constants
• type Actor
• type Base
  • func (s *Base) Exit()
  • func (s *Base) OnHandle(Message)
  • func (s *Base) OnInit()
  • func (s *Base) OnStop() bool
• type BaseFunc
  • func (s *BaseFunc) OnHandle(msg Message)
  • func (s *BaseFunc) OnInit()
  • func (s *BaseFunc) OnStop() bool
• type Drainer
• type Handler
• type Id
• type Message
• type Messenger
• type Option
  • func SetLocalized() Option
  • func SetMailBoxSize(boxSize int) Option
• type RequestId
  • func (r RequestId) Parse() (sourceId string, targetId string, sourceAddr string, ok bool)
  • func (r RequestId) String() string
  • func (r RequestId) Valid() bool
• type System
  • func NewSystem(op ...SystemOption) (*System, error)
  • func (ed *System) CancelAll(actorId Id)
  • func (ed *System) CancelEvent(actorId Id, events ...interface{})
  • func (s *System) Cluster() Id
  • func (ed *System) DispatchEvent(sourceId Id, event interface{})
  • func (s *System) HasActor(actorId string) bool
  • func (s *System) NewActor(id Id, handler spawnActor, opt ...Option) error
  • func (ed *System) OnEvent(actorId Id, callback Handler)
  • func (s *System) ProtoIndex() *tools.ProtoIndex
  • func (s *System) Send(sourceId, targetId Id, requestId RequestId, msg any) (err error)
  • func (s *System) SetCluster(id Id)
  • func (s *System) Stop()
  • func (s *System) WaiterId() string
• type SystemOption
  • func LogFileName(path, fileName string) SystemOption
  • func LogLevel(level logger.Level) SystemOption
  • func Name(name string) SystemOption
  • func Output(out io.Writer) SystemOption
  • func ProtoIndex(pi *tools.ProtoIndex) SystemOption
• type Timer

Constants

const DefaultTimeout = time.Second * 10

Types

type Actor

type Actor interface {
	ID() string
	System() *System
	Exit()
}

type Base

type Base struct {
	Actor
	Timer
	Messenger
	Drainer
}

func (*Base) Exit

func (s *Base) Exit()

func (*Base) OnHandle

func (s *Base) OnHandle(Message)

func (*Base) OnInit

func (s *Base) OnInit()

func (*Base) OnStop

func (s *Base) OnStop() bool

type BaseFunc

type BaseFunc struct {
	Base
	Init   func()
	Stop   func() bool
	Handle func(msg Message)
}

func (*BaseFunc) OnHandle

func (s *BaseFunc) OnHandle(msg Message)

func (*BaseFunc) OnInit

func (s *BaseFunc) OnInit()

func (*BaseFunc) OnStop

func (s *BaseFunc) OnStop() bool

type Drainer

type Drainer interface {
	Drain(afterDrained func(), timeout ...time.Duration)
	// contains filtered or unexported methods
}

type Handler

type Handler interface{}

type Id

type Id = string

type Message

type Message interface {
	GetSourceId() Id
	GetTargetId() Id
	GetRequestId() string
	GetMsgName() string
	Payload() interface{}
	String() string
	Free()
}

type Messenger

type Messenger interface {
	Send(targetId Id, msg any) error
	Request(targetId Id, msg any, timeout ...time.Duration) (req *request)
	RequestWait(targetId Id, msg any, timeout ...time.Duration) (result interface{}, err error)
	Response(requestId string, msg any) error
}

type Option

type Option func(*actor)

Option the extra options of the new actor

func SetLocalized

func SetLocalized() Option

SetLocalized indicates that it can't be discovered by other System, meaning, this actor is localized.

func SetMailBoxSize

func SetMailBoxSize(boxSize int) Option

type RequestId

type RequestId string

func (RequestId) Parse

func (r RequestId) Parse() (sourceId string, targetId string, sourceAddr string, ok bool)

func (RequestId) String

func (r RequestId) String() string

func (RequestId) Valid

func (r RequestId) Valid() bool

type System

type System struct {
	Stopped chan struct{}

	// bind the inter-service communication port
	// to system-assigned random port
	Addr string
	// contains filtered or unexported fields
}

func NewSystem

func NewSystem(op ...SystemOption) (*System, error)

func (*System) CancelAll

func (ed *System) CancelAll(actorId Id)

func (*System) CancelEvent

func (ed *System) CancelEvent(actorId Id, events ...interface{})

func (*System) Cluster

func (s *System) Cluster() Id

func (*System) DispatchEvent

func (ed *System) DispatchEvent(sourceId Id, event interface{})

func (*System) HasActor

func (s *System) HasActor(actorId string) bool

func (*System) NewActor

func (s *System) NewActor(id Id, handler spawnActor, opt ...Option) error

NewActor new an actor for system id is invalid if contain '@' or '$'

func (*System) OnEvent

func (ed *System) OnEvent(actorId Id, callback Handler)

func (*System) ProtoIndex

func (s *System) ProtoIndex() *tools.ProtoIndex

func (*System) Send

func (s *System) Send(sourceId, targetId Id, requestId RequestId, msg any) (err error)

Send try to send the message to target

func (*System) SetCluster

func (s *System) SetCluster(id Id)

func (*System) Stop

func (s *System) Stop()

func (*System) WaiterId

func (s *System) WaiterId() string

type SystemOption

type SystemOption func(*System) error

func LogFileName

func LogFileName(path, fileName string) SystemOption

func LogLevel

func LogLevel(level logger.Level) SystemOption

func Name

func Name(name string) SystemOption

func Output

func Output(out io.Writer) SystemOption

func ProtoIndex

func ProtoIndex(pi *tools.ProtoIndex) SystemOption

ProtoIndex index proto struct

type Timer

type Timer interface {
	AddTimer(timeId string, endAt time.Time, callback func(dt time.Duration), times ...int) string
	CancelTimer(timerId string)
	// contains filtered or unexported methods
}