Interface Service

    • Method Detail

      • stopAsync

        @CanIgnoreReturnValue
        Service stopAsync()
        If the service is starting or running, this initiates service shutdown and returns immediately. If the service is new, it is terminated without having been started nor stopped. If the service has already been stopped, this method returns immediately without taking action.
        Returns:
        this
        Since:
        15.0
      • awaitRunning

        void awaitRunning()
        Waits for the Service to reach the running state.
        Throws:
        java.lang.IllegalStateException - if the service reaches a state from which it is not possible to enter the Service.State.RUNNING state. e.g. if the state is State#TERMINATED when this method is called then this will throw an IllegalStateException.
        Since:
        15.0
      • awaitRunning

        void awaitRunning​(long timeout,
                          java.util.concurrent.TimeUnit unit)
                   throws java.util.concurrent.TimeoutException
        Waits for the Service to reach the running state for no more than the given time.
        Parameters:
        timeout - the maximum time to wait
        unit - the time unit of the timeout argument
        Throws:
        java.util.concurrent.TimeoutException - if the service has not reached the given state within the deadline
        java.lang.IllegalStateException - if the service reaches a state from which it is not possible to enter the RUNNING state. e.g. if the state is State#TERMINATED when this method is called then this will throw an IllegalStateException.
        Since:
        15.0
      • awaitTerminated

        void awaitTerminated​(long timeout,
                             java.util.concurrent.TimeUnit unit)
                      throws java.util.concurrent.TimeoutException
        Waits for the Service to reach a terminal state (either terminated or failed) for no more than the given time.
        Parameters:
        timeout - the maximum time to wait
        unit - the time unit of the timeout argument
        Throws:
        java.util.concurrent.TimeoutException - if the service has not reached the given state within the deadline
        java.lang.IllegalStateException - if the service fails.
        Since:
        15.0
      • failureCause

        java.lang.Throwable failureCause()
        Returns the Throwable that caused this service to fail.
        Throws:
        java.lang.IllegalStateException - if this service's state isn't FAILED.
        Since:
        14.0
      • addListener

        void addListener​(Service.Listener listener,
                         java.util.concurrent.Executor executor)
        Registers a Service.Listener to be executed on the given executor. The listener will have the corresponding transition method called whenever the service changes state. The listener will not have previous state changes replayed, so it is suggested that listeners are added before the service starts.

        addListener guarantees execution ordering across calls to a given listener but not across calls to multiple listeners. Specifically, a given listener will have its callbacks invoked in the same order as the underlying service enters those states. Additionally, at most one of the listener's callbacks will execute at once. However, multiple listeners' callbacks may execute concurrently, and listeners may execute in an order different from the one in which they were registered.

        RuntimeExceptions thrown by a listener will be caught and logged. Any exception thrown during Executor.execute (e.g., a RejectedExecutionException) will be caught and logged.

        Parameters:
        listener - the listener to run when the service changes state is complete
        executor - the executor in which the listeners callback methods will be run. For fast, lightweight listeners that would be safe to execute in any thread, consider MoreExecutors.directExecutor().
        Since:
        13.0