bgu.dcr.az.api.exen.mdef.MessageDelayer Maven / Gradle / Ivy

Go to download
/* 
 * The MIT License
 *
 * Copyright 2016 Benny Lutati.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package bgu.dcr.az.api.exen.mdef;

import bgu.dcr.az.api.Message;
import bgu.dcr.az.api.exen.Execution;

/**
 *
 * @author bennyl
 */
public interface MessageDelayer {
    /**
     * initialize the delayer - this method will get called on each new execution that is started
     * the delayer is reused between executions and this method will get called to notify it to reinitialize itself
     * on the new execution
     * @param ex 
     */
    void initialize(Execution ex);
    
    /**
     * @return the initial time
     * the mailer will take this time in order to initialize itself
     */
    long getInitialTime();
    
    /**
     * extract the time from the given message 
     * most of the time all the "timing" information will be stored inside the message metadata.
     * @param m
     * @return 
     */
    long extractTime(Message m);
    
    /**
     * add delay to the given message
     * the message is sent between agent 'from' to agent 'to'
     * @param m
     * @param from
     * @param to 
     */
    void addDelay(Message m, int from, int to);
}