actor

Documentation

Index

• type Actor
• type BasicServerInner
  • func NewBasicServerInner(logger log.Logger) *BasicServerInner
  • func (inner *BasicServerInner) HandleBeat() (bool, error)
  • func (inner *BasicServerInner) HandleMsg(msg Msg) (terminate bool, err error)
  • func (inner *BasicServerInner) HandleShutdown(err error) bool
  • func (inner *BasicServerInner) Init(*Actor) (bool, error)
• type BasicServerOuter
  • func NewBasicServerOuter(mailbox *Mailbox) *BasicServerOuter
  • func (outer *BasicServerOuter) EnqueueFuncAsync(fun func() (bool, error)) bool
  • func (outer *BasicServerOuter) ShutdownSync()
• type EnqueueFuncActor
• type EnqueueMsgActor
• type Mailbox
  • func Spawn(server Server) (*Mailbox, error)
  • func (mailbox *Mailbox) EnqueueMsg(msg Msg) bool
  • func (mailbox *Mailbox) TerminatedChan() <-chan struct{}
• type Msg
• type MsgExec
• type MsgExecFunc
  • func (mef MsgExecFunc) Exec() (bool, error)
• type MsgShutdown
  • func (shutdown MsgShutdown) Error() string
• type MsgSync
• type MsgSyncQuery
  • func (msq *MsgSyncQuery) Close() bool
  • func (msq *MsgSyncQuery) InitMsg(actor EnqueueMsgActor)
  • func (msq *MsgSyncQuery) MustClose()
  • func (msq *MsgSyncQuery) Wait() bool
• type Server
• type Shutdownable
• type ShutdownableActor

Types

type Actor

type Actor struct {
	*Mailbox

	Server
	// contains filtered or unexported fields
}

type BasicServerInner

type BasicServerInner struct {
	Logger log.Logger
}

func NewBasicServerInner

func NewBasicServerInner(logger log.Logger) *BasicServerInner

func (*BasicServerInner) HandleBeat

func (inner *BasicServerInner) HandleBeat() (bool, error)

func (*BasicServerInner) HandleMsg

func (inner *BasicServerInner) HandleMsg(msg Msg) (terminate bool, err error)

func (*BasicServerInner) HandleShutdown

func (inner *BasicServerInner) HandleShutdown(err error) bool

func (*BasicServerInner) Init

func (inner *BasicServerInner) Init(*Actor) (bool, error)

type BasicServerOuter

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

func NewBasicServerOuter

func NewBasicServerOuter(mailbox *Mailbox) *BasicServerOuter

func (*BasicServerOuter) EnqueueFuncAsync

func (outer *BasicServerOuter) EnqueueFuncAsync(fun func() (bool, error)) bool

func (*BasicServerOuter) ShutdownSync

func (outer *BasicServerOuter) ShutdownSync()

type EnqueueFuncActor

type EnqueueFuncActor interface {
	EnqueueFuncAsync(func() (bool, error)) bool
}

type EnqueueMsgActor

type EnqueueMsgActor interface {
	EnqueueMsg(Msg) bool
	TerminatedChan() <-chan struct{}
}

type Mailbox

type Mailbox struct {
	Terminated <-chan struct{}
	// contains filtered or unexported fields
}

func Spawn

func Spawn(server Server) (*Mailbox, error)

func (*Mailbox) EnqueueMsg

func (mailbox *Mailbox) EnqueueMsg(msg Msg) bool

func (*Mailbox) TerminatedChan

func (mailbox *Mailbox) TerminatedChan() <-chan struct{}

type Msg

type Msg interface{}

type MsgExec

type MsgExec interface {
	Exec() (bool, error)
}

type MsgExecFunc

type MsgExecFunc func() (bool, error)

func (MsgExecFunc) Exec

func (mef MsgExecFunc) Exec() (bool, error)

type MsgShutdown

type MsgShutdown struct{}

func (MsgShutdown) Error

func (shutdown MsgShutdown) Error() string

type MsgSync

type MsgSync interface {
	InitMsg(actor EnqueueMsgActor)
	Close() bool
	Wait() bool
}

type MsgSyncQuery

type MsgSyncQuery struct {
	WaitChan       chan struct{}
	TerminatedChan <-chan struct{}
}

func (*MsgSyncQuery) Close

func (msq *MsgSyncQuery) Close() bool

func (*MsgSyncQuery) InitMsg

func (msq *MsgSyncQuery) InitMsg(actor EnqueueMsgActor)

func (*MsgSyncQuery) MustClose

func (msq *MsgSyncQuery) MustClose()

func (*MsgSyncQuery) Wait

func (msq *MsgSyncQuery) Wait() bool

Returns true iff Close() is called on MsgSyncQuery (i.e MsgSyncQuery.WaitChan is closed). Blocks until either MsgSyncQuery.WaitChan is closed, or MsgSyncQuery.TerminatedChan is closed.

type Server

type Server interface {
	Init(*Actor) (bool, error)
	HandleBeat() (bool, error)
	HandleMsg(Msg) (bool, error)
	HandleShutdown(error) bool
}

type Shutdownable

type Shutdownable interface {
	ShutdownSync()
}

type ShutdownableActor

type ShutdownableActor interface {
	ShutdownSync()
}