android-34/com/android/net/module/util/wear/PacketFile.java

/*
 * Copyright (C) 2023 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.net.module.util.wear;

/**
 * Defines bidirectional file where all transmissions are made as complete packets.
 *
 * Automatically manages all readability and writeability events in EventManager:
 *   - When read buffer has more space - asks EventManager to notify on more data
 *   - When write buffer has more space - asks the user to provide more data
 *   - When underlying file cannot accept more data - registers EventManager callback
 *
 * @hide
 */
public interface PacketFile {
    /** @hide */
    public enum ErrorCode {
        UNEXPECTED_ERROR,
        IO_ERROR,
        INBOUND_PACKET_TOO_LARGE,
        OUTBOUND_PACKET_TOO_LARGE,
    }

    /**
     * Receives notifications when new data or output space is available.
     *
     * @hide
     */
    public interface Listener {
        /**
         * Handles the initial part of the stream, which on some systems provides lower-level
         * configuration data.
         *
         * Returns the number of bytes consumed, or zero if the preamble has been fully read.
         */
        int onPreambleData(byte[] data, int pos, int len);

        /** Handles one extracted packet. */
        void onInboundPacket(byte[] data, int pos, int len);

        /** Notifies on new data being added to the buffer. */
        void onInboundBuffered(int newByteCount, int totalBufferedSize);

        /** Notifies on data being flushed from output buffer. */
        void onOutboundPacketSpace();

        /** Notifies on unrecoverable error in the packet processing. */
        void onPacketFileError(ErrorCode error, String message);
    }

    /** Requests this file to be closed. */
    void close();

    /** Permanently disables reading of this file, and clears all buffered data. */
    void shutdownReading();

    /** Starts or resumes async read operations on this file. */
    void continueReading();

    /** Returns the number of bytes currently buffered as input. */
    int getInboundBufferSize();

    /** Returns the number of bytes currently available for buffering for output. */
    int getOutboundFreeSize();

    /**
     * Queues the given data for output.
     * Throws runtime exception if there is not enough space.
     */
    boolean enqueueOutboundPacket(byte[] data, int pos, int len);
}