/**
 * Copyright 2014, 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 android.app.job;

import android.app.Notification;
import android.app.job.JobWorkItem;

/**
 * The server side of the JobScheduler IPC protocols.  The app-side implementation
 * invokes on this interface to indicate completion of the (asynchronous) instructions
 * issued by the server.
 *
 * In all cases, the 'who' parameter is the caller's service binder, used to track
 * which Job Service instance is reporting.
 *
 * @hide
 */
interface IJobCallback {
    /**
     * Immediate callback to the system after sending a data transfer download progress request
     * signal; used to quickly detect ANR.
     *
     * @param jobId Unique integer used to identify this job.
     * @param workId Unique integer used to identify a specific work item.
     * @param transferredBytes How much data has been downloaded, in bytes.
     */
    void acknowledgeGetTransferredDownloadBytesMessage(int jobId, int workId,
            long transferredBytes);
    /**
     * Immediate callback to the system after sending a data transfer upload progress request
     * signal; used to quickly detect ANR.
     *
     * @param jobId Unique integer used to identify this job.
     * @param workId Unique integer used to identify a specific work item.
     * @param transferredBytes How much data has been uploaded, in bytes.
     */
    void acknowledgeGetTransferredUploadBytesMessage(int jobId, int workId, long transferredBytes);
    /**
     * Immediate callback to the system after sending a start signal, used to quickly detect ANR.
     *
     * @param jobId Unique integer used to identify this job.
     * @param ongoing True to indicate that the client is processing the job. False if the job is
     * complete
     */
    @UnsupportedAppUsage
    void acknowledgeStartMessage(int jobId, boolean ongoing);
    /**
     * Immediate callback to the system after sending a stop signal, used to quickly detect ANR.
     *
     * @param jobId Unique integer used to identify this job.
     * @param reschedule Whether or not to reschedule this job.
     */
    @UnsupportedAppUsage
    void acknowledgeStopMessage(int jobId, boolean reschedule);
    /*
     * Called to deqeue next work item for the job.
     */
    @UnsupportedAppUsage
    JobWorkItem dequeueWork(int jobId);
    /*
     * Called to report that job has completed processing a work item.
     */
    @UnsupportedAppUsage
    boolean completeWork(int jobId, int workId);
    /*
     * Tell the job manager that the client is done with its execution, so that it can go on to
     * the next one and stop attributing wakelock time to us etc.
     *
     * @param jobId Unique integer used to identify this job.
     * @param reschedule Whether or not to reschedule this job.
     */
    @UnsupportedAppUsage
    void jobFinished(int jobId, boolean reschedule);

    /*
     * Inform JobScheduler that this job may have been abandoned because the client process
     * has lost strong references to the JobParameters object without calling jobFinished.
     *
     * @param jobId Unique integer used to identify this job
     */
    void handleAbandonedJob(int jobId);

    /*
     * Inform JobScheduler of a change in the estimated transfer payload.
     *
     * @param jobId Unique integer used to identify this job.
     * @param item The particular JobWorkItem this progress is associated with, if any.
     * @param downloadBytes How many bytes the app expects to download.
     * @param uploadBytes How many bytes the app expects to upload.
     */
    void updateEstimatedNetworkBytes(int jobId, in JobWorkItem item,
            long downloadBytes, long uploadBytes);
    /*
     * Update JobScheduler of how much data the job has successfully transferred.
     *
     * @param jobId Unique integer used to identify this job.
     * @param item The particular JobWorkItem this progress is associated with, if any.
     * @param transferredDownloadBytes The number of bytes that have successfully been downloaded.
     * @param transferredUploadBytes The number of bytes that have successfully been uploaded.
     */
    void updateTransferredNetworkBytes(int jobId, in JobWorkItem item,
            long transferredDownloadBytes, long transferredUploadBytes);
    /**
     * Provide JobScheduler with a notification to post and tie to this job's
     * lifecycle.
     * This is required for all user-initiated job and optional for other jobs.
     *
     * @param jobId Unique integer used to identify this job.
     * @param notificationId The ID for this notification, as per
     *                       {@link android.app.NotificationManager#notify(int, Notification)}.
     * @param notification The notification to be displayed.
     * @param jobEndNotificationPolicy The policy to apply to the notification when the job stops.
     */
    void setNotification(int jobId, int notificationId,
            in Notification notification, int jobEndNotificationPolicy);
}