net.grinder.console.communication.ProcessControl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grinder-core Show documentation
The Grinder.
The newest version!
// Copyright (C) 2004 - 2012 Philip Aston
// All rights reserved.
//
// This file is part of The Grinder software distribution. Refer to
// the file LICENSE which is part of The Grinder distribution for
// licensing details. The Grinder distribution is available on the
// Internet at http://grinder.sourceforge.net/
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.

package net.grinder.console.communication;

import java.util.Comparator;
import java.util.EventListener;

import net.grinder.common.GrinderProperties;
import net.grinder.common.processidentity.ProcessReport;
import net.grinder.common.processidentity.WorkerProcessReport;
import net.grinder.console.common.ConsoleException;
import net.grinder.messages.console.AgentAndCacheReport;
import net.grinder.util.Directory;

/**
 * Interface for issuing commands to the agent and worker processes.
 *
 * @author Philip Aston
 * @author Dirk Feufel
 */
public interface ProcessControl {

  /**
   * Signal the worker processes to start.
   *
   * @param properties
   *          Properties that override the agent's local properties.
   */
  void startWorkerProcesses(GrinderProperties properties);

  /**
   * A variant of {@link #startWorkerProcesses} that checks the properties are
   * reasonable for the distribution directory, and adjusts the supplied
   * {@code properties} to have the appropriate relative paths.
   *
   * @param distributionDirectory
   *          The distribution directory.
   * @param properties
   *          The properties. If the associated file is in the distribution, the
   *          agent doesn't reload the distributed copy. However,it uses its
   *          location to resolve any relative {@code grinder.script} path.
   * @throws ConsoleException
   *           If the {@code grinder.script} property is set to a relative path
   *           outside of the distribution directory (e.g. {@code ../foo.py}.
   * @throws ConsoleException
   *           If an error occurred calculating file paths.
   * @since 3.11
   */
  void startWorkerProcessesWithDistributedFiles(Directory distributionDirectory,
                                                GrinderProperties properties)
    throws ConsoleException;

  /**
   * Signal the worker processes to reset.
   */
  void resetWorkerProcesses();

  /**
   * Signal the agent and worker processes to stop.
   */
  void stopAgentAndWorkerProcesses();

  /**
   * Add a listener for process status data.
   *
   * @param listener
   *          The listener.
   */
  void addProcessStatusListener(Listener listener);

  /**
   * How many agents are live?
   *
   * @return The number of agents.
   */
  int getNumberOfLiveAgents();

  /**
   * Listener interface for receiving updates about process status.
   */
  public interface Listener extends EventListener {

    /**
     * Called with regular updates on process status.
     *
     * @param processReports
     *          Process status information.
     */
    void update(ProcessReports[] processReports);
  }

  /**
   * Interface to the information the console has about an agent and its worker
   * processes.
   */
  interface ProcessReports {

    /**
     * Returns the latest agent process report.
     *
     * @return The agent process report.
     */
    AgentAndCacheReport getAgentProcessReport();

    /**
     * Returns the latest worker process reports.
     *
     * @return The worker process reports.
     */
    WorkerProcessReport[] getWorkerProcessReports();
  }

  /**
   * Comparator for {@link ProcessControl.ProcessReports} that sorts according
   * to the agent report.
   */
  final class ProcessReportsComparator implements Comparator {
    private final Comparator m_processReportComparator =
        new ProcessReport.StateThenNameThenNumberComparator();

    @Override
    public int compare(final ProcessReports o1, final ProcessReports o2) {
      return m_processReportComparator.compare(o1.getAgentProcessReport(),
                                               o2.getAgentProcessReport());
    }
  }
}