Struct RollingPacketCaptureProxy 

pub struct RollingPacketCaptureProxy { /* private fields */ }

Implementations

impl RollingPacketCaptureProxy

pub fn new(channel: Channel) -> Self

Create a new Proxy for fuchsia.net.debug/RollingPacketCapture.

pub fn take_event_stream(&self) -> RollingPacketCaptureEventStream

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

Panics

Panics if the event stream was already taken.

pub fn detach( &self, name: &str, ) -> QueryResponseFut<RollingPacketCaptureDetachResult, FDomainResourceDialect>

Detaches the lifetime of this protocol from the underlying packet capture.

After calling Detach, closing the client end no longer results in the packet capture from being terminated. The passed string names this packet capture and can be used thereafter to reconnect via [PacketCaptureProvider.ReconnectRolling]. The protocol is still detached after reconnecting. This gives the client the option of ensuring the packet capture is resilient against disconnections.

Only the first call to Detach over the lifetime of the packet capture (note this is different from the lifetime of this protocol since it’s possible to disconnect and reconnect) is valid. Subsequent calls cannot change the name of this capture.

Once this method returns, it is guaranteed that this rolling packet capture is detached.

pub fn stop_and_download( &self, channel: ServerEnd<FileMarker>, ) -> Result<(), Error>

Stop and make this rolling packet capture downloadable.

It is implicit by calling this method that the packet capture is stopped due to user request, so the [RollingPacketCapture.OnEnded] event is not emitted.

This method can be called multiple times, including across disconnects: a client can call this method, disconnect, reconnect, and call this method again.

The server discards the contents of the packet capture once this method has been called and there is no client connected to this protocol for some time.

pub fn discard(&self) -> QueryResponseFut<(), FDomainResourceDialect>

Discard this rolling packet capture.

Clients should call this method when they have successfully downloaded the packet capture, or if they no longer need it for any reason.

The server closes all readers initialized via [StopAndDownload] and all future interactions on this protocol are invalid. When this method returns, it is guaranteed that the packet capture has been discarded and the usage quota has been released.

Trait Implementations

impl Clone for RollingPacketCaptureProxy

fn clone(&self) -> RollingPacketCaptureProxy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RollingPacketCaptureProxy

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

Formats the value using the given formatter.

impl Proxy for RollingPacketCaptureProxy

type Protocol = RollingPacketCaptureMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

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

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

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 domain(&self) -> Arc<Client>

Get the client supporting this proxy. We call this a “domain” here because:

fn on_closed(&self) -> OnFDomainSignals

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

impl RollingPacketCaptureProxyInterface for RollingPacketCaptureProxy

type DetachResponseFut = QueryResponseFut<Result<(), RollingPacketCaptureDetachError>, FDomainResourceDialect>

type DiscardResponseFut = QueryResponseFut<(), FDomainResourceDialect>

fn detach(&self, name: &str) -> Self::DetachResponseFut

fn stop_and_download(&self, channel: ServerEnd<FileMarker>) -> Result<(), Error>

fn discard(&self) -> Self::DiscardResponseFut