ClientData (Android Tools ddmlib)

java.lang.Object
- com.android.ddmlib.ClientData

public class ClientData
extends java.lang.Object

Contains the data of a Client.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ClientData.AllocationTrackingStatus`
`static class`	`ClientData.DebuggerStatus`
`static class`	`ClientData.HeapData` Heap Information.
`static class`	`ClientData.HeapInfo`
`static class`	`ClientData.HprofData`
`static interface`	`ClientData.IAllocationTrackingHandler`
`static interface`	`ClientData.IHprofDumpHandler` Deprecated.
`static interface`	`ClientData.IMethodProfilingHandler` Handlers able to act on Method profiling info
`static class`	`ClientData.MethodProfilingStatus`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FEATURE_HPROF` String for feature allowing to dump hprof files
`static java.lang.String`	`FEATURE_HPROF_STREAMING` String for feature allowing direct streaming of hprof dumps
`static java.lang.String`	`FEATURE_OPENGL_TRACING` String for feature indicating support for tracing OpenGL calls.
`static java.lang.String`	`FEATURE_PROFILING` String for feature enabling starting/stopping method profiling
`static java.lang.String`	`FEATURE_PROFILING_STREAMING` String for feature enabling direct streaming of method profiling data
`static java.lang.String`	`FEATURE_SAMPLING_PROFILER` String for feature enabling sampling profiler.
`static java.lang.String`	`FEATURE_VIEW_HIERARCHY` String for feature indicating support for providing view hierarchy.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clearHprofData()`
`java.lang.String`	`getAbi()` Returns the abi flavor (32-bit or 64-bit) of the application, null if unknown or not set.
`AllocationInfo[]`	`getAllocations()` Returns the list of tracked allocations.
`byte[]`	`getAllocationsData()` Returns the raw data for tracked allocations.
`ClientData.AllocationTrackingStatus`	`getAllocationStatus()` Returns the allocation tracking status.
`java.lang.String`	`getClientDescription()` Returns the client description.
`java.lang.String`	`getDataDir()` Returns the application's data directory.
`ClientData.DebuggerStatus`	`getDebuggerConnectionStatus()` Returns the debugger connection status.
`ClientData.HprofData`	`getHprofData()`
`java.lang.String`	`getJvmFlags()` Returns the VM flags in use, or null if unknown.
`java.util.List<NativeLibraryMapInfo>`	`getMappedNativeLibraries()` Returns the list of native libraries mapped in memory for this client.
`ClientData.MethodProfilingStatus`	`getMethodProfilingStatus()` Returns the method profiling status.
`java.util.List<NativeAllocationInfo>`	`getNativeAllocationList()` Returns the list of `NativeAllocationInfo`.
`java.lang.String`	`getPackageName()` Returns the application's package name.
`int`	`getPid()` Returns the process ID.
`ThreadInfo[]`	`getThreads()` Returns the list of threads as `ThreadInfo` objects.
`int`	`getTotalNativeMemory()` Returns the total native memory.
`int`	`getUserId()` Returns the client's user id.
`ClientData.HeapData`	`getVmHeapData()` Returns the `ClientData.HeapData` object for the VM.
`java.util.Iterator<java.lang.Integer>`	`getVmHeapIds()` Returns an iterator over the list of known VM heap ids.
`ClientData.HeapInfo`	`getVmHeapInfo(int heapId)` Returns the most-recent info values for the specified VM heap.
`java.lang.String`	`getVmIdentifier()` Returns the Client's VM identifier.
`boolean`	`hasFeature(java.lang.String feature)` Returns true if the `Client` supports the given `feature`
`boolean`	`hasPendingHprofDump()` Deprecated.
`boolean`	`isDdmAware()` Returns whether the process is DDM-aware.
`boolean`	`isNativeDebuggable()`
`boolean`	`isValidUserId()` Returns true if the user id of this client was set.
`static void`	`setAllocationTrackingHandler(ClientData.IAllocationTrackingHandler handler)` Deprecated.
`void`	`setHprofData(byte[] data)`
`void`	`setHprofData(java.lang.String filename)`
`static void`	`setHprofDumpHandler(ClientData.IHprofDumpHandler handler)` Deprecated.
`static void`	`setMethodProfilingHandler(ClientData.IMethodProfilingHandler handler)` Sets the handler to receive notifications when an HPROF dump succeeded or failed.
`void`	`setNativeDebuggable(boolean nativeDebuggable)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FEATURE_PROFILING
```
public static final java.lang.String FEATURE_PROFILING
```
    String for feature enabling starting/stopping method profiling
    
    See Also:
    
    hasFeature(String), Constant Field Values
  - FEATURE_PROFILING_STREAMING
