org.myrobotlab.service

Class Clock

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.service.Clock

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, QueueReporter

public class Clock
extends Service

Clock - This is a simple clock service that can be started and stopped. It generates a pulse with a timestamp on a regular interval defined by the setInterval(Integer) method. Interval is in milliseconds.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Clock.ClockThread

Field Summary

Fields

Modifier and Type	Field and Description
int	interval
boolean	isClockRunning
static org.slf4j.Logger	log
Clock.ClockThread	myClock

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
Clock(java.lang.String n)

Method Summary

Modifier and Type	Method and Description
void	addClockEvent(java.util.Date time, java.lang.String name, java.lang.String method, java.lang.Object... data)
void	clockStarted()
void	clockStopped()
static ServiceType	getMetaData() This static method returns all the details of the class without it having to be constructed.
static void	main(java.lang.String[] args)
java.util.Date	pulse(java.util.Date time)
void	restartClock()
void	restartClock(boolean NoExecutionAtFirstClockStarted)
void	setInterval(java.lang.Integer milliseconds)
void	startClock()
void	startClock(boolean NoExecutionAtFirstClockStarted)
void	stopClock()
void	stopClock(boolean restartMe)
void	stopService() Stops the service.

Methods inherited from class org.myrobotlab.framework.Service

addListener, addListener, addTask, addTask, addTask, addTaskOneShot, allowDisplay, allowDisplay, attach, attach, broadcastState, buildDna, buildDna, buildDnaKeys, buildDnaNames, clearLastError, close, containsTask, copyShallowFrom, createPeer, createPeer, createRootReserved, detach, detach, detach, echoHeartbeat, error, error, error, getAttached, getCfgDir, getComm, getDeclaredMethodNames, getDeclaredMethods, getDescription, getDna, getDnaString, getHostName, getInbox, getInstanceId, getIntanceName, getInterfaceSet, getLastError, getMessageSet, getMetaData, getMethodMap, getMethodNames, getMethods, getMethodToolTip, getMsg, getName, getNotifyList, getNotifyListKeySet, getOutbox, getPeerKey, getPeerName, getServiceResourceFile, getSimpleName, getTasks, getThisThread, getType, hasError, hasPeers, help, help, in, info, info, invoke, invoke, invoke, invokeOn, isAttached, isAttached, isLocal, isReady, isRunning, isRuntime, isVirtual, load, load, logTimeEnable, mergeDna, mergeDna, mergePeerDna, movePeerDna, out, out, preProcessHook, preRoutingHook, publishError, publishQueueStats, publishState, publishStats, publishStatus, purgeTask, purgeTasks, releasePeers, releaseService, removeAllListeners, removeListener, requiresSecurity, reserve, reserve, reserveRoot, reserveRoot, reserveRootAs, run, save, save, save, send, send, send, send, sendBlocking, sendBlocking, sendBlocking, sendBlocking, sendPeer, setInstanceId, setName, setPeer, setSecurityProvider, setState, setThisThread, setVirtual, sleep, stackToString, startHeartbeat, startPeer, startPeer, startRecording, startService, stopHeartbeat, stopMsgRecording, subscribe, subscribe, subscribe, toString, unsubscribe, unsubscribe, unsubscribe, updateStats, warn, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

public static final org.slf4j.Logger log

isClockRunning

public boolean isClockRunning

interval

public int interval

myClock

public transient Clock.ClockThread myClock

Constructor Detail

Clock

public Clock(java.lang.String n)

Method Detail

addClockEvent

public void addClockEvent(java.util.Date time,
                          java.lang.String name,
                          java.lang.String method,
                          java.lang.Object... data)

clockStarted

public void clockStarted()

clockStopped

public void clockStopped()

pulse

public java.util.Date pulse(java.util.Date time)

setInterval

public void setInterval(java.lang.Integer milliseconds)

startClock

public void startClock(boolean NoExecutionAtFirstClockStarted)

restartClock

public void restartClock(boolean NoExecutionAtFirstClockStarted)

startClock

public void startClock()

restartClock

public void restartClock()

stopClock

public void stopClock()

stopClock

public void stopClock(boolean restartMe)

stopService

public void stopService()

Description copied from class: Service

Stops the service. Stops threads.

Specified by:

stopService in interface ServiceInterface

Overrides:

stopService in class Service

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getMetaData

public static ServiceType getMetaData()

This static method returns all the details of the class without it having to be constructed. It has description, categories, dependencies, and peer definitions.

Returns:

ServiceType - returns all the data