io.vlingo.xoom.actors

Interface Stoppable

All Known Subinterfaces:

CompletesEventually, DeadLetters

All Known Implementing Classes:

Actor, BroadcastRouter, CommonSupervisor, CompletesEventually__Proxy, CompletesEventuallyActor, ContentBasedRouter, DeadLetters__Proxy, DeadLettersActor, DefaultSupervisor, DefaultSupervisorOverride, DirectoryEvictor, DirectoryScannerActor, PooledCompletes, PrivateRootActor, PublicRootActor, RandomRouter, RoundRobinRouter, Router, Slf4jLoggerActor, SmallestMailboxRouter, Stage, Stoppable__Proxy

public interface Stoppable

Arranges for stopping the receiver.

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.

Method Summary

Modifier and Type	Method and Description
void	conclude() Concludes the receiver, eventually causing it to receive a stop() message.
boolean	isStopped() Answer whether or not the receiver is stopped.
void	stop() Causes the receiver to stop reacting to messages and to eventually be garbage collected.

Method Detail

conclude

void conclude()

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

isStopped

boolean isStopped()

Answer whether or not the receiver is stopped.

Returns:

boolean

stop

void stop()

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.