io.vlingo.xoom.actors

Class PooledCompletes

java.lang.Object

io.vlingo.xoom.actors.PooledCompletes

All Implemented Interfaces:

CompletesEventually, Stoppable

public class PooledCompletes
extends Object
implements CompletesEventually

Field Summary

Fields

Modifier and Type	Field and Description
Returns<Object>	clientReturns
CompletesEventually	completesEventually
long	id

Constructor Summary

Constructors

Constructor and Description
PooledCompletes(long id, Returns<?> clientReturns, CompletesEventually completesEventually)

Method Summary

Modifier and Type	Method and Description
Address	address()
void	conclude() Concludes the receiver, eventually causing it to receive a stop() message.
boolean	equals(Object other)
int	hashCode()
boolean	isStopped() Answer whether or not the receiver is stopped.
Object	outcome()
void	stop() Causes the receiver to stop reacting to messages and to eventually be garbage collected.
String	toString()
void	with(Object outcome)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

clientReturns

public final Returns<Object> clientReturns

completesEventually

public final CompletesEventually completesEventually

id

public final long id

Constructor Detail

PooledCompletes

public PooledCompletes(long id,
                       Returns<?> clientReturns,
                       CompletesEventually completesEventually)

Method Detail

address

public Address address()

Specified by:

address in interface CompletesEventually

outcome

public Object outcome()

with

public void with(Object outcome)

Specified by:

with in interface CompletesEventually

conclude

public void conclude()

Description copied from interface: Stoppable

Concludes the receiver, eventually causing it to receive a stop() message.

Specified by:

conclude in interface CompletesEventually

Specified by:

conclude in interface Stoppable

isStopped

public boolean isStopped()

Description copied from interface: Stoppable

Answer whether or not the receiver is stopped.

Specified by:

isStopped in interface CompletesEventually

Specified by:

isStopped in interface Stoppable

Returns:

boolean

stop

public void stop()

Description copied from interface: Stoppable

Causes the receiver to stop reacting to messages and to eventually be garbage collected.

Note that the contract of stop() is to suspend the receivers mailbox deliveries, which will prevent further processing. To arrange for eventually stopping the receiver send conclude(), which will then cause stop(). In essence the conclude() marks the mailbox for ending operations, but allows messages already queued to first be delivered.

Specified by:

stop in interface CompletesEventually

Specified by:

stop in interface Stoppable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object