Class Inbox

TBD

Inheritance

object

Inbox

Implements

IInboxable

ICanWatch

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Actor

Assembly: Akka.dll

Syntax

public class Inbox : IInboxable, ICanWatch, IDisposable

Properties

Receiver

TBD

Declaration

public IActorRef Receiver { get; }

Property Value

Type	Description
IActorRef

Methods

Create(ActorSystem)

TBD

Declaration

public static Inbox Create(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system	TBD

Returns

Type	Description
Inbox	TBD

Dispose()

Declaration

public void Dispose()

Dispose(bool)

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

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	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.

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.

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 .

ReceiveAsync()

TBD

Declaration

public Task<object> ReceiveAsync()

Returns

Type	Description
Task<object>	TBD

ReceiveAsync(TimeSpan)

TBD

Declaration

public Task<object> ReceiveAsync(TimeSpan timeout)

Parameters

Type	Name	Description
TimeSpan	timeout	TBD

Returns

Type	Description
Task<object>	TBD

ReceiveWhere(Predicate<object>)

TBD

Declaration

public object ReceiveWhere(Predicate<object> predicate)

Parameters

Type	Name	Description
Predicate<object>	predicate	TBD

Returns

Type	Description
object	TBD

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 .

Send(IActorRef, object)

TBD

Declaration

public void Send(IActorRef actorRef, object message)

Parameters

Type	Name	Description
IActorRef	actorRef	TBD
object	message	TBD

Unwatch(IActorRef)

TBD

Declaration

public IActorRef Unwatch(IActorRef subject)

Parameters

Type	Name	Description
IActorRef	subject	TBD

Returns

Type	Description
IActorRef	TBD

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

WatchWith(IActorRef, object)

Monitors the specified actor for termination. When the subject terminates the instance watching will receive the provided message.

Declaration

public IActorRef WatchWith(IActorRef subject, object message)

Parameters

Type	Name	Description
IActorRef	subject	The actor to monitor for termination.
object	message	The custom termination message

Returns

Type	Description
IActorRef	Returns the provided subject

Implements

IInboxable

ICanWatch

IDisposable

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)