/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.phoenix.pherf.workload.mt.generators;

import java.util.List;
import java.util.Properties;
import org.apache.phoenix.pherf.configuration.DataModel;
import org.apache.phoenix.pherf.configuration.Scenario;
import org.apache.phoenix.pherf.util.PhoenixUtil;
import org.apache.phoenix.pherf.workload.mt.handlers.PherfWorkHandler;
import org.apache.phoenix.pherf.workload.mt.operations.TenantOperationFactory;

/**
 * An interface that implementers can use to generate load events that can be consumed by
 * @see {@link com.lmax.disruptor.WorkHandler} which provide event handling functionality for a
 *      given event.
 * @param <T> load event object
 */
public interface LoadEventGenerator<T> {
  /**
   * Initializes and readies the generator for queue based workloads
   */
  void start() throws Exception;

  /**
   * Stop the generator and waits for the queues to drain.
   */
  void stop() throws Exception;

  PhoenixUtil getPhoenixUtil();

  Scenario getScenario();

  DataModel getModel();

  Properties getProperties();

  TenantOperationFactory getOperationFactory();

  List<PherfWorkHandler> getWorkHandlers(Properties properties);

  TenantOperationInfo next();
}
