org.appdapter.module.basic.TimedModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.appdapter.lib.registry Show documentation
Pluggable object registration + query service
There is a newer version: 1.2.4
Show newest version
/*
 *  Copyright 2012 by The Appdapter Project (www.appdapter.org).
 * 
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.appdapter.module.basic;


/**
 * Here we log the timing of each callback exec, and also make the parent modulator's 
 * presence explicit in each callback.  We also supply a naive "completed run count".
 * @author Stu B. 
 */
public abstract class TimedModule extends BasicModule {

	private		long	myCompletedRunCount = 0;
	
	protected	int		myRunDebugModulus = 5;
	
	public long getCompletedRunCount() { 
		return myCompletedRunCount;
	}
	protected abstract void doInit(Ctx mlator);
	
	@Override public synchronized void initModule() {
		enterBasicInitModule(true);
		Ctx ctx = getContext();
		Long beginStamp = logInfoEvent(IMPO_HI, true, null, ".doInit()-BEGIN");
		doInit(ctx);
		logInfoEvent(IMPO_NORM, true, beginStamp, ".doInit()-END");
		exitBasicInitModule(true);
	}
	
	protected abstract void doStart(Ctx ctx);
	
	@Override public synchronized void start() {
		enterBasicStart();
		Ctx ctx = getContext();
		Long beginStamp = logInfoEvent(IMPO_NORM, true, null, ".doStart()-BEGIN");
		doStart(ctx);
		logInfoEvent(IMPO_NORM, true, beginStamp, ".doStart()-END");
		exitBasicStart();
	}
	
	protected abstract void doRunOnce(Ctx ctx, long runSeqNum);

	@Override public synchronized void runOnce() {
		enterBasicRunOnce();
		Ctx ctx = getContext();
		// Our importance is usually "LO", but once every myRunDebugModulus runs, the importance goes up to "NORM".
		int msgImportance = ((myCompletedRunCount % myRunDebugModulus) == 0) ? IMPO_NORM : IMPO_LO;
		Long startStamp = logInfoEvent(msgImportance, true, null, ".doRunOnce(seqNum=%d)-BEGIN", myCompletedRunCount);
		doRunOnce(ctx, myCompletedRunCount);
		logInfoEvent(msgImportance, true, startStamp, ".doRunOnce(seqNum=%d)-END", myCompletedRunCount);
		++myCompletedRunCount;
		exitBasicRunOnce();
	}

	protected abstract void doStop(Ctx ctx);
	
	@Override public synchronized void stop() {
		enterBasicStop();
		Ctx ctx = getContext();
		Long beginStamp = logInfoEvent(IMPO_NORM, true, null, ".doStop()-BEGIN");
		doStop(ctx);
		logInfoEvent(IMPO_NORM, true, beginStamp, ".doStop()-END");
		exitBasicStop();
	}

	protected abstract void doRelease(Ctx ctx);
	
	@Override public synchronized void releaseModule() {
		enterBasicReleaseModule();
		Ctx ctx = getContext();
		Long beginStamp = logInfoEvent(IMPO_NORM, true, null, ".doRelease()-BEGIN");
		doRelease(ctx);
		logInfoEvent(IMPO_NORM, true, beginStamp, ".doRelease()-END");
		exitBasicReleaseModule();
	}
	
	@Override public String getFieldSummary() { 
		return super.getFieldSummary() + ", compRunCnt=" + getCompletedRunCount();
	}


	
}