public static interface MatsConfig.StartStoppable
Modifier and Type | Method and Description |
---|---|
void |
start()
Will start the entity - or the entities below it (the only "active" entity is a
MatsStage Processor). |
boolean |
stop(int gracefulShutdownMillis)
Will stop the entity - or the entities below it (the only "active" entity is a
MatsStage Processor). |
boolean |
waitForReceiving(int timeoutMillis)
If the entity is stopped or starting, this method won't return until it has actually started the receive-loop
(i.e.
|
void start()
MatsStage
Processor).
Calling this method when the entity is already running has no effect.
Further documentation on extensions - note the special semantics for MatsFactory
boolean waitForReceiving(int timeoutMillis)
MatsStage
Processor has actually entered its receive-loop, consuming messages). If
the entity has already gotten into the receive loop, the method immediately returns.
Note: Currently, this only holds for the initial start. If the entity has started the receive-loop at some
point, it will always immediately return - even though it is currently stopped.
Further documentation on extensions.timeoutMillis
- number of milliseconds before giving up the wait, returning false
. 0 is indefinite
wait, negative values are not allowed.true
if the entity started within the timeout, false
if it did not start.boolean stop(int gracefulShutdownMillis)
MatsStage
Processor).
This method is idempotent, calling it when the entity is already stopped has no effect.
Further documentation on extensions - note the special semantics for MatsFactory
gracefulShutdownMillis
- number of milliseconds to let the stage processors wait after having asked for them to shut down,
and interrupting them if they have not shut down yet.true
if the running thread(s) were dead when returning, false
otherwise.