Starting March 27, 2025, we recommend using android-latest-release instead of aosp-main to build and contribute to AOSP. For more information, see Changes to AOSP.
Stay organized with collections
Save and categorize content based on your preferences.
LargeOutputReceiver
public
class
LargeOutputReceiver
extends Object
implements
IShellOutputReceiver
| java.lang.Object
|
| ↳ |
com.android.tradefed.device.LargeOutputReceiver
|
A class designed to help run long running commands collect output.
The maximum size of the tmp file is limited to approximately maxFileSize.
To prevent data loss when the limit has been reached, this file keeps set of tmp host
files.
Summary
Public constructors
LargeOutputReceiver
public LargeOutputReceiver (String descriptor,
String serialNumber,
long maxDataSize)
Creates a LargeOutputReceiver.
| Parameters |
|---|
descriptor |
String: the descriptor of the command to run. For logging only. |
serialNumber |
String: the serial number of the device. For logging only. |
maxDataSize |
long: the approximate max amount of data to keep.
|
Public methods
addOutput
public void addOutput (byte[] data,
int offset,
int length)
| Parameters |
|---|
data |
byte |
offset |
int |
length |
int |
cancel
public void cancel ()
Cancels the command.
clear
public void clear ()
Delete currently accumulated data, and then re-create a new file.
delete
public void delete ()
Delete all accumulated data.
flush
public void flush ()
getData
public InputStreamSource getData ()
Gets the collected output as a InputStreamSource.
| Returns |
|---|
InputStreamSource |
The collected output from the command.
|
getData
public InputStreamSource getData (int maxBytes)
Gets the last maxBytes of collected output as a InputStreamSource.
| Parameters |
|---|
maxBytes |
int: the maximum amount of data to return. Should be an amount that can
comfortably fit in memory |
| Returns |
|---|
InputStreamSource |
The collected output from the command, stored in memory
|
getData
public InputStreamSource getData (int maxBytes,
int offset)
Gets the last maxBytes of collected output as a InputStreamSource.
| Parameters |
|---|
maxBytes |
int: the maximum amount of data to return. Should be an amount that can
comfortably fit in memory |
offset |
int: The offset of when to start getting the data from the buffer. |
| Returns |
|---|
InputStreamSource |
The collected output from the command, stored in memory
|
isCancelled
public boolean isCancelled ()
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2022-08-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2022-08-03 UTC."],[],[],null,["# LargeOutputReceiver\n===================\n\n\n`\npublic\n\n\nclass\nLargeOutputReceiver\n`\n\n\n`\n\nextends Object\n\n\n`\n\n`\n\n\nimplements\n\nIShellOutputReceiver\n\n\n`\n\n|---|-------------------------------------------------|\n| java.lang.Object ||\n| ↳ | com.android.tradefed.device.LargeOutputReceiver |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nA class designed to help run long running commands collect output.\n\n\nThe maximum size of the tmp file is limited to approximately `maxFileSize`.\nTo prevent data loss when the limit has been reached, this file keeps set of tmp host\nfiles.\n\n\u003cbr /\u003e\n\nSummary\n-------\n\n| ### Public constructors ||\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ` `[LargeOutputReceiver](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html#LargeOutputReceiver(java.lang.String,%20java.lang.String,%20long))`(String descriptor, String serialNumber, long maxDataSize) ` Creates a [LargeOutputReceiver](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html). |\n\n| ### Public methods ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` void` | ` `[addOutput](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html#addOutput(byte[],%20int,%20int))`(byte[] data, int offset, int length) ` |\n| ` void` | ` `[cancel](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html#cancel())`() ` Cancels the command. |\n| ` void` | ` `[clear](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html#clear())`() ` Delete currently accumulated data, and then re-create a new file. |\n| ` void` | ` `[delete](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html#delete())`() ` Delete all accumulated data. |\n| ` void` | ` `[flush](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html#flush())`() ` |\n| ` InputStreamSource` | ` `[getData](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html#getData())`() ` Gets the collected output as a [InputStreamSource](../../../../../../reference/tradefed/com/android/tradefed/result/InputStreamSource.html). |\n| ` InputStreamSource` | ` `[getData](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html#getData(int))`(int maxBytes) ` Gets the last \u003cvar translate=\"no\"\u003emaxBytes\u003c/var\u003e of collected output as a [InputStreamSource](../../../../../../reference/tradefed/com/android/tradefed/result/InputStreamSource.html). |\n| ` InputStreamSource` | ` `[getData](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html#getData(int,%20int))`(int maxBytes, int offset) ` Gets the last \u003cvar translate=\"no\"\u003emaxBytes\u003c/var\u003e of collected output as a [InputStreamSource](../../../../../../reference/tradefed/com/android/tradefed/result/InputStreamSource.html). |\n| ` boolean` | ` `[isCancelled](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html#isCancelled())`() ` |\n\nPublic constructors\n-------------------\n\n### LargeOutputReceiver\n\n```\npublic LargeOutputReceiver (String descriptor, \n String serialNumber, \n long maxDataSize)\n```\n\nCreates a [LargeOutputReceiver](../../../../../../reference/tradefed/com/android/tradefed/device/LargeOutputReceiver.html).\n\n\u003cbr /\u003e\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------------|\n| `descriptor` | `String`: the descriptor of the command to run. For logging only. \u003cbr /\u003e |\n| `serialNumber` | `String`: the serial number of the device. For logging only. \u003cbr /\u003e |\n| `maxDataSize` | `long`: the approximate max amount of data to keep. \u003cbr /\u003e |\n\nPublic methods\n--------------\n\n### addOutput\n\n```\npublic void addOutput (byte[] data, \n int offset, \n int length)\n```\n\n\n\u003cbr /\u003e\n\n| Parameters ||\n|----------|---------------|\n| `data` | `byte` \u003cbr /\u003e |\n| `offset` | `int` \u003cbr /\u003e |\n| `length` | `int` \u003cbr /\u003e |\n\n### cancel\n\n```\npublic void cancel ()\n```\n\nCancels the command.\n\n\u003cbr /\u003e\n\n### clear\n\n```\npublic void clear ()\n```\n\nDelete currently accumulated data, and then re-create a new file.\n\n\u003cbr /\u003e\n\n### delete\n\n```\npublic void delete ()\n```\n\nDelete all accumulated data.\n\n\u003cbr /\u003e\n\n### flush\n\n```\npublic void flush ()\n```\n\n\n\u003cbr /\u003e\n\n### getData\n\n```\npublic InputStreamSource getData ()\n```\n\nGets the collected output as a [InputStreamSource](../../../../../../reference/tradefed/com/android/tradefed/result/InputStreamSource.html).\n\n\u003cbr /\u003e\n\n| Returns ||\n|---------------------|-----------------------------------------------|\n| `InputStreamSource` | The collected output from the command. \u003cbr /\u003e |\n\n### getData\n\n```\npublic InputStreamSource getData (int maxBytes)\n```\n\nGets the last \u003cvar translate=\"no\"\u003emaxBytes\u003c/var\u003e of collected output as a [InputStreamSource](../../../../../../reference/tradefed/com/android/tradefed/result/InputStreamSource.html).\n\n\u003cbr /\u003e\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------|\n| `maxBytes` | `int`: the maximum amount of data to return. Should be an amount that can comfortably fit in memory \u003cbr /\u003e |\n\n| Returns ||\n|---------------------|----------------------------------------------------------------|\n| `InputStreamSource` | The collected output from the command, stored in memory \u003cbr /\u003e |\n\n### getData\n\n```\npublic InputStreamSource getData (int maxBytes, \n int offset)\n```\n\nGets the last \u003cvar translate=\"no\"\u003emaxBytes\u003c/var\u003e of collected output as a [InputStreamSource](../../../../../../reference/tradefed/com/android/tradefed/result/InputStreamSource.html).\n\n\u003cbr /\u003e\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------|\n| `maxBytes` | `int`: the maximum amount of data to return. Should be an amount that can comfortably fit in memory \u003cbr /\u003e |\n| `offset` | `int`: The offset of when to start getting the data from the buffer. \u003cbr /\u003e |\n\n| Returns ||\n|---------------------|----------------------------------------------------------------|\n| `InputStreamSource` | The collected output from the command, stored in memory \u003cbr /\u003e |\n\n### isCancelled\n\n```\npublic boolean isCancelled ()\n```\n\n\n\u003cbr /\u003e\n\n| Returns ||\n|-----------|--------|\n| `boolean` | \u003cbr /\u003e |"]]
