services/core/java/com/android/server/biometrics/sensors/Interruptable.java

/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed 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 com.android.server.biometrics.sensors;

import android.annotation.NonNull;

/**
 * Interface that {@link BaseClientMonitor} subclasses eligible for cancellation should implement.
 */
public interface Interruptable {
    /**
     * Requests to end the ClientMonitor's lifecycle.
     */
    void cancel();

    /**
     * Notifies the client that it needs to finish before
     * {@link BaseClientMonitor#start(BaseClientMonitor.Callback)} was invoked. This usually happens
     * if the client is still waiting in the pending queue and got notified that a subsequent
     * operation is preempting it.
     *
     * This method must invoke
     * {@link BaseClientMonitor.Callback#onClientFinished(BaseClientMonitor, boolean)} on the
     * given callback (with success).
     *
     * @param callback invoked when the operation is completed.
     */
    void cancelWithoutStarting(@NonNull BaseClientMonitor.Callback callback);
}