actors

Documentation

Index

• type Actable
• type Action
• type ActionsHandler
  • func (handler *ActionsHandler) RegisterAction(actionName string, action Action)
• type Actor
  • func (actor *Actor) Identifier() string
• type Context
  • func (context *Context) Params(key string) interface{}
  • func (context *Context) ParamsInt(key string, fallback int) int
  • func (context *Context) ParamsStr(key string) string
• type Event
• type Mailboxes
• type Manager
  • func (manager *Manager) RegisterActor(nsp string, actable Actable) *Actor
  • func (manager *Manager) Request(actorIdentifier string, eventName string, params map[string]interface{}) error
  • func (manager *Manager) Setup()
  • func (manager *Manager) Tell(actorIdentifier string, eventName string, params map[string]interface{})
• type Response

Types

type Actable

type Actable interface {
	GetID() string
	RegisterActorActions(*ActionsHandler)
}

Actable is the interface for all models implementing actor model

type Action

type Action func(context *Context) error

Action is alias for func(context *Context) error

type ActionsHandler

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

ActionsHandler used to mange callbacks for controllers

func (*ActionsHandler) RegisterAction

func (handler *ActionsHandler) RegisterAction(actionName string, action Action)

RegisterAction used to register action

type Actor

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

Actor is the base representation of actor in actor model

func (*Actor) Identifier

func (actor *Actor) Identifier() string

Identifier used to identify mailbox's address of actor

type Context

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

Context used to represent context with data

func (*Context) Params

func (context *Context) Params(key string) interface{}

Params used to retrieve params value

func (*Context) ParamsInt

func (context *Context) ParamsInt(key string, fallback int) int

ParamsInt used to retrieve params value in int

func (*Context) ParamsStr

func (context *Context) ParamsStr(key string) string

ParamsStr used to retrieve params value in string

type Event

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

type Mailboxes

type Mailboxes map[string]chan Event

Mailboxes is alias for map[string]chan Event

type Manager

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

Manager is singleton manager for actor module

func (*Manager) RegisterActor

func (manager *Manager) RegisterActor(nsp string, actable Actable) *Actor

RegisterActor used to creating an actor instance for model

func (*Manager) Request

func (manager *Manager) Request(actorIdentifier string, eventName string, params map[string]interface{}) error

Request used to delegating a task to an actor synchronously with an response

func (*Manager) Setup

func (manager *Manager) Setup()

Setup used to setup actor manager

func (*Manager) Tell

func (manager *Manager) Tell(actorIdentifier string, eventName string, params map[string]interface{})

Tell used to delegating a task to an actor asynchronously

type Response

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

Response represents the response for synchronous task delegation request for action