vm_service library

Classes

AllocationProfile
BoundField
A BoundField represents a field bound to a particular value in an Instance.
BoundVariable
A BoundVariable represents a local variable bound to a particular value in a Frame.
Breakpoint
A Breakpoint describes a debugger breakpoint.
Class
A Class provides information about a Dart language class.
ClassHeapStats
ClassList
ClassRef
ClassRef is a reference to a Class.
Code
A Code object represents compiled code in the Dart VM.
CodeKind
CodeRef
CodeRef is a reference to a Code object.
Context
A Context is a data structure which holds the captured variables for some closure.
ContextElement
ContextRef
CpuSample
See VmService.getCpuSamples and CpuSamples.
CpuSamples
See VmService.getCpuSamples and CpuSample.
CpuSamplesEvent
Error
An Error represents a Dart language level error. This is distinct from an RPCError.
ErrorKind
ErrorRef
ErrorRef is a reference to an Error.
Event
An Event is an asynchronous notification from the VM. It is delivered only when the client has subscribed to an event stream using the streamListen RPC.
EventKind
Adding new values to EventKind is considered a backwards compatible change. Clients should ignore unrecognized events.
EventStreams
An enum of available event streams.
ExceptionPauseMode
An ExceptionPauseMode indicates how the isolate pauses when an exception is thrown.
ExtensionData
An ExtensionData is an arbitrary map that can have any contents.
Field
A Field provides information about a Dart language field or variable.
FieldRef
An FieldRef is a reference to a Field.
Flag
A Flag represents a single VM command line flag.
FlagList
A FlagList represents the complete set of VM command line flags.
Frame
FrameKind
A FrameKind is used to distinguish different kinds of Frame objects.
Func
A Func represents a Dart language function.
FuncRef
An FuncRef is a reference to a Func.
HeapSnapshotClass
A representation of a class type captured in a memory snapshot.
HeapSnapshotExternalProperty
A representation of an external property captured in a memory snapshot.
HeapSnapshotField
A representation of a field captured in a memory snapshot.
HeapSnapshotGraph
A graph representation of a heap snapshot.
HeapSnapshotObject
A representation of an object instance captured in a memory snapshot.
HeapSnapshotObjectLengthData
Represents the length of an object.
HeapSnapshotObjectNoData
Represents that no data is associated with an object.
HeapSnapshotObjectNullData
Represents that the data associated with an object is null.
HttpProfile
A collection of HTTP request data collected by the profiler.
HttpProfileProxyData
Describes proxy authentication details associated with an HttpProfileRequest.
HttpProfileRequest
Profiling information for a single HTTP request, including request and response body data.
HttpProfileRequestData
Information sent as part of the initial HTTP request.
HttpProfileRequestEvent
Describes an event related to an HTTP request.
HttpProfileRequestRef
Profiling information for a single HTTP request.
HttpProfileResponseData
Information received in response to an initial HTTP request.
HttpTimelineLoggingState
An HttpTimelineLoggingState provides information about the current state of HTTP request logging for a given isolate.
InboundReference
See VmService.getInboundReferences.
InboundReferences
See VmService.getInboundReferences.
Instance
An Instance represents an instance of the Dart language class Obj.
InstanceKind
Adding new values to InstanceKind is considered a backwards compatible change. Clients should treat unrecognized instance kinds as PlainInstance.
InstanceRef
InstanceRef is a reference to an Instance.
InstanceSet
See VmService.getInstances.
Isolate
An Isolate object provides information about one isolate in the VM.
IsolateFlag
Represents the value of a single isolate flag. See Isolate.
IsolateGroup
An IsolateGroup object provides information about an isolate group in the VM.
IsolateGroupRef
IsolateGroupRef is a reference to an IsolateGroup object.
IsolateRef
IsolateRef is a reference to an Isolate object.
Library
A Library provides information about a Dart language library.
LibraryDependency
A LibraryDependency provides information about an import or export.
LibraryRef
LibraryRef is a reference to a Library.
Log
A logging handler you can pass to a VmService instance in order to get notifications of non-fatal service protocol warnings and errors.
LogRecord
MapAssociation
MemoryUsage
A MemoryUsage object provides heap usage information for a specific isolate at a given point in time.
Message
A Message provides information about a pending isolate message and the function that will be invoked to handle it.
NativeFunction
A NativeFunction object is used to represent native functions in profiler samples. See CpuSamples;
NullVal
A NullVal object represents the Dart language value null.
NullValRef
NullValRef is a reference to an a NullVal.
Obj
An Obj is a persistent object that is owned by some isolate.
ObjRef
ObjRef is a reference to a Obj.
OpenFile
Contains information about reads and writes to a currently opened file.
OpenFileList
OpenFileRef
An OpenFileRef contains identifying information about a currently opened file.
Parameter
A Parameter is a representation of a function parameter.
PerfettoCpuSamples
See VmService.getPerfettoCpuSamples.
PerfettoTimeline
See VmService.getPerfettoVMTimeline;
PortList
A PortList contains a list of ports associated with some isolate.
ProcessMemoryItem
ProcessMemoryUsage
See VmService.getProcessMemoryUsage.
ProfileFunction
A ProfileFunction contains profiling information about a Dart or native function.
Protocol
See VmService.getSupportedProtocols.
ProtocolList
A ProtocolList contains a list of all protocols supported by the service instance.
ReloadReport
Response
Every non-error response returned by the Service Protocol extends Response. By using the type property, the client can determine which type of response has been provided.
RetainingObject
See RetainingPath.
RetainingPath
See VmService.getRetainingPath.
Script
A Script provides information about a Dart language script.
ScriptList
ScriptRef
ScriptRef is a reference to a Script.
Sentinel
A Sentinel is used to indicate that the normal response is not available.
SentinelKind
A SentinelKind is used to distinguish different kinds of Sentinel objects.
SocketProfile
A SocketProfile provides information about statistics of sockets.
SocketProfilingState
A SocketProfilingState provides information about the current state of socket profiling for a given isolate.
SocketStatistic
SourceLocation
The SourceLocation class is used to designate a position or range in some script.
SourceReport
The SourceReport class represents a set of reports tied to source locations in an isolate.
SourceReportCoverage
The SourceReportCoverage class represents coverage information for one SourceReportRange.
SourceReportKind
SourceReportRange
The SourceReportRange class represents a range of executable code (function, method, constructor, etc) in the running program. It is part of a SourceReport.
SpawnedProcess
A SpawnedProcess contains startup information of a spawned process.
SpawnedProcessList
SpawnedProcessRef
A SpawnedProcessRef contains identifying information about a spawned process.
Stack
The Stack class represents the various components of a Dart stack trace for a given isolate.
StepOption
A StepOption indicates which form of stepping is requested in a resume RPC.
Success
The Success type is used to indicate that an operation completed successfully.
Timeline
See VmService.getVMTimeline;
TimelineEvent
An TimelineEvent is an arbitrary map that contains a Trace Event Format event.
TimelineFlags
Timestamp
TypeArguments
A TypeArguments object represents the type argument vector for some instantiated generic type.
TypeArgumentsRef
TypeArgumentsRef is a reference to a TypeArguments object.
TypeParameters
A TypeParameters object represents the type argument vector for some uninstantiated generic type.
TypeParametersRef
TypeParametersRef is a reference to a TypeParameters object.
UnresolvedSourceLocation
The UnresolvedSourceLocation class is used to refer to an unresolved breakpoint location. As such, it is meant to approximate the final location of the breakpoint but it is not exact.
UriList
Version
See Versioning.
VM
VMRef
VMRef is a reference to a VM object.
VmService

Enums

RPCErrorKind

Extensions

DartIOExtension on VmService

Constants

optional → const String
@optional
vmServiceVersion → const String

Functions

createServiceObject(dynamic json, List<String> expectedTypes) → Object?
decodeBase64(String str) → String
Decode a string in Base64 encoding into the equivalent non-encoded string. This is useful for handling the results of the Stdout or Stderr events.

Typedefs

DisposeHandler = Future Function()
ServiceCallback = Future<Map<String, dynamic>> Function(Map<String, dynamic> params)
VmServiceFactory<T extends VmService> = T Function({DisposeHandler? disposeHandler, required Stream inStream, Log? log, Future? streamClosed, required void writeMessage(String message), String? wsUri})

Exceptions / Errors

HttpProfileRequestError
An Error thrown when attempting to inspect fields in a HttpProfileRequestData instance when hasError is true.
RPCError
SentinelException
Thrown when an RPC response is a Sentinel.