• Home
• org.opentcs
• opentcs-api-base
• 6.1.2
• source code
• SharedKernelServicePortal.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.opentcs.access.SharedKernelServicePortal Maven / Gradle / Ivy

/**
 * 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.access;

/**
 * Provides access to a shared {@link KernelServicePortal} instance.
 */
public interface SharedKernelServicePortal
    extends
      AutoCloseable {

  @Override
  void close();

  /**
   * Indicates whether this instance is closed/unregistered from the shared portal pool.
   *
   * @return {@code true} if, and only if, this instance is closed.
   */
  boolean isClosed();

  /**
   * Returns the {@link KernelServicePortal} instance being shared.
   *
   * @return The portal instance being shared.
   * @throws IllegalStateException If this instance is closed.
   */
  KernelServicePortal getPortal()
      throws IllegalStateException;
}