Click or drag to resize
Akka.NETReceiveActor Class
TBD
Inheritance Hierarchy

Namespace:  Akka.Actor
Assembly:  Akka (in Akka.dll) Version: 1.2.1.36 (1.2.1.36)
Syntax
public abstract class ReceiveActor : UntypedActor, 
	IInitializableActor

The ReceiveActor type exposes the following members.

Constructors
  NameDescription
Protected methodReceiveActor
TBD
Top
Properties
  NameDescription
Protected propertySelf
Gets the self ActorRef
(Inherited from ActorBase.)
Protected propertySender
Gets the sending ActorRef of the current message
(Inherited from ActorBase.)
Top
Methods
  NameDescription
Public methodAroundPostRestart
Can be overridden to intercept calls to `PostRestart`. Calls `PostRestart` by default.
(Inherited from ActorBase.)
Public methodAroundPostStop
Can be overridden to intercept calls to `PostStop`. Calls `PostStop` by default..
(Inherited from ActorBase.)
Public methodAroundPreRestart
Can be overridden to intercept calls to `PreRestart`. Calls `PreRestart` by default.
(Inherited from ActorBase.)
Public methodAroundPreStart
Can be overridden to intercept calls to `PreStart`. Calls `PreStart` by default.
(Inherited from ActorBase.)
Protected methodAroundReceive
TBD
(Inherited from ActorBase.)
Protected methodBecome(Action)
Changes the actor's behavior and replaces the current receive handler with the specified handler.
Protected methodBecome(Receive)
Changes the actor's command behavior and replaces the current receive handler with the specified handler.
(Inherited from ActorBase.)
Protected methodBecome(UntypedReceive)
Changes the actor's behavior and replaces the current receive handler with the specified handler.
(Inherited from UntypedActor.)
Protected methodBecomeStacked(Action)
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(Action) is matched with a call to UnbecomeStacked.
Protected methodBecomeStacked(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.)
Protected methodBecomeStacked(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.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnReceive
TBD
(Overrides UntypedActorOnReceive(Object).)
Protected methodPostRestart
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.)
Protected methodPostStop
User overridable callback.

Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

(Inherited from ActorBase.)
Protected methodPreRestart
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.)
Protected methodPreStart
User overridable callback.

Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

(Inherited from ActorBase.)
Protected methodReceive(Object)
TBD
(Inherited from UntypedActor.)
Protected methodReceive(Type, FuncObject, Boolean)
Registers a handler for incoming messages of the specified messageType. The handler should return true if it has handled the message. If the handler returns true no more handlers will be tried; otherwise the next registered handler will be tried.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodReceive(Type, ActionObject, PredicateObject)
Registers a handler for incoming messages of the specified messageType. If shouldHandle!=null then it must return true before a message is passed to handler.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodReceive(Type, PredicateObject, ActionObject)
Registers a handler for incoming messages of the specified messageType. If shouldHandle!=null then it must return true before a message is passed to handler.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodReceiveT(FuncT, Boolean)
Registers a handler for incoming messages of the specified type T. The handler should return true if it has handled the message. If the handler returns true no more handlers will be tried; otherwise the next registered handler will be tried.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodReceiveT(ActionT, PredicateT)
Registers a handler for incoming messages of the specified type T. If shouldHandle!=null then it must return true before a message is passed to handler.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodReceiveT(PredicateT, ActionT)
Registers a handler for incoming messages of the specified type T. If shouldHandle!=null then it must return true before a message is passed to handler.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodReceiveAny
Registers a handler for incoming messages of any type.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodReceiveAnyAsync
Registers an asynchronous handler for incoming messages of any type.
Remarks
The actor will be suspended until the task returned by handler completes.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodReceiveAsync(Type, FuncObject, Task, PredicateObject)
Registers an asynchronous handler for incoming messages of the specified messageType. If shouldHandle!=null then it must return true before a message is passed to handler.
Remarks
The actor will be suspended until the task returned by handler completes.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodReceiveAsync(Type, PredicateObject, FuncObject, Task)
Registers an asynchronous handler for incoming messages of the specified messageType. If shouldHandle!=null then it must return true before a message is passed to handler.
Remarks
The actor will be suspended until the task returned by handler completes.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodReceiveAsyncT(FuncT, Task, PredicateT)
Registers an asynchronous handler for incoming messages of the specified type T. If shouldHandle!=null then it must return true before a message is passed to handler.
Remarks
The actor will be suspended until the task returned by handler completes.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodReceiveAsyncT(PredicateT, FuncT, Task)
Registers an asynchronous handler for incoming messages of the specified type T. If shouldHandle!=null then it must return true before a message is passed to handler.
Remarks
The actor will be suspended until the task returned by handler completes.
Remarks
This method may only be called when constructing the actor or from Become(Action) or BecomeStacked(Action).
Remarks
Note that handlers registered prior to this may have handled the message already. In that case, this handler will not be invoked.
Protected methodRunTask(Action)
TBD
(Inherited from UntypedActor.)
Protected methodRunTask(FuncTask)
TBD
(Inherited from UntypedActor.)
Protected methodSetReceiveTimeout

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.)
Protected methodSupervisorStrategy
TBD
(Inherited from ActorBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodUnbecomeStacked
Reverts the Actor behavior to the previous one on the behavior stack.
(Inherited from ActorBase.)
Protected methodUnhandled
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
See Also
Inheritance Hierarchy