Struct ChannelControlSynchronousProxy

pub struct ChannelControlSynchronousProxy { /* private fields */ }

Implementations

impl ChannelControlSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ChannelControlEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn get_current( &self, ___deadline: MonotonicInstant, ) -> Result<String, Error>

Retrieve the currently active update channel.

• response channel the currently active update channel.

pub fn set_target( &self, channel: &str, ___deadline: MonotonicInstant, ) -> Result<(), Error>

Set a new desired target channel. This tells the updater to attempt to check for updates using a new channel. This is tentative, and won’t be persisted unless an update check on that channel is successful.

A response is generated when the new target channel has been verified as valid.

• request channel the new target channel name (name used by the updater)

pub fn get_target(&self, ___deadline: MonotonicInstant) -> Result<String, Error>

Get the current tentative target channel for updates. This returns the channel that the update client is using to perform update checks. It’s always one of:

• the current channel

• the default channel

• a new target that’s different, but hasn’t been OTA’d from yet.

• response channel the current target channel.

pub fn get_target_list( &self, ___deadline: MonotonicInstant, ) -> Result<Vec<String>, Error>

Get the list of well-known target channels that can be passed to SetTarget(). There may be other, unlisted channels.

Trait Implementations

impl Debug for ChannelControlSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for ChannelControlSynchronousProxy

type Proxy = ChannelControlProxy

The async proxy for the same protocol.

type Protocol = ChannelControlMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.