/*
 * Copyright 2021 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.system.virtualmachineservice;

/** {@hide} */
interface IVirtualMachineService {
    /**
     * Port number that VirtualMachineService listens on connections from the guest VMs for the
     * payload input and output.
     */
    const int VM_STREAM_SERVICE_PORT = 3000;

    /**
     * Port number that VirtualMachineService listens on connections from the guest VMs for the
     * VirtualMachineService binder service.
     */
    const int VM_BINDER_SERVICE_PORT = 5000;

    /**
     * Port number that VirtualMachineService listens on connections from the guest VMs for the
     * tombtones
     */
    const int VM_TOMBSTONES_SERVICE_PORT = 2000;

    /**
     * Notifies that the payload has started.
     */
    void notifyPayloadStarted();

    /**
     * Notifies that the payload is ready to serve.
     */
    void notifyPayloadReady();

    /**
     * Notifies that the payload has finished.
     */
    void notifyPayloadFinished(int exitCode);

    /**
     * Notifies that an error has occurred. See the ERROR_* constants.
     */
    void notifyError(int errorCode, in String message);

    /**
     * Error code for all other errors not listed below.
     */
    const int ERROR_UNKNOWN = 0;

    /**
     * Error code indicating that the payload can't be verified due to various reasons (e.g invalid
     * merkle tree, invalid formats, etc).
     */
    const int ERROR_PAYLOAD_VERIFICATION_FAILED = 1;

    /**
     * Error code indicating that the payload is verified, but has changed since the last boot.
     */
    const int ERROR_PAYLOAD_CHANGED = 2;

    /**
     * Error code indicating that the payload config is invalid.
     */
    const int ERROR_PAYLOAD_INVALID_CONFIG = 3;
}