context.go

package actor

import "time"

//Context contains contextual information for actors
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))
}