PoissonClient.java

/*******************************************************************************
 * gMix open source project - https://svs.informatik.uni-hamburg.de/gmix/
 * Copyright (C) 2014  SVS
 *
 * This program is free software: you can redistribute it and/or modify 
 * it under the terms of the GNU General Public License as published by 
 * the Free Software Foundation, either version 3 of the License, or 
 * (at your option) any later version.
 *  
 * This program is distributed in the hope that it will be useful, 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License 
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *******************************************************************************/
package userGeneratedContent.simulatorPlugIns.plugins.trafficSource;

import java.security.SecureRandom;

import org.apache.commons.math.random.RandomDataImpl;

import staticContent.evaluation.simulator.Simulator;
import staticContent.evaluation.simulator.annotations.plugin.Plugin;
import staticContent.evaluation.simulator.annotations.property.DoubleSimulationProperty;
import staticContent.evaluation.simulator.annotations.property.IntSimulationProperty;
import staticContent.evaluation.simulator.core.event.Event;
import staticContent.evaluation.simulator.core.event.SimulationEvent;
import staticContent.evaluation.simulator.core.message.EndToEndMessage;
import staticContent.evaluation.simulator.core.networkComponent.AbstractClient;
import staticContent.evaluation.traceParser.engine.dataStructure.ExtendedTransaction;

@Plugin(pluginKey = "POISSON", pluginName="Poisson (exponential)")
public class PoissonClient extends AbstractClient {

	@IntSimulationProperty( name = "Request size (byte)", 
			key = "POISSON_REQUEST_SIZE", 
			enableAuto = true,
			min = 0,
			max = 9000,
			position = 57)
	private int REQUEST_SIZE;
	
	@IntSimulationProperty( name = "Reply size (byte)", 
			key = "POISSON_REPLY_SIZE", 
			enableAuto = true,
			min = 0,
			max = 9000,
			position = 56)
	private int REPLY_SIZE;
	
	@IntSimulationProperty( name = "Resolve time (ms)", 
			key = "POISSON_RESOLVE_TIME",
			min = 0,
			position = 58)
	private int RESOLVE_TIME; // in ms
	
	@DoubleSimulationProperty( name = "Average requests per second (requests) - lambda", 
			key = "POISSON_AVERAGE_REQUESTS_PER_SECOND_AND_CLIENT",
			min = 0.00001,
			position = 59)
	private double LAMBDA;
	
	private RandomDataImpl randomDataImpl;
	private static SecureRandom secureRandom = new SecureRandom();
	
	
	public PoissonClient(String identifier, Simulator simulator, int clientId) {
		super(identifier, simulator);
		if (Simulator.settings.getProperty("POISSON_REQUEST_SIZE").equals("AUTO"))
			this.REQUEST_SIZE = Simulator.settings.getPropertyAsInt("MIX_REQUEST_PAYLOAD_SIZE");
		else
			this.REQUEST_SIZE = Simulator.settings.getPropertyAsInt("POISSON_REQUEST_SIZE");
		if (Simulator.settings.getProperty("POISSON_REPLY_SIZE").equals("AUTO"))
			this.REPLY_SIZE = Simulator.settings.getPropertyAsInt("MIX_REPLY_PAYLOAD_SIZE");
		else
			this.REPLY_SIZE = Simulator.settings.getPropertyAsInt("POISSON_REPLY_SIZE");
		this.RESOLVE_TIME = Simulator.settings.getPropertyAsInt("POISSON_RESOLVE_TIME");
		this.clientId = clientId;
		this.LAMBDA = Simulator.settings.getPropertyAsDouble("POISSON_AVERAGE_REQUESTS_PER_SECOND_AND_CLIENT");
		this.randomDataImpl = new RandomDataImpl();
		this.randomDataImpl.reSeed(secureRandom.nextLong());
	}

	
	public void startSending() {
		scheduleNextSends();
	}

	
	@Override
	public void incomingMessage(EndToEndMessage message) {
		// PoissonClient does not take feedback into account...
	}

	
	@Override
	public void messageReachedServer(EndToEndMessage message) {
		// PoissonClient does not take feedback into account...
	}
	
	
	private void sendMessage() {
		ExtendedTransaction et = new ExtendedTransaction(0, 0l, 0l, REQUEST_SIZE, 0, new long[] {0}, new long[] {(0+RESOLVE_TIME)}, new int[] {REPLY_SIZE});
		EndToEndMessage eteMessage = new EndToEndMessage(0, et, true);
		sendMessage(eteMessage);
	}
	
	
	public void scheduleNextSends() {
		long now = Simulator.getNow();
		long end = now + 1000;
		long numberOfMessages = randomDataImpl.nextPoisson(LAMBDA);
		for (int i=0; i<numberOfMessages; i++) {
			long whenToSend = (long) randomDataImpl.nextUniform(now, end);
			simulator.scheduleEvent(new Event(this, whenToSend, PoissonClientEvent.SEND_MESSAGE), this);	
		}
	}

	
	public enum PoissonClientEvent implements SimulationEvent {
		SEND_MESSAGE;
	}
	
	
	@Override
	public void executeEvent(Event event) {
		if (event.getEventType() instanceof PoissonClientEvent) {
			if (event.getEventType() == PoissonClientEvent.SEND_MESSAGE) {
				sendMessage();
			} else
				throw new RuntimeException("ERROR: received unknown Event: " +event.toString()); 
		} else {
			super.executeEvent(event);
		}
	}
	
	
	@Override
	public void close() {
		// nothing to do here
	}
}