io.vlingo.xoom.actors

Interface Mailbox

All Superinterfaces:

Runnable

All Known Implementing Classes:

ConcurrentQueueMailbox, ManyToOneConcurrentArrayQueueMailbox, ResumingMailbox, SharedRingBufferMailbox, TestMailbox

public interface Mailbox
extends Runnable

Standard actor mailbox protocol.

Field Summary

Fields

Modifier and Type	Field and Description
static String	Exceptional
static String	Paused
static String	Stopping

Method Summary

Modifier and Type	Method and Description
void	close() Close me.
int	concurrencyCapacity() Answer the total capacity for concurrent operations.
boolean	isClosed() Answer whether or not I am closed.
boolean	isDelivering() Answer whether or not I am currently delivering a message.
default boolean	isPreallocated() Answer whether or not I am a Mailbox with pre-allocated and reusable Message elements.
boolean	isSuspended() Answer whether or not I am currently suspended.
default boolean	isSuspendedFor(String name)
int	pendingMessages() Answer the count of messages that have not yet been delivered.
Message	receive() Answer the next Message that can be received.
void	resume(String name) Recovers the previous operational mode, either active or suspended, and if active resumes delivery.
default void	send(Actor actor, Class<?> protocol, io.vlingo.xoom.common.SerializableConsumer<?> consumer, Returns<?> returns, String representation) Arrange for Message to be sent by setting the pre-allocated and reusable element with the parameters.
void	send(Message message) Arrange for Message to be sent, which will generally be delivered by another thread.
void	suspendExceptFor(String name, Class<?>... overrides) Suspend message deliver but allow any of the given overrides to pass through, essentially giving these priority.

Methods inherited from interface java.lang.Runnable

run

Field Detail

Exceptional

static final String Exceptional

See Also:

Constant Field Values

Paused

static final String Paused

See Also:

Constant Field Values

Stopping

static final String Stopping

See Also:

Constant Field Values

Method Detail

close

void close()

Close me.

isClosed

boolean isClosed()

Answer whether or not I am closed.

Returns:

boolean

isDelivering

boolean isDelivering()

Answer whether or not I am currently delivering a message.

Returns:

boolean

concurrencyCapacity

int concurrencyCapacity()

Answer the total capacity for concurrent operations.

Returns:

int

resume

void resume(String name)

Recovers the previous operational mode, either active or suspended, and if active resumes delivery. If the restored operational mode is still suspended, then at least one more resume() is required. If the name is not the current suspended mode, its corresponding overrides may be marked for removal after any later overrides are removed.

Parameters:

name - the String name of the overrides for which to resume

send

void send(Message message)

Arrange for Message to be sent, which will generally be delivered by another thread. Exceptions to this rule are for possible, such as for TestMailbox.

Parameters:

message - the Message to send

suspendExceptFor

void suspendExceptFor(String name,
                      Class<?>... overrides)

Suspend message deliver but allow any of the given overrides to pass through, essentially giving these priority. Note that the receiving Actor must use resume() to cause normally delivery when it is ready.

NOTE: If suspendExceptFor(overrides) is used multiple times before the implementing Mailbox is resumed, the outcome is implementation dependent. The implementor may accumulate or replace its internal overrides with the overrides parameter. The name may be helpful in maintaining accumulated overrides.

Parameters:

name - String the name of the specific override

overrides - the varargs Class<?> that are allowed to be delivered although others are suspended

isSuspended

boolean isSuspended()

Answer whether or not I am currently suspended.

Returns:

return

isSuspendedFor

default boolean isSuspendedFor(String name)

receive

Message receive()

Answer the next Message that can be received.

Returns:

Message

pendingMessages

int pendingMessages()

Answer the count of messages that have not yet been delivered.

Returns:

int

isPreallocated

default boolean isPreallocated()

Answer whether or not I am a Mailbox with pre-allocated and reusable Message elements.

Returns:

boolean

send

default void send(Actor actor,
                  Class<?> protocol,
                  io.vlingo.xoom.common.SerializableConsumer<?> consumer,
                  Returns<?> returns,
                  String representation)

Arrange for Message to be sent by setting the pre-allocated and reusable element with the parameters. This manner of sending is meant to be used only when isPreallocated() answers true.

Parameters:

actor - the Actor being sent the message

protocol - the Class<?> type of Actor protocol

consumer - the Consumer<?> to carry out the action

returns - the Returns<?> through which return values are communicated; null if void return

representation - the String representation of this message invocation