ReceiveActor Class |
Namespace: Akka.Actor
The ReceiveActor type exposes the following members.
Name | Description | |
---|---|---|
ReceiveActor |
TBD
|
Name | Description | |
---|---|---|
Self |
Gets the self ActorRef
(Inherited from ActorBase.) | |
Sender |
Gets the sending ActorRef of the current message
(Inherited from ActorBase.) |
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(Action) |
Changes the actor's behavior and replaces the current receive handler with the specified handler.
| |
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(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. | |
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 (Inherited from ActorBase.)Remarks Please note, that in order to not leak memory, make sure every call to BecomeStacked(Receive)
is matched with a call to UnbecomeStacked. | |
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 (Inherited from UntypedActor.)Remarks Please note, that in order to not leak memory, make sure every call to BecomeStacked(UntypedReceive)
is matched with a call to UnbecomeStacked. | |
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 |
TBD
(Overrides UntypedActorOnReceive(Object).) | |
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(Object) |
TBD
(Inherited from UntypedActor.) | |
Receive(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. | |
Receive(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. | |
Receive(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. | |
ReceiveT(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. | |
ReceiveT(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. | |
ReceiveT(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. | |
ReceiveAny |
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. | |
ReceiveAnyAsync |
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. | |
ReceiveAsync(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. | |
ReceiveAsync(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. | |
ReceiveAsyncT(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. | |
ReceiveAsyncT(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. | |
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. | |
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.) |
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.) |