fuchsia.inspect

Added: 7

PROTOCOLS

InspectSink

Defined in fuchsia.inspect/inspect_sink.fidl

Added: 21

Publish

Publishes a handle to the fuchsia.inspect.Tree protocol that the server can use to read Inspect data, including lazy nodes.

Request

NameType
payload InspectSinkPublishRequest

Tree

Defined in fuchsia.inspect/tree.fidl

The Tree protocol represents a hierarchy of Inspect VMOs.

Link values stored in an Inspect file contain references to new named files that contain a continuation of the data for the overall hierarchy. Protocol Tree allows clients to request these named files so long as the hosting component is still alive.

Connecting to a particular tree keeps the content for that Tree resident in memory. Clients are recommended to traverse the trees in depth-first order to reduce memory usage. Serving components are free to deny connections to avoid unbounded memory usage.

GetContent

Get the content for the Inspect VMO backing this tree.

So long as the Tree connection is still maintained, the contents of the tree are guaranteed to still be live. Once the connection is lost, the serving component is free to clear the contents of returned shared buffers.

Serving components may return different buffers to GetContent requests for the same Tree.

Request

<EMPTY>

Response

NameType
content TreeContent

ListChildNames

Iterate over the names of Trees that are children of this Tree.

The underlying list of children may change in between calls to ListChildNames and OpenChild.

Request

NameType
tree_iterator server_end<TreeNameIterator>

OpenChild

Open a child Tree by name.

If the child cannot be opened, the given request is closed.

Request

NameType
child_name TreeName
tree server_end<Tree>

TreeNameIterator

Defined in fuchsia.inspect/tree.fidl

Iterator protocol for listing the names of children of a particular Tree.

GetNext

Get the next batch of names.

Returns an empty vector and closes the channel when no more names are present. Implementors may eagerly close the channel after sending the last batch.

Request

<EMPTY>

Response

NameType
name vector<string>

TABLES

InspectSinkPublishRequest resource

Defined in fuchsia.inspect/inspect_sink.fidl

OrdinalFieldTypeDescription
tree Tree
name string[4096]

TreeContent resource

Defined in fuchsia.inspect/tree.fidl

The content of a specific Inspect Tree.

OrdinalFieldTypeDescription
buffer fuchsia.mem/Buffer

Buffer containing the bytes of a tree in Inspect format.

CONSTANTS

NameValueTypeDescription
MAX_NAME_LENGTH 4096 uint64
Added: 16
MAX_TREE_NAME_LENGTH 2040 uint64

Maximum length of an Inspect Tree, specified by the format.

ALIASES

NameValueDescription
TreeName string[MAX_TREE_NAME_LENGTH]