io.vlingo.xoom.actors.plugin.mailbox.sharedringbuffer

Class SharedRingBufferMailbox

java.lang.Object

io.vlingo.xoom.actors.plugin.mailbox.sharedringbuffer.SharedRingBufferMailbox

All Implemented Interfaces:

Mailbox, Runnable

public class SharedRingBufferMailbox
extends Object
implements Mailbox

Field Summary

Fields inherited from interface io.vlingo.xoom.actors.Mailbox

Exceptional, Paused, Stopping

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SharedRingBufferMailbox(Dispatcher dispatcher, int mailboxSize, boolean notifyOnSend)

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.
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.
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.
void	run()
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vlingo.xoom.actors.Mailbox

isSuspendedFor

Constructor Detail

SharedRingBufferMailbox

protected SharedRingBufferMailbox(Dispatcher dispatcher,
                                  int mailboxSize,
                                  boolean notifyOnSend)

Method Detail

close

public void close()

Description copied from interface: Mailbox

Close me.

Specified by:

close in interface Mailbox

isClosed

public boolean isClosed()

Description copied from interface: Mailbox

Answer whether or not I am closed.

Specified by:

isClosed in interface Mailbox

Returns:

boolean

isDelivering

public boolean isDelivering()

Description copied from interface: Mailbox

Answer whether or not I am currently delivering a message.

Specified by:

isDelivering in interface Mailbox

Returns:

boolean

isPreallocated

public boolean isPreallocated()

Description copied from interface: Mailbox

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

Specified by:

isPreallocated in interface Mailbox

Returns:

boolean

concurrencyCapacity

public int concurrencyCapacity()

Description copied from interface: Mailbox

Answer the total capacity for concurrent operations.

Specified by:

concurrencyCapacity in interface Mailbox

Returns:

int

resume

public void resume(String name)

Description copied from interface: Mailbox

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.

Specified by:

resume in interface Mailbox

Parameters:

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

send

public void send(Message message)

Description copied from interface: Mailbox

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.

Specified by:

send in interface Mailbox

Parameters:

message - the Message to send

suspendExceptFor

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

Description copied from interface: Mailbox

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.

Specified by:

suspendExceptFor in interface Mailbox

Parameters:

name - String the name of the specific override

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

isSuspended

public boolean isSuspended()

Description copied from interface: Mailbox

Answer whether or not I am currently suspended.

Specified by:

isSuspended in interface Mailbox

Returns:

return

send

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

Description copied from interface: Mailbox

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.

Specified by:

send in interface Mailbox

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

receive

public Message receive()

Description copied from interface: Mailbox

Answer the next Message that can be received.

Specified by:

receive in interface Mailbox

Returns:

Message

run

public void run()

Specified by:

run in interface Runnable

pendingMessages

public int pendingMessages()

Description copied from interface: Mailbox

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

Specified by:

pendingMessages in interface Mailbox

Returns:

int