bgu.dcr.az.api.exen.Mailer 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;

import bgu.dcr.az.api.Agent;
import bgu.dcr.az.api.Hooks;
import bgu.dcr.az.api.Message;
import bgu.dcr.az.api.exp.UnRegisteredAgentException;

/**
 * This is a familiar concept, an Interface for designing mailers – the mailer
 * is attached to the Execution object – what means that you should be able to
 * attach different mailers to test the algorithm with (some mailers can help
 * with producing algorithm visualization and some can be used for debugging).
 *
 * @author bennyl
 */
public interface Mailer extends NonBlockingMailer {

    /**
     * @return true if all the registered mailboxed are empty
     */
    public boolean isAllMailBoxesAreEmpty(String groupKey);

    MessageQueue register(Agent agent, String groupKey);

    /**
     * release all blocking agents from a specific mail group
     *
     * @param mailGroup
     */
    public void releaseAllBlockingAgents(String mailGroup);

    /**
     * release all blocking agents from all mail groups this method only make
     * sense if you are trying to terminate the whole execution as it may harm
     * the integrity of its results
     */
    public void releaseAllBlockingAgents();
}