Actors.Actor Class

ActorsActor Class

[Missing <summary> documentation for "T:Akka.FSharp.Actors.Actor"]

Inheritance Hierarchy

SystemObject
  Akka.ActorActorBase
    Akka.ActorUntypedActor
      Akka.FSharpActorsActor
        Akka.FSharpActorsFunActorMessage, Returned

Namespace: Akka.FSharp
Assembly: Akka.FSharp (in Akka.FSharp.dll) Version: 1.2.3.42 (1.2.3.42)

Syntax

Copy

[SerializableAttribute]
public abstract class Actor : UntypedActor, 
	IWithUnboundedStash

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type Actor =  
    class
        inherit UntypedActor
        interface IWithUnboundedStash
    end

The ActorsActor type exposes the following members.

Constructors

	Name	Description
	ActorsActor	Initializes a new instance of the ActorsActor class

Top

Properties

	Name	Description
	Self	Gets the self ActorRef (Inherited from ActorBase.)
	Sender	Gets the sending ActorRef of the current message (Inherited from ActorBase.)

Top

Methods

	Name	Description
	AroundPostRestart	Can be overridden to intercept calls to `PostRestart`. Calls `PostRestart` by default. (Inherited from ActorBase.)
	AroundPostStop	Can be overridden to intercept calls to `PostStop`. Calls `PostStop` by default.. (Inherited from ActorBase.)
	AroundPreRestart	Can be overridden to intercept calls to `PreRestart`. Calls `PreRestart` by default. (Inherited from ActorBase.)
	AroundPreStart	Can be overridden to intercept calls to `PreStart`. Calls `PreStart` by default. (Inherited from ActorBase.)
	AroundReceive	TBD (Inherited from ActorBase.)
	Become(Receive)	Changes the actor's command behavior and replaces the current receive handler with the specified handler. (Inherited from ActorBase.)
	Become(UntypedReceive)	Changes the actor's behavior and replaces the current receive handler with the specified handler. (Inherited from UntypedActor.)
	BecomeStacked(Receive)	Changes the actor's behavior and replaces the current receive handler with the specified handler. The current handler is stored on a stack, and you can revert to it by calling UnbecomeStacked Remarks Please note, that in order to not leak memory, make sure every call to BecomeStacked(Receive) is matched with a call to UnbecomeStacked. (Inherited from ActorBase.)
	BecomeStacked(UntypedReceive)	Changes the actor's behavior and replaces the current receive handler with the specified handler. The current handler is stored on a stack, and you can revert to it by calling UnbecomeStacked Remarks Please note, that in order to not leak memory, make sure every call to BecomeStacked(UntypedReceive) is matched with a call to UnbecomeStacked. (Inherited from UntypedActor.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnReceive	To be implemented by concrete UntypedActor, this defines the behavior of the UntypedActor. This method is called for every message received by the actor. (Inherited from UntypedActor.)
	PostRestart	User overridable callback: By default it calls `PreStart()`. Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash. (Inherited from ActorBase.)
	PostStop	User overridable callback. Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation. (Inherited from ActorBase.)
	PreRestart	User overridable callback: '''By default it disposes of all children and then calls `postStop()`.''' Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated. (Inherited from ActorBase.)
	PreStart	User overridable callback. Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation. (Inherited from ActorBase.)
	Receive	TBD (Inherited from UntypedActor.)
	RunTask(Action)	TBD (Inherited from UntypedActor.)
	RunTask(FuncTask)	TBD (Inherited from UntypedActor.)
	SetReceiveTimeout	Defines the inactivity timeout after which the sending of a ReceiveTimeout message is triggered. When specified, the receive function should be able to handle a ReceiveTimeout message. Please note that the receive timeout might fire and enqueue the ReceiveTimeout message right after another message was enqueued; hence it is not guaranteed that upon reception of the receive timeout there must have been an idle period beforehand as configured via this method. Once set, the receive timeout stays in effect (i.e. continues firing repeatedly after inactivity periods). Pass in null to switch off this feature. (Inherited from ActorBase.)
	SupervisorStrategy	TBD (Inherited from ActorBase.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnbecomeStacked	Reverts the Actor behavior to the previous one on the behavior stack. (Inherited from ActorBase.)
	Unhandled	Is called when a message isn't handled by the current behavior of the actor by default it fails with either a DeathPactException (in case of an unhandled Terminated message) or publishes an UnhandledMessage to the actor's system's EventStream (Inherited from ActorBase.)

Top

Extension Methods

	Name	Description
	AsInstanceOfT	TBD (Defined by Extensions.)
	Match	Overloaded. Matches the specified target. (Defined by PatternMatch.)
	MatchT	Overloaded. Matches the specified target and return a result of target processing. (Defined by PatternMatch.)

Top

Reference

Akka.FSharp Namespace