```
public static final java.lang.String FEATURE_PROFILING_STREAMING
```
    String for feature enabling direct streaming of method profiling data
    
    See Also:
    
    hasFeature(String), Constant Field Values
  - FEATURE_SAMPLING_PROFILER
```
public static final java.lang.String FEATURE_SAMPLING_PROFILER
```
    String for feature enabling sampling profiler.
    
    See Also:
    
    hasFeature(String), Constant Field Values
  - FEATURE_OPENGL_TRACING
```
public static final java.lang.String FEATURE_OPENGL_TRACING
```
    String for feature indicating support for tracing OpenGL calls.
    
    See Also:
    
    hasFeature(String), Constant Field Values
  - FEATURE_VIEW_HIERARCHY
```
public static final java.lang.String FEATURE_VIEW_HIERARCHY
```
    String for feature indicating support for providing view hierarchy.
    
    See Also:
    
    hasFeature(String), Constant Field Values
  - FEATURE_HPROF
```
public static final java.lang.String FEATURE_HPROF
```
    String for feature allowing to dump hprof files
    
    See Also:
    
    hasFeature(String), Constant Field Values
  - FEATURE_HPROF_STREAMING
```
public static final java.lang.String FEATURE_HPROF_STREAMING
```
    String for feature allowing direct streaming of hprof dumps
    
    See Also:
    
    hasFeature(String), Constant Field Values
- Method Detail
  - setHprofData
```
public void setHprofData(byte[] data)
```
  - setHprofData
```
public void setHprofData(java.lang.String filename)
```
  - clearHprofData
```
public void clearHprofData()
```
  - getHprofData
```
public ClientData.HprofData getHprofData()
```
  - setHprofDumpHandler
```
@Deprecated
public static void setHprofDumpHandler(ClientData.IHprofDumpHandler handler)
```
    Deprecated.
    
    Sets the handler to receive notifications when an HPROF dump succeeded or failed. This method is deprecated, please register a client listener and listen for CHANGE_HPROF.
  - setMethodProfilingHandler
```
public static void setMethodProfilingHandler(ClientData.IMethodProfilingHandler handler)
```
    Sets the handler to receive notifications when an HPROF dump succeeded or failed. This method is deprecated, please register a client listener and listen for CHANGE_HPROF.
  - setAllocationTrackingHandler
```
@Deprecated
public static void setAllocationTrackingHandler(@NonNull
                                                            ClientData.IAllocationTrackingHandler handler)
```
    Deprecated.
    
    This method is deprecated. Please register an AndroidDebugBridge.IClientChangeListener with AndroidDebugBridge.addClientChangeListener(AndroidDebugBridge.IClientChangeListener)
  - isDdmAware
```
public boolean isDdmAware()
```
    Returns whether the process is DDM-aware.
  - getPid
```
public int getPid()
```
    Returns the process ID.
  - getVmIdentifier
```
public java.lang.String getVmIdentifier()
```
    Returns the Client's VM identifier.
  - getClientDescription
```
public java.lang.String getClientDescription()
```
    Returns the client description.
    This is generally the name of the package defined in the AndroidManifest.xml.
    
    Returns:
    
    the client description or null if not the description was not yet sent by the client.
  - getUserId
```
public int getUserId()
```
    Returns the client's user id.
    
    Returns:
    
    user id if set, -1 otherwise
  - isValidUserId
```
public boolean isValidUserId()
```
    Returns true if the user id of this client was set. Only devices that support multiple users will actually return the user id to ddms. For other/older devices, this will not be set.
  - getAbi
```
@Nullable
public java.lang.String getAbi()
```
    Returns the abi flavor (32-bit or 64-bit) of the application, null if unknown or not set.
  - getJvmFlags
```
public java.lang.String getJvmFlags()
```
    Returns the VM flags in use, or null if unknown.
  - isNativeDebuggable
