Class Inbox

TBD

Inheritance
Object
Inbox
Implements
Inherited Members
Namespace: Akka.Actor
Assembly: Akka.dll
Syntax
public class Inbox : IInboxable, ICanWatch, IDisposable

Properties

| Improve this Doc View Source

Receiver

TBD

Declaration
public IActorRef Receiver { get; }
Property Value
Type Description
IActorRef

Methods

| Improve this Doc View Source

Create(ActorSystem)

TBD

Declaration
public static Inbox Create(ActorSystem system)
Parameters
Type Name Description
ActorSystem system

TBD
Returns
Type Description
Inbox

TBD
| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

Dispose(Boolean)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing

if set to true the method has been called directly or indirectly by a user's code. Managed and unmanaged resources will be disposed.
if set to false the method has been called by the runtime from inside the finalizer and only unmanaged resources can be disposed.
| Improve this Doc View Source

Receive()

Receive a single message from Receiver actor with default timeout. NOTE: Timeout resolution depends on system's scheduler.

Declaration
public object Receive()
Returns
Type Description
Object

TBD
Remarks

Don't use this method within actors, since it block current thread until a message is received.

| Improve this Doc View Source

Receive(TimeSpan)

Receive a single message from Receiver actor. Provided timeout is used for cleanup purposes. NOTE: timeout resolution depends on system's scheduler.

Declaration
public object Receive(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

TBD
Returns
Type Description
Object

TBD
Remarks

Don't use this method within actors, since it block current thread until a message is received.

Exceptions
Type Condition
TimeoutException

This exception is thrown if the inbox received a Status.Failure response message or it didn't receive a response message by the given timeout .
| Improve this Doc View Source

ReceiveAsync()

TBD

Declaration
public Task<object> ReceiveAsync()
Returns
Type Description
Task<Object>

TBD
| Improve this Doc View Source

ReceiveAsync(TimeSpan)

TBD

Declaration
public Task<object> ReceiveAsync(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

TBD
Returns
Type Description
Task<Object>

TBD
| Improve this Doc View Source

ReceiveWhere(Predicate<Object>)

TBD

Declaration
public object ReceiveWhere(Predicate<object> predicate)
Parameters
Type Name Description
Predicate<Object> predicate

TBD
Returns
Type Description
Object

TBD
| Improve this Doc View Source

ReceiveWhere(Predicate<Object>, TimeSpan)

TBD

Declaration
public object ReceiveWhere(Predicate<object> predicate, TimeSpan timeout)
Parameters
Type Name Description
Predicate<Object> predicate

TBD
TimeSpan timeout

TBD
Returns
Type Description
Object

TBD
Exceptions
Type Condition
TimeoutException

This exception is thrown if the inbox received a Status.Failure response message or it didn't receive a response message by the given timeout .
| Improve this Doc View Source

Send(IActorRef, Object)

TBD

Declaration
public void Send(IActorRef actorRef, object message)
Parameters
Type Name Description
IActorRef actorRef

TBD
Object message

TBD
| Improve this Doc View Source

Unwatch(IActorRef)

TBD

Declaration
public IActorRef Unwatch(IActorRef subject)
Parameters
Type Name Description
IActorRef subject

TBD
Returns
Type Description
IActorRef

TBD
| Improve this Doc View Source

Watch(IActorRef)

Make the inbox’s actor watch the subject actor such that reception of the Terminated message can then be awaited.

Declaration
public IActorRef Watch(IActorRef subject)
Parameters
Type Name Description
IActorRef subject

TBD
Returns
Type Description
IActorRef

TBD
| Improve this Doc View Source

WatchWith(IActorRef, Object)

Declaration
public IActorRef WatchWith(IActorRef subject, object message)
Parameters
Type Name Description
IActorRef subject
Object message
Returns
Type Description
IActorRef

Implements

Extension Methods