Struct DebugAgentProxy

pub struct DebugAgentProxy { /* private fields */ }

Implementations

impl DebugAgentProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.debugger/DebugAgent.

pub fn take_event_stream(&self) -> DebugAgentEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn connect( &self, socket: Socket, ) -> QueryResponseFut<DebugAgentConnectResult, DefaultFuchsiaResourceDialect>

Hand the DebugAgent a socket that connects it to the debugger. This will return ZX_ERR_ALREADY_BOUND if a connection already exists. When the socket is closed, the DebugAgent will exit.

pub fn get_attached_processes( &self, iterator: ServerEnd<AttachedProcessIteratorMarker>, ) -> Result<(), Error>

Iterator over all processes that this agent is attached to. Note this is not the same as the set of installed filters, but rather the set of filters that matched and were later successfully attached.

pub fn attach_to( &self, pattern: &str, type_: FilterType, options: &FilterOptions, ) -> QueryResponseFut<DebugAgentAttachToResult, DefaultFuchsiaResourceDialect>

Use the given filter to attach to any existing or subsequently created components. This method will return the number of matches that were present at the time of calling this method. All attached processes will be detached when this agent is destroyed.

|filter| will be inspected for validity, with corresponding errors returned. If the filter is invalid, no attaches will occur and the filter will not be installed.

|num_matches| will contain the number of matches that were found immediately upon filter installation if there was no error, that is, the number of processes immediately within (or recursively in this realm, if the option is specified) this component’s corresponding job. Note that filters may be installed before any components are actually resolved and matched, so this number may be 0. This return value may be safely ignored.

Invalid filters will return an error, see Filter above for details on how to construct a filter.

pub fn get_process_info( &self, options: &GetProcessInfoOptions, iterator: ServerEnd<ProcessInfoIteratorMarker>, ) -> QueryResponseFut<DebugAgentGetProcessInfoResult, DefaultFuchsiaResourceDialect>

The given server_end of the iterator will iterate over all threads, of all attached processes. The options parameter may be passed to filter the already attached processes and to express interest in what should be yielded by the iterator. Including a filter is recommended if DebugAgent is attached to a large number of processes. Note that this filter will not cause any new processes to be attached and will not be saved after this method returns. It is purely to reduce the bounds of the iterator. The threads will be suspended for the duration of information capture, which could be interrupted by other system processes, see |ProcessInfoIterator| for an example.

pub fn get_minidumps( &self, options: &MinidumpOptions, iterator: ServerEnd<MinidumpIteratorMarker>, ) -> QueryResponseFut<DebugAgentGetMinidumpsResult, DefaultFuchsiaResourceDialect>

Collect minidumps for all attached processes. |options| may contain a filter to reduce the number of minidumps that are yielded by the iterator.

Trait Implementations

impl Clone for DebugAgentProxy

fn clone(&self) -> DebugAgentProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DebugAgentProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DebugAgentProxyInterface for DebugAgentProxy

type ConnectResponseFut = QueryResponseFut<Result<(), i32>>

type AttachToResponseFut = QueryResponseFut<Result<u32, FilterError>>

type GetProcessInfoResponseFut = QueryResponseFut<Result<(), FilterError>>

type GetMinidumpsResponseFut = QueryResponseFut<Result<(), FilterError>>

fn connect(&self, socket: Socket) -> Self::ConnectResponseFut

fn get_attached_processes( &self, iterator: ServerEnd<AttachedProcessIteratorMarker>, ) -> Result<(), Error>

fn attach_to( &self, pattern: &str, type_: FilterType, options: &FilterOptions, ) -> Self::AttachToResponseFut

fn get_process_info( &self, options: &GetProcessInfoOptions, iterator: ServerEnd<ProcessInfoIteratorMarker>, ) -> Self::GetProcessInfoResponseFut

fn get_minidumps( &self, options: &MinidumpOptions, iterator: ServerEnd<MinidumpIteratorMarker>, ) -> Self::GetMinidumpsResponseFut

impl Proxy for DebugAgentProxy

type Protocol = DebugAgentMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.