```
public boolean isNativeDebuggable()
```
  - setNativeDebuggable
```
public void setNativeDebuggable(boolean nativeDebuggable)
```
  - getDebuggerConnectionStatus
```
public ClientData.DebuggerStatus getDebuggerConnectionStatus()
```
    Returns the debugger connection status.
  - getVmHeapData
```
public ClientData.HeapData getVmHeapData()
```
    Returns the ClientData.HeapData object for the VM.
  - getVmHeapIds
```
public java.util.Iterator<java.lang.Integer> getVmHeapIds()
```
    Returns an iterator over the list of known VM heap ids.
    The caller must synchronize on the ClientData object while iterating.
    
    Returns:
    
    an iterator over the list of heap ids
  - getVmHeapInfo
```
public ClientData.HeapInfo getVmHeapInfo(int heapId)
```
    Returns the most-recent info values for the specified VM heap.
    
    Parameters:
    
    heapId - The heap whose info should be returned
    
    Returns:
    
    a map containing the info values for the specified heap. Returns null if the heap ID is unknown.
  - getThreads
```
public ThreadInfo[] getThreads()
```
    Returns the list of threads as ThreadInfo objects.
    The list is empty until a thread update was requested with Client.requestThreadUpdate().
  - getNativeAllocationList
```
public java.util.List<NativeAllocationInfo> getNativeAllocationList()
```
    Returns the list of NativeAllocationInfo.
    
    See Also:
    
    Client.requestNativeHeapInformation()
  - getTotalNativeMemory
```
public int getTotalNativeMemory()
```
    Returns the total native memory.
    
    See Also:
    
    Client.requestNativeHeapInformation()
  - getMappedNativeLibraries
```
public java.util.List<NativeLibraryMapInfo> getMappedNativeLibraries()
```
    Returns the list of native libraries mapped in memory for this client.
  - getAllocationStatus
```
public ClientData.AllocationTrackingStatus getAllocationStatus()
```
    Returns the allocation tracking status.
    
    See Also:
    
    Client.requestAllocationStatus()
  - getAllocationsData
```
public byte[] getAllocationsData()
```
    Returns the raw data for tracked allocations.
    
    See Also:
    
    Client.requestAllocationDetails()
  - getAllocations
```
@Nullable
public AllocationInfo[] getAllocations()
```
    Returns the list of tracked allocations.
    
    See Also:
    
    Client.requestAllocationDetails()
  - hasFeature
```
public boolean hasFeature(java.lang.String feature)
```
    Returns true if the Client supports the given feature
    
    Parameters:
    
    feature - The feature to test.
    
    Returns:
    
    true if the feature is supported
    
    See Also:
    
    FEATURE_PROFILING, FEATURE_HPROF
  - hasPendingHprofDump
```
@Deprecated
public boolean hasPendingHprofDump()
```
    Deprecated.
  - getMethodProfilingStatus
```
public ClientData.MethodProfilingStatus getMethodProfilingStatus()
```
    Returns the method profiling status.
    
    See Also:
    
    Client.requestMethodProfilingStatus()
  - getPackageName
```
@NonNull
public java.lang.String getPackageName()
```
    Returns the application's package name.
  - getDataDir
```
@NonNull
public java.lang.String getDataDir()
```
    Returns the application's data directory.

Class ClientData

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FEATURE_PROFILING

FEATURE_PROFILING_STREAMING

FEATURE_SAMPLING_PROFILER

FEATURE_OPENGL_TRACING

FEATURE_VIEW_HIERARCHY

FEATURE_HPROF

FEATURE_HPROF_STREAMING

Method Detail

setHprofData

setHprofData

clearHprofData

getHprofData

setHprofDumpHandler

setMethodProfilingHandler

setAllocationTrackingHandler

isDdmAware

getPid

getVmIdentifier

getClientDescription

getUserId

isValidUserId

getAbi

getJvmFlags

isNativeDebuggable

setNativeDebuggable

getDebuggerConnectionStatus

getVmHeapData

getVmHeapIds

getVmHeapInfo

getThreads

getNativeAllocationList

getTotalNativeMemory

getMappedNativeLibraries

getAllocationStatus

getAllocationsData

getAllocations

hasFeature

hasPendingHprofDump

getMethodProfilingStatus

getPackageName

getDataDir