org.appdapter.api.module

Interface Module<Ctx>

All Known Implementing Classes:

BasicModule, BasicModuleTestOne.PowerModule, EmptyTimedModule, NullModule, TimedModule

public interface Module<Ctx>

A Module has 5 ActionMethods = [initModule(), start(), runOnce(), stop(), releaseModule()] and 8 formal states. The application work of the module should be performed in small chunks by its runOnce() method, which is called repeatedly (by some framework) until the module is stopped. A Module has a ParentModulator which it may use to perform any system interactions, as permitted by the type interface of the PM. Normally, the methods of a Module are only invoked by its ParentModulator. The Module is not allowed to directly depend on this fact, but the Module is allowed to make calls on its ParentModulator, which in general is a thread-safer behavior if we know we the current thread already holds the lock on that Modulator.

Author:

Stu B.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Module.State

Method Summary

Methods

Modifier and Type	Method and Description
void	failDuringInitOrStartup()
Ctx	getContext() The Module must have a valid parentModulator whenever it is inside a module action callback.
Module.State	getState()
void	initModule() Modulator must be set when initModule is called.
boolean	isStopRequested()
void	markStopRequested() Correct way for application to ask the module to stop.
void	releaseModule() Required pre-state is POST_STOP or FAILED_STARTUP.
void	runOnce() Required pre-state is WAIT_TO_RUN_OR_STOP.
void	setContext(Ctx pm)
void	start() Required pre-state is WAIT_TO_START.
void	stop() Required pre-state is WAIT_TO_RUN_OR_STOP.

Method Detail

getState

Module.State getState()

Returns:

Current state, subject to synchronization behavior of this module.

setContext

void setContext(Ctx pm)

getContext

Ctx getContext()

The Module must have a valid parentModulator whenever it is inside a module action callback.

Returns:

Current Modulator, subject to synchronization behavior of this module.

initModule

void initModule()

Modulator must be set when initModule is called. initModule is called exactly once, by the modulator, and can be First method called on Module, and called only once. Can only be called by the modulatorModule Upon return, must be in WAIT_TO_START, or FAILED_STARTUP.

start

void start()

Required pre-state is WAIT_TO_START. During-state is IN_START Upon return, state is WAIT_TO_RUN_OR_STOP, or FAILED_STARTUP.

runOnce

void runOnce()

Required pre-state is WAIT_TO_RUN_OR_STOP. During-state is IN_RUN. Upon return, state is WAIT_TO_RUN_OR_STOP.

stop

void stop()

Required pre-state is WAIT_TO_RUN_OR_STOP. During-state is IN_STOP. Upon return, state is POST_STOP

releaseModule

void releaseModule()

Required pre-state is POST_STOP or FAILED_STARTUP. Module is no longer usable as soon as call begins. Should not throw.

markStopRequested

void markStopRequested()

Correct way for application to ask the module to stop. May be called at any time to indicate that the module should stop() as soon as possible.

isStopRequested

boolean isStopRequested()

failDuringInitOrStartup

void failDuringInitOrStartup()