/*
 * Copyright (C) 2015 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.tradefed.device;

import com.android.tradefed.result.InputStreamSource;

/**
 * A class that provides the output of a device's logcat as an {@link InputStreamSource}.
 */
public interface ILogcatReceiver {

    public void start();

    public void stop();

    public void clear();

    public InputStreamSource getLogcatData();

    public InputStreamSource getLogcatData(int maxBytes);

    /**
     * Returns the current logcat buffer given an offset.
     *
     * @param maxBytes The max size of the returned buffer
     * @param offset The offset of the full buffer.
     * @return The logcat buffer starting at the offset.
     */
    public default InputStreamSource getLogcatData(int maxBytes, int offset) {
        return getLogcatData(maxBytes);
    }
}