org.opentcs.common.KernelClientApplication Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-common Show documentation

openTCS-Common

There is a newer version: 6.2.0

/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.common;

import org.opentcs.components.Lifecycle;

/**
 * Provides methods used in a kernel client application's context.
 */
public interface KernelClientApplication
    extends
      Lifecycle {

  /**
   * Tells the application to switch its state to online.
   *
   * @param autoConnect Whether to connect automatically to the kernel or to show a connect dialog
   * when going online.
   */
  void online(boolean autoConnect);

  /**
   * Tells the application to switch its state to offline.
   */
  void offline();

  /**
   * Checks whether the application's state is online.
   *
   * @return Whether the application's state is online.
   */
  boolean isOnline();